Struct egui_winit::State

pub struct State { /* private fields */ }

Handles the integration between egui and winit.

Implementations

impl State

pub fn new(display_target: &dyn HasRawDisplayHandle) -> Self

Construct a new instance

Safety

The returned State must not outlive the input display_target.

pub fn init_accesskit<T: From<ActionRequestEvent> + Send>( &mut self, window: &Window, event_loop_proxy: EventLoopProxy<T>, initial_tree_update_factory: impl 'static + FnOnce() -> TreeUpdate + Send )

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<'_> ) -> EventResponse

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.

pub fn on_accesskit_action_request(&mut self, request: ActionRequest)

Call this when there is a new [accesskit::ActionRequest].

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

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