Skip to main content

InputEvent

Enum InputEvent 

Source
pub enum InputEvent {
    Key {
        key: PhysicalKeyCode,
        state: ButtonState,
    },
    PointerMoved {
        sample: PointerSample,
    },
    RelativePointerMotion {
        motion: RelativePointerMotion,
    },
    MouseWheel {
        delta: ScrollDelta,
    },
    MouseButton {
        button: MouseButton,
        state: ButtonState,
    },
    PointerLeft,
    FocusLost,
}
Expand description

One platform-independent physical input event.

Repeated presses of an already-held key or mouse button, and repeated releases of one already up, do not create logical edges. Motion updates continuous state without creating edges. Event order determines the pointer sample captured by each mouse edge.

Variants§

§

Key

A physical keyboard state change.

Fields

§key: PhysicalKeyCode

The physical location of the key.

§state: ButtonState

The reported button state.

§

PointerMoved

Updates the continuous pointer without generating a logical action edge.

Fields

§sample: PointerSample

Finite logical coordinates and the viewport at this point in event order.

§

RelativePointerMotion

Adds raw displacement to this frame’s relative motion without changing the absolute pointer or generating action edges. Not retained for fixed ticks. FocusLost clears motion and ignores later motion in the same batch.

Fields

§motion: RelativePointerMotion

Validated raw device displacement, independent of the viewport/DPI.

§

MouseWheel

One wheel occurrence with explicit line or logical-pixel units. Captures the latest pointer in event order; no binding, fixed replay, or token. FocusLost discards all wheel events in the same accepted batch.

Fields

§delta: ScrollDelta

Finite per-event displacement; separate occurrences are not combined.

§

MouseButton

A physical mouse-button state change, using the latest pointer sample.

Fields

§button: MouseButton

The physical mouse button.

§state: ButtonState

The reported button state.

§

PointerLeft

Clears the pointer and releases held mouse buttons in Left/Right/Middle order. Synthesized releases have no pointer sample. Keyboard state is unchanged. The generated releases have a PointerLeft cancellation reason.

§

FocusLost

Clears the pointer and cancels held mapped keyboard controls in the supported key catalog order, then mouse controls in Left/Right/Middle order. Generated releases have a FocusLost reason and no pointer sample.

One event can create many logical edges; all normal frame and retained limits apply atomically. Later events in the same batch are still read. This is not a persistent focus-state flag or an input-routing layer.

Implementations§

Source§

impl InputEvent

Source

pub const fn key(key: PhysicalKeyCode, state: ButtonState) -> Self

Creates a physical keyboard event for the headless or desktop adapter.

Source

pub const fn pointer_moved(sample: PointerSample) -> Self

Creates an ordered pointer-position update, independent of bindings.

Source

pub const fn relative_pointer_motion(motion: RelativePointerMotion) -> Self

Supplies validated raw displacement; headless injection needs no OS capture.

Source

pub const fn mouse_wheel(delta: ScrollDelta) -> Self

Supplies a validated, ordered wheel event for frame-update consumers.

Source

pub const fn mouse_button(button: MouseButton, state: ButtonState) -> Self

Creates a mouse-button event. Its logical edge captures the latest preceding pointer sample, or None when no position is known.

Trait Implementations§

Source§

impl Clone for InputEvent

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for InputEvent

Source§

impl Debug for InputEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for InputEvent

Source§

impl Hash for InputEvent

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for InputEvent

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for InputEvent

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Action for T
where T: Copy + Eq + Hash + Send + Sync + 'static,

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

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

Source§

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.
Source§

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.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

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

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> DynEq for T
where T: Any + Eq,

Source§

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

This method tests for self and other values to be equal. Read more
Source§

impl<T> DynHash for T
where T: DynEq + Hash,

Source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feeds this value into the given Hasher.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WorldEvent for T
where T: Copy + Send + Sync + 'static,