Struct egui_winit_platform::Platform

pub struct Platform { /* fields omitted */ }

Provides the integration between egui and winit.

Implementations

impl Platform

pub fn new(descriptor: PlatformDescriptor) -> Self

Creates a new Platform.

pub fn handle_event<T>(&mut self, winit_event: &Event<'_, T>)

Handles the given winit event and updates the egui context. Should be called before starting a new frame with start_frame().

pub fn captures_event<T>(&self, winit_event: &Event<'_, T>) -> bool

Returns true if egui should handle the event exclusively. Check this to avoid unexpected interactions, e.g. a mouse click registering “behind” the UI.

pub fn update_time(&mut self, elapsed_seconds: f64)

Updates the internal time for egui used for animations. elapsed_seconds should be the seconds since some point in time (for example application start).

pub fn begin_frame(&mut self)

Starts a new frame by providing a new Ui instance to write into.

pub fn end_frame(&mut self) -> (Output, Vec<ClippedShape>)

Ends the frame. Returns what has happened as Output and gives you the draw instructions as PaintJobs.

pub fn context(&self) -> CtxRef

Returns the internal egui context.