Enum InputEvent 

#[non_exhaustive]
pub enum InputEvent {
    PointerMoved {
        position: Point,
    },
    PointerButton {
        button: PointerButton,
        state: ElementState,
        position: Point,
        modifiers: Modifiers,
    },
    PointerScroll {
        delta_x: f32,
        delta_y: f32,
        position: Point,
    },
    PointerLeft,
    TouchDown {
        id: TouchId,
        position: Point,
    },
    TouchMoved {
        id: TouchId,
        position: Point,
    },
    TouchUp {
        id: TouchId,
        position: Point,
        cancelled: bool,
    },
    Key {
        code: KeyCode,
        state: ElementState,
        repeat: bool,
        modifiers: Modifiers,
    },
    Text {
        ch: char,
    },
    SurfaceResized {
        size: Size,
        scale_factor: f32,
    },
    CloseRequested,
}

Something the user or the windowing system did.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PointerMoved

The pointer moved to position.

Fields

position: Point

New position, in physical pixels.

PointerButton

A pointer button changed state.

Fields

button: PointerButton

Which button.

state: ElementState

Down or up.

position: Point

Where it happened.

modifiers: Modifiers

Modifiers held at the time.

PointerScroll

The wheel or a scroll gesture moved.

Both deltas are content offsets, not device movement: positive y scrolls content down and positive x scrolls it right, which is the sign a scroll view adds straight to its offset. A backend reporting the gesture instead — most of them do — negates both on the way in.

Saying it for one axis and not the other is how the horizontal wheel came out backwards on macOS and stayed that way: y carried this note and x carried none, so the runner negated one and passed the other through.

Fields

delta_x: f32

Horizontal delta in physical pixels. Positive scrolls content right.

delta_y: f32

Vertical delta in physical pixels. Positive scrolls content down.

position: Point

Pointer position at the time.

PointerLeft

The pointer left the surface. Clear hover state.

TouchDown

A finger touched down.

Fields

id: TouchId

Finger identity, valid until the matching InputEvent::TouchUp.

position: Point

Contact position.

TouchMoved

A finger moved while down.

Fields

id: TouchId

Finger identity.

position: Point

New contact position.

TouchUp

A finger lifted, or its sequence was cancelled.

Fields

id: TouchId

Finger identity.

position: Point

Last known position.

cancelled: bool

true if the system cancelled the sequence rather than the user lifting.

Key

A key changed state.

Fields

code: KeyCode

Physical key position.

state: ElementState

Down or up.

repeat: bool

true for auto-repeat.

modifiers: Modifiers

Modifiers held at the time.

Text

Committed text, one character at a time.

Emitted after dead-key composition, so pressing ¨ then o yields exactly one Text('ö') and no text for the dead key itself.

Fields

ch: char

The character.

SurfaceResized

The surface changed size or DPI. Invalidate layout and damage history.

Fields

size: Size

New extent in physical pixels.

scale_factor: f32

New physical-per-logical pixel ratio.

CloseRequested

The user asked to close. The application decides whether to honour it.

Trait Implementations

impl Clone for InputEvent

fn clone(&self) -> InputEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputEvent

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

Formats the value using the given formatter.

impl PartialEq for InputEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InputEvent