Struct nannou_egui::Egui

pub struct Egui { /* fields omitted */ }

All egui-related state for a single window.

Includes the context, a renderer, and an input tracker.

For multi-window user interfaces, you will need to create an instance of this type per-window.

Implementations

impl Egui

pub fn new(
    device: &Device,
    target_format: TextureFormat,
    target_msaa_samples: u32,
    window_scale_factor: f32,
    window_size_pixels: [u32; 2]
) -> Self

Construct the Egui from its parts.

The given device must be the same used to create the queue to which the Egui’s render commands will be submitted.

The target_format, target_msaa_samples, window_scale_factor and window_size_pixels must match the window to which the UI will be drawn.

The context should have the desired initial styling and fonts already set.

pub fn from_window(window: &Window) -> Self

Construct a Egui associated with the given window.

pub fn ctx(&self) -> &CtxRef

Access to the inner egui::CtxRef.

pub fn input(&self) -> &Input

Access to the currently tracked input state.

pub fn handle_raw_event(&mut self, event: &WindowEvent<'_>)

Handles a raw window event, tracking all input and events relevant to the UI as necessary.

pub fn set_elapsed_time(&mut self, elapsed: Duration)

Set the elapsed time since the Egui app started running.

pub fn begin_frame(&mut self) -> FrameCtx<'_>

Begin describing a UI frame.

pub fn draw_to_frame(&self, frame: &Frame<'_>) -> Result<(), BackendError>

Draws the contents of the inner context to the given frame.

pub fn with_epi_frame<F>(&mut self, proxy: Proxy, f: F) where
    F: FnOnce(&CtxRef, &mut Frame<'_>), 

Provide access to an epi::Frame within the given function.

This method is primarily used for apps based on the epi interface.

pub fn do_frame_with_epi_frame<F>(&mut self, proxy: Proxy, f: F) -> Output where
    F: FnOnce(&CtxRef, &mut Frame<'_>), 

The same as with_epi_frame, but calls begin_frame before calling the given function, and then calls end_frame before returning.