Struct egui_winit::State

impl State

pub fn new( egui_ctx: Context, viewport_id: ViewportId, display_target: &dyn HasRawDisplayHandle, native_pixels_per_point: Option<f32>, max_texture_side: Option<usize> ) -> Self

Construct a new instance

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 egui_ctx(&self) -> &Context

pub fn egui_input(&self) -> &RawInput

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

pub fn egui_input_mut(&mut self) -> &mut RawInput

The current input state. This is changed by Self::on_window_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.

You need to set egui::RawInput::viewports yourself though. Use update_viewport_info to update the info for each viewport.

pub fn on_window_event( &mut self, window: &Window, 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, 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

Auto Trait Implementations§

impl !UnwindSafe for State

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.