pub struct RawInput {
pub screen_rect: Option<Rect>,
pub pixels_per_point: Option<f32>,
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>,
}
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.
Fields
screen_rect: Option<Rect>
Position and size of the area that egui should use. Usually you would set this to
Some(Rect::from_pos_size(Default::default(), screen_size))
.
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.
pixels_per_point: Option<f32>
Also known as device pixel ratio, > 1 for high resolution screens. If text looks blurry you probably forgot to set this. Set this the first frame, whenever it changes, or just on every frame.
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
.
Implementations
sourceimpl RawInput
impl RawInput
sourcepub fn take(&mut self) -> RawInput
pub fn take(&mut self) -> RawInput
Helper: move volatile (deltas and events), clone the rest.
Self::hovered_files
is cloned.Self::dropped_files
is moved.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for RawInput
impl<'de> Deserialize<'de> for RawInput
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl StructuralPartialEq for RawInput
Auto Trait Implementations
impl RefUnwindSafe for RawInput
impl Send for RawInput
impl Sync for RawInput
impl Unpin for RawInput
impl UnwindSafe for RawInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more