[][src]Module nannou::ui

The User Interface API. Instantiate a Ui via app.new_ui().

Re-exports

pub use crate::conrod_core;
pub use crate::conrod_vulkano;
pub use crate::conrod_winit;

Modules

color

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

cursor

Contains an extendable enum of supported mouse cursor types.

event

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

graph

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

image

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

input

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

position

Items related to 2D positioning, used throughout conrod.

prelude

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

scroll

Scroll related types and logic.

text

Text layout logic.

theme

Types a functionality for handling Canvas and Widget theming.

utils

Various utility functions used throughout Conrod.

widget

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

Structs

Builder

A type used for building a new Ui.

Range

Some start and end position along a single axis.

Rect

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

Theme

A serializable collection of canvas and widget styling defaults.

Ui

A handle to the Ui for a specific window.

UiCell

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

Bordering

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

BuildError

Failed to build the Ui.

Color

Color supporting RGB and HSL variants.

DrawToFrameError

An error that might occur while drawing to a Frame.

Input

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.

RenderTargetCreationError

Failed to create the custom render target for the Ui.

Constants

DEPTH_FORMAT

The depth format used by the depth buffer in the default render target.

DEPTH_FORMAT_TY

The depth format type used by the depth buffer in the default render target.

Traits

Borderable

Widgets that may display a border.

Colorable

Types that can be colored.

Labelable

Widgets that may display some label.

Positionable

Widgets that are positionable.

Sizeable

Widgets that support different dimensions.

Widget

A trait to be implemented by all Widget types.

Functions

create_render_pass

Create a minimal, single-pass render pass with which the Ui may be rendered.

draw_primitives

A function shared by the draw_to_frame and draw_to_frame_if_changed methods for renderering the list of conrod primitives and presenting them to the frame.

winit_window_event_to_input

Convert the given window event to a UI Input.

Type Definitions

DepthFormat

The depth format type used by the depth buffer in the default render target.

Dimensions

General use 2D spatial dimensions.

FontSize

Font size used throughout Conrod.

ImageMap

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

Point

General use 2D spatial point.

Scalar

An alias over the Scalar type used throughout Conrod.

Subpass

The subpass type to which the Ui may be rendered.