[][src]Crate conrod

Conrod

An easy-to-use, immediate-mode, 2D GUI library featuring a range of useful widgets.

If you are new to Conrod, we recommend checking out The Guide.

Re-exports

pub extern crate glium;
pub extern crate gfx;
pub extern crate gfx_core;
pub use color::Color;
pub use color::Colorable;
pub use position::Dimensions;
pub use position::Point;
pub use position::Position;
pub use position::Positionable;
pub use position::Range;
pub use position::Rect;
pub use position::Scalar;
pub use position::Sizeable;
pub use theme::Theme;
pub use widget::scroll;
pub use widget::Widget;

Modules

backend

Feature-gated, backend-specific functionality.

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.

guide

The Conrod Guide

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.

render

Conrod's generic graphics backend.

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.

Macros

builder_method

A macro for simplifying implementation of methods for the builder pattern.

builder_methods

A macro to simplify implementation of "builder-pattern" methods.

widget_ids

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

Ui

Ui is the most important type within Conrod and is necessary for rendering and maintaining widget state.

UiBuilder

A constructor type for building a Ui instance with a set of optional parameters.

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.

Traits

Borderable

Widgets that may display a border.

Labelable

Widgets that may display some label.

Type Definitions

FontSize

Font size used throughout Conrod.