Struct carbide_core::Ui

pub struct Ui<S> where
    S: GlobalState,  {
    pub fonts: Map,
    pub win_w: f64,
    pub win_h: f64,
    pub widgets: Box<dyn Widget<S>>,
    pub environment: Environment<S>,
    // some fields omitted
}

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

Ui Handles the following:

• Contains the state of all widgets which can be indexed via their widget::Id.
• Stores rendering state for each widget until the end of each render cycle.
• Contains the theme used for default styling of the widgets.
• Maintains the latest user input state (for mouse and keyboard).
• Maintains the latest window dimensions.

Fields

fonts: Map

Manages all fonts that have been loaded by the user.

win_w: f64

Window width.

win_h: f64

Window height.

widgets: Box<dyn Widget<S>>

environment: Environment<S>

Implementations

impl<S: GlobalState> Ui<S>

pub fn handle_event(&mut self, event: Input, global_state: &mut S)

pub fn draw(&mut self) -> CPrimitives

Draw the Ui in it's current state.

NOTE: If you don't need to redraw your carbide GUI every frame, it is recommended to use the Ui::draw_if_changed method instead.

pub fn mouse_cursor(&self) -> MouseCursor

Get mouse cursor state.

Trait Implementations

impl<'a, S: GlobalState> AsRef<Ui<S>> for UiCell<'a, S>

fn as_ref(&self) -> &Ui<S>

Performs the conversion.

impl<S: Debug> Debug for Ui<S> where
    S: GlobalState, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.