[−][src]Struct nannou::ui::Ui

pub struct Ui {
    pub image_map: ImageMap,
    // some fields omitted
}

A handle to the Ui for a specific window.

Fields

image_map: ImageMap

Methods

`impl Ui`[src]

`pub const DEFAULT_PENDING_INPUT_LIMIT: usize`[src]

The default maximum number of Inputs that a Ui will store in its pending Input queue before Inputs start being ignored.

`pub fn generate_widget_id(&mut self) -> Id`[src]

Generate a new, unique widget::Id into a Placeholder node within the widget graph. This should only be called once for each unique widget needed to avoid unnecessary bloat within the Ui's internal widget graph.

When using this method, be sure to store the returned widget::Id somewhere so that it can be re-used on next update.

Panics if adding another node would exceed the maximum capacity for node indices.

`pub fn widget_id_generator(&mut self) -> Generator`[src]

Produces the type that may be used to generate new unique widget::Ids.

`pub fn handle_input(&mut self, input: Input)`[src]

Handle a raw UI input event and update the Ui state accordingly.

This method drives the Ui forward and interprets input into higher-level events (like clicks and drags) for widgets.

Note: By default, this will be called automatically by the nannou App, so most of the time you should not need to call this (otherwise received inputs may double up). This method is particularly useful in the case that automatic input handling has been disabled, as this can be used to manually submit inputs.

`pub fn handle_pending_input(&mut self)`[src]

Processes all pending input.

This is automatically called at the beginning of the set_widgets method, so the user should never need to call this manually, however the method is exposed for flexibility just in case.

This has no effect if automatic input handling is disabled.

`pub fn set_widgets(&mut self) -> UiCell`[src]

Returns a context upon which UI widgets can be instantiated.

The UiCell simply acts as a wrapper around the Ui for the period over which widgets are instantiated. Once the UiCell is dropped, it does some cleanup and sorting that is required after widget instantiation.

`pub fn fonts_mut(&mut self) -> &mut Map`[src]

Mutable access to the Ui's font map.

This allows for adding and removing fonts to the UI.

`pub fn theme_mut(&mut self) -> &mut Theme`[src]

Mutable access to the Ui's Theme.

This allows for making changes to the active theme.

`pub fn clear_with(&mut self, color: Color)`[src]

The first of the Primitives yielded by Ui::draw will always be a Rectangle the size of the window in which the Ui is instantiated.

This method sets the colour with which this Rectangle is drawn (the default being color::TRANSPARENT).

`pub fn draw_to_frame( &self, app: &App, frame: &Frame ) -> Result<(), DrawToFrameError>`[src]

Draws the current state of the Ui to the given Frame.

The Ui will automatically draw to its associated window within the given Frame.

If you require more control over where the Ui is drawn within the Frame, the draw method offers more flexibility.

This has no effect if the window originally associated with the Ui no longer exists.

`pub fn draw_to_frame_if_changed( &self, app: &App, frame: &Frame ) -> Result<bool, DrawToFrameError>`[src]

Draws the current state of the Ui to the given Frame but only if the Ui has changed since last time either draw_to_frame or draw_to_frame_if_changed was called.

The Ui will automatically draw to its associated window within the given Frame.

If you require more control over where the Ui is drawn within the Frame, the draw method offers more flexibility.

This has no effect if the window originally associated with the Ui no longer exists.

Returns true if the call resulted in re-drawing the Ui due to changes.

Methods from Deref<Target = Ui>