Struct egui_winit::State

pub struct State { /* private fields */ }

Handles the integration between egui and winit.

Implementations

impl State

pub fn new<T>(event_loop: &EventLoopWindowTarget<T>) -> Self

pub fn new_with_wayland_display(wayland_display: Option<*mut c_void>) -> Self

pub fn set_max_texture_side(&mut self, max_texture_side: usize)

Call this once a graphics context has been created to update the maximum texture dimensions that egui will use.

pub fn set_pixels_per_point(&mut self, pixels_per_point: f32)

Call this when a new native Window is created for rendering to initialize the pixels_per_point for that window.

In particular, on Android it is necessary to call this after each Resumed lifecycle event, each time a new native window is created.

Once this has been initialized for a new window then this state will be maintained by handling winit::event::WindowEvent::ScaleFactorChanged events.

pub fn pixels_per_point(&self) -> f32

The number of physical pixels per logical point, as configured on the current egui context (see egui::Context::pixels_per_point).

pub fn egui_input(&self) -> &RawInput

The current input state. This is changed by Self::on_event and cleared by Self::take_egui_input.

pub fn take_egui_input(&mut self, window: &Window) -> RawInput

Prepare for a new frame by extracting the accumulated input, as well as setting the time and screen rectangle.

pub fn on_event(&mut self, egui_ctx: &Context, event: &WindowEvent<'_>) -> bool

Call this when there is a new event.

The result can be found in Self::egui_input and be extracted with Self::take_egui_input.

Returns true if egui wants exclusive use of this event (e.g. a mouse click on an egui window, or entering text into a text field). For instance, if you use egui for a game, you want to first call this and only when this returns false pass on the events to your game.

Note that egui uses tab to move focus between elements, so this will always return true for tabs.

pub fn handle_platform_output(
    &mut self,
    window: &Window,
    egui_ctx: &Context,
    platform_output: PlatformOutput
)

Call with the output given by egui.

This will, if needed:

• update the cursor
• copy text to the clipboard
• open any clicked urls
• update the IME