Struct nannou_egui::Egui

pub struct Egui { /* private fields */ }

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) -> &Context

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 end_frame(&mut self) -> PlatformOutput

pub fn texture_from_wgpu_texture( &mut self, device: &Device, texture: &Texture, texture_filter: FilterMode ) -> TextureId

Registers a wgpu::Texture with a egui::TextureId.

pub fn update_texture_from_wgpu_texture( &mut self, device: &Device, texture: &Texture, texture_filter: FilterMode, id: TextureId ) -> Result<(), WgpuError>

Registers a wgpu::Texture with an existing egui::TextureId.

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

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