Struct egui::data::input::RawInput

source ·
pub struct RawInput {
    pub viewport_id: ViewportId,
    pub viewports: ViewportIdMap<ViewportInfo>,
    pub screen_rect: Option<Rect>,
    pub max_texture_side: Option<usize>,
    pub time: Option<f64>,
    pub predicted_dt: f32,
    pub modifiers: Modifiers,
    pub events: Vec<Event>,
    pub hovered_files: Vec<HoveredFile>,
    pub dropped_files: Vec<DroppedFile>,
    pub focused: bool,
Expand description

What the integrations provides to egui at the start of each frame.

Set the values that make sense, leave the rest at their Default::default().

You can check if egui is using the inputs using crate::Context::wants_pointer_input and crate::Context::wants_keyboard_input.

All coordinates are in points (logical pixels) with origin (0, 0) in the top left .corner.

Ii “points” can be calculated from native physical pixels using pixels_per_point = crate::Context::zoom_factor * native_pixels_per_point;


§viewport_id: ViewportId

The id of the active viewport.

§viewports: ViewportIdMap<ViewportInfo>

Information about all egui viewports.

§screen_rect: Option<Rect>

Position and size of the area that egui should use, in points. Usually you would set this to

Some(Rect::from_min_size(Default::default(), screen_size_in_points)).

but you could also constrain egui to some smaller portion of your window if you like.

None will be treated as “same as last frame”, with the default being a very big area.

§max_texture_side: Option<usize>

Maximum size of one side of the font texture.

Ask your graphics drivers about this. This corresponds to GL_MAX_TEXTURE_SIZE.

The default is a very small (but very portable) 2048.

§time: Option<f64>

Monotonically increasing time, in seconds. Relative to whatever. Used for animations. If None is provided, egui will assume a time delta of predicted_dt (default 1/60 seconds).

§predicted_dt: f32

Should be set to the expected time between frames when painting at vsync speeds. The default for this is 1/60. Can safely be left at its default value.

§modifiers: Modifiers

Which modifier keys are down at the start of the frame?

§events: Vec<Event>

In-order events received this frame.

There is currently no way to know if egui handles a particular event, but you can check if egui is using the keyboard with crate::Context::wants_keyboard_input and/or the pointer (mouse/touch) with crate::Context::is_using_pointer.

§hovered_files: Vec<HoveredFile>

Dragged files hovering over egui.

§dropped_files: Vec<DroppedFile>

Dragged files dropped into egui.

Note: when using eframe on Windows you need to enable drag-and-drop support using eframe::NativeOptions.

§focused: bool

The native window has the keyboard focus (i.e. is receiving key presses).

False when the user alt-tab away from the application, for instance.



impl RawInput


pub fn viewport(&self) -> &ViewportInfo

Info about the active viewport


pub fn take(&mut self) -> Self

Helper: move volatile (deltas and events), clone the rest.


pub fn append(&mut self, newer: Self)

Add on new input.


impl RawInput


pub fn ui(&self, ui: &mut Ui)

Trait Implementations§


impl Clone for RawInput


fn clone(&self) -> RawInput

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for RawInput


fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for RawInput


fn default() -> Self

Returns the “default value” for a type. Read more

impl PartialEq for RawInput


fn eq(&self, other: &RawInput) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RawInput

Auto Trait Implementations§

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> From<T> for T


fn from(t: T) -> T

Returns the argument unchanged.


impl<T, U> Into<U> for T
where U: From<T>,


fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.


impl<T> ToOwned for T
where T: Clone,


type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,


type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,


type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,