Struct three_d::GUI

pub struct GUI { /* private fields */ }

Available on crate feature egui-gui only.

Integration of egui, an immediate mode GUI.

Implementations

impl GUI

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

Creates a new GUI from a mid-level Context.

pub fn from_gl_context(context: Arc<Context>) -> Self

Creates a new GUI from a low-level graphics Context.

pub fn update( &mut self, events: &mut [Event], accumulated_time_in_ms: f64, viewport: Viewport, device_pixel_ratio: f32, callback: impl FnOnce(&Context) ) -> bool

Initialises a new frame of the GUI and handles events. Construct the GUI (Add panels, widgets etc.) using the egui::Context 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(&self)

Render the GUI defined in the update function. Must be called in the callback given as input to a RenderTarget, ColorTarget or DepthTarget write method.