Enum tao::event::DeviceEvent

#[non_exhaustive]
pub enum DeviceEvent {
    Added,
    Removed,
    MouseMotion {
        delta: (f64, f64),
    },
    MouseWheel {
        delta: MouseScrollDelta,
    },
    Motion {
        axis: AxisId,
        value: f64,
    },
    Button {
        button: ButtonId,
        state: ElementState,
    },
    Key(RawKeyEvent),
    Text {
        codepoint: char,
    },
}

Represents raw hardware events that are not associated with any particular window.

Useful for interactions that diverge significantly from a conventional 2D GUI, such as 3D camera or first-person game controls. Many physical actions, such as mouse movement, can produce both device and window events. Because window events typically arise from virtual devices (corresponding to GUI cursors and keyboard focus) the device IDs may not match.

Note that these events are delivered regardless of input focus.

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.

Added

Removed

MouseMotion

Change in physical position of a pointing device.

This represents raw, unfiltered physical motion. Not to be confused with WindowEvent::CursorMoved.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

delta: (f64, f64)

(x, y) change in position in unspecified units.

Different devices may use different units.

MouseWheel

Physical scroll event

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

delta: MouseScrollDelta

Motion

Motion on some analog axis. This event will be reported for all arbitrary input devices that tao supports on this platform, including mouse devices. If the device is a mouse device then this will be reported alongside the MouseMotion event.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

axis: AxisId

value: f64

Button

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

button: ButtonId

state: ElementState

Key(RawKeyEvent)

Text

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

codepoint: char

Trait Implementations

impl Clone for DeviceEvent

fn clone(&self) -> DeviceEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceEvent

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

Formats the value using the given formatter.

impl PartialEq for DeviceEvent

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

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

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 DeviceEvent