Struct three_d::GUI

pub struct GUI { /* fields omitted */ }

Integration of egui, an immediate mode GUI.

Implementations

impl GUI

pub fn new(context: &Context) -> ThreeDResult<Self>

This is supported on crate feature egui-gui only.

Creates a new GUI.

pub fn update<F: FnOnce(&CtxRef)>(
    &mut self,
    frame_input: &mut FrameInput,
    callback: F
) -> ThreeDResult<bool>

This is supported on crate feature egui-gui only.

Initialises a new frame of the GUI and handles events. Construct the GUI (Add panels, widgets etc.) using the egui::CtxRef in the callback function. This function returns whether or not the GUI has changed, ie. if it consumes any events, and therefore needs to be rendered again.

pub fn render(&mut self) -> ThreeDResult<()>

This is supported on crate feature egui-gui only.

Render the GUI defined in the update function. Must be called in a render target render function, for example in the callback function of Screen::write.