Crate gooey[][src]

Expand description

A graphical user interface library. This crate exposes all of the built-in functionality of Gooey, as well as types for building apps.

Feature Flags

This crate has several feature flags to control what features are enabled. The default feature flags are ["frontend-kludgine", "frontend-browser", "fluent"].

  • frontend-browser: Enables the frontends::browser module, which is gooey-browser re-exported.
  • frontend-kludgine: Enables the frontends::rasterizer module and the frontends::renderers::kludgine module. These are re-exports of gooey-rasterizer and gooey-kludgine respectively.
  • async: Enables the App::spawn() function.
  • fluent: Enables using fluent for localization.

Top-level exports

The ActiveFrontend, main(), and main_with() function will change types based on the feature flags enabled as well as the target platform. Here is a reference to understand what symbols to expect:

target_arch = "wasm32"frontend-kludginefrontend-browserActiveFrontend/main()
falsefalsefalse
falsefalsetrue
falsetruefalseRasterizer<Kludgine>/kludgine_main
falsetruetrueRasterizer<Kludgine>/kludgine_main
truefalsetrueWebSys/browser_main
truetruetrueWebSys/browser_main

Modules

Core traits and types used to create Graphical User Interfaces (GUIs - gooeys).

Localization support for Gooey using Project Fluent.

Available Frontends.

Cross-platform rendering types.

Styles for applications.

Text rendering and wrapping.

Built-in widgets for user interfaces.

Structs

A cross-platform application.

A headless application.

An easy-to-use,offscreen animation recorder.

Enums

Errors that can occur while using Headless.

Functions

Returns an initialized frontend using the root widget returned from initializer.

Returns an initialized frontend using the root widget returned from initializer.

Runs a browser-based App with the root widget from initializer. All widgets from gooey::widget will be usable. If you wish to use other widgets, use browser_main_with and provide the transmogrifiers for the widgets you wish to use.

Runs a browser-based App with transmogrifiers and the root widget from initializer. Unless overriden by transmogrifier, all widgets from gooey::widget will use the built-in transmogrifiers.

Runs an initialized frontend.

Returns an initialized frontend using the root widget returned from initializer.

Runs a Kludgine-based App with the root widget from initializer. All widgets from gooey::widget will be usable. If you wish to use other widgets, use browser_main_with and provide the transmogrifiers for the widgets you wish to use.

Runs a Kludgine-based App with transmogrifiers and the root widget from initializer. Unless overriden by transmogrifier, all widgets from gooey::widget will use the built-in transmogrifiers.

Runs an initialized frontend.

Runs a Kludgine-based App with the root widget from initializer. All widgets from gooey::widget will be usable. If you wish to use other widgets, use browser_main_with and provide the transmogrifiers for the widgets you wish to use.

Runs a Kludgine-based App with transmogrifiers and the root widget from initializer. Unless overriden by transmogrifier, all widgets from gooey::widget will use the built-in transmogrifiers.

Runs an initialized frontend.

Type Definitions

The active frontend.