Module nannou::ui[][src]

Expand description

The User Interface API.

Instantiate a Ui via app.new_ui().

Re-exports

pub use crate::conrod_core;
pub use crate::conrod_wgpu;
pub use crate::conrod_winit;

Modules

A library providing simple Color and Gradient types along with useful transformations and presets.

Contains an extendable enum of supported mouse cursor types.

Contains all types used to describe the input events that Widgets may handle.

Conrod uses a directed acyclic graph to manage both storing widgets and describing their relationships.

A type used to manage a user’s image data and map them to Image widgets:

This module contains all the logic for handling input events and providing them to widgets.

Items related to 2D positioning, used throughout conrod.

Simplify inclusion of common traits with a nannou::ui::prelude module.

Scroll related types and logic.

Text layout logic.

Types a functionality for handling Canvas and Widget theming.

Various utility functions used throughout Conrod.

Widgets are the core building blocks for every conrod user interface.

Macros

A macro used to generate a struct with a field for each unique identifier given. Each field can then be used to generate unique widget::Ids.

Structs

A type used for building a new Ui.

Some start and end position along a single axis.

Defines a Rectangle’s bounds across the x and y axes.

A serializable collection of canvas and widget styling defaults.

A handle to the Ui for a specific window.

A wrapper around the Ui that restricts the user from mutating the Ui in certain ways while in the scope of the Ui::set_widgets function and within Widgets’ update methods. Using the UiCell, users may access the Ui immutably (via Deref) however they wish, however they may only mutate the Ui via the &mut self methods provided by the UiCell.

Enums

To be used as a parameter for defining the aesthetic of the widget border.

Failed to build the Ui.

Color supporting RGB and HSL variants.

An error that might occur while drawing to a Frame.

The event type that is used by conrod to track inputs from the world. Events yielded by polling window backends should be converted to this type. This can be thought of as the event type which is supplied by the window backend to drive the state of the Ui forward.

Traits

Widgets that may display a border.

Types that can be colored.

Widgets that may display some label.

Widgets that are positionable.

Widgets that support different dimensions.

A trait to be implemented by all Widget types.

Functions

Encode commands for drawing the given primitives.

Convert the given window event to a UI Input.

Type Definitions

General use 2D spatial dimensions.

Font size used throughout Conrod.

A map from image::Ids to their associated Texture2d.

General use 2D spatial point.

An alias over the Scalar type used throughout Conrod.