Enum Event

#[non_exhaustive]
pub enum Event {
    Quit,
    AppTerminating,
    Window {
        window_id: u32,
        win_event: WindowEvent,
    },
    KeyDown {
        key: Option<Key>,
        keymod: KeyMod,
        repeat: bool,
    },
    KeyUp {
        key: Option<Key>,
        keymod: KeyMod,
        repeat: bool,
    },
    TextInput {
        text: String,
    },
    MouseMotion {
        x: i32,
        y: i32,
        xrel: i32,
        yrel: i32,
    },
    MouseDown {
        button: Mouse,
        x: i32,
        y: i32,
    },
    MouseUp {
        button: Mouse,
        x: i32,
        y: i32,
    },
    MouseWheel {
        x: i32,
        y: i32,
    },
    JoyAxisMotion {
        joy_id: u32,
        axis_idx: u8,
        value: i16,
    },
    JoyHatMotion {
        joy_id: u32,
        hat_idx: u8,
        state: HatState,
    },
    JoyBallMotion {
        joy_id: u32,
        ball_idx: u8,
        xrel: i16,
        yrel: i16,
    },
    JoyDown {
        joy_id: u32,
        button_idx: u8,
    },
    JoyUp {
        joy_id: u32,
        button_idx: u8,
    },
    JoyDeviceAdded {
        joy_id: u32,
    },
    JoyDeviceRemoved {
        joy_id: u32,
    },
    ControllerAxisMotion {
        controller_id: u32,
        axis: Axis,
        value: i16,
    },
    ControllerDown {
        controller_id: u32,
        button: ControllerButton,
    },
    ControllerUp {
        controller_id: u32,
        button: ControllerButton,
    },
    ControllerAdded {
        controller_id: u32,
    },
    ControllerRemoved {
        controller_id: u32,
    },
    ControllerRemapped {
        controller_id: u32,
    },
    FingerDown {
        touch_id: i64,
        finger_id: i64,
        x: f32,
        y: f32,
        dx: f32,
        dy: f32,
        pressure: f32,
    },
    FingerUp {
        touch_id: i64,
        finger_id: i64,
        x: f32,
        y: f32,
        dx: f32,
        dy: f32,
        pressure: f32,
    },
    FingerMotion {
        touch_id: i64,
        finger_id: i64,
        x: f32,
        y: f32,
        dx: f32,
        dy: f32,
        pressure: f32,
    },
    AudioDeviceAdded {
        device_id: u32,
        iscapture: bool,
    },
    AudioDeviceRemoved {
        device_id: u32,
        iscapture: bool,
    },
    Unhandled,
}

System or User Event.

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.

Quit

System quit event for the application.

AppTerminating

System termination event for the application.

Window

Window events.

Fields

window_id: u32

Window identifer for this event.

win_event: WindowEvent

Specific window event.

KeyDown

User key press event.

Fields

key: Option<Key>

Specific key being pressed.

keymod: KeyMod

Key modifiers being held upon press, e.g. Shift or Ctrl, etc.

repeat: bool

Whether this is a key-repeat event.

KeyUp

User key release event.

Fields

key: Option<Key>

Specific key being released.

keymod: KeyMod

Key modifiers being held upon release, e.g. Shift or Ctrl, etc.

repeat: bool

Whether this is a key-repeat event.

TextInput

User text entry event.

Fields

text: String

The user-entered text.

MouseMotion

User mouse movement event.

Fields

x: i32

Current horizontal mouse position after motion.

y: i32

Current vertical mouse position after motion.

xrel: i32

Relative horizontal screen movement since last event.

yrel: i32

Relative vertical screen movement since last event.

MouseDown

User mouse click event.

Fields

button: Mouse

Specific mouse button being clicked.

x: i32

Current horizontal mouse position after click.

y: i32

Current vertical mouse position after click.

MouseUp

User mouse release event.

Fields

button: Mouse

Specific mouse button being released.

x: i32

Current horizontal mouse position after release.

y: i32

Current vertical mouse position after release.

MouseWheel

User mouse wheel event.

Fields

x: i32

Relative horizontal wheel offset.

y: i32

Relative vertical wheel offset.

JoyAxisMotion

User joystick axis movement event.

Fields

joy_id: u32

Specific attached joystick identifier.

axis_idx: u8

Specific joystick axis being moved.

value: i16

Relative value of axis motion.

JoyHatMotion

User joystick hat movement event.

Fields

joy_id: u32

Specific attached joystick identifier.

hat_idx: u8

Specific joystick hat being moved.

state: HatState

Hat state.

JoyBallMotion

User joystick ball movement event.

Fields

joy_id: u32

Specific attached joystick identifier.

ball_idx: u8

Specific joystick ball being moved.

xrel: i16

Relative horizontal value of ball motion.

yrel: i16

Relative vertical value of ball motion.

JoyDown

User joystick button pressed event.

Fields

joy_id: u32

Specific attached joystick identifier.

button_idx: u8

Specific joystick button being pressed.

JoyUp

User joystick button released event.

Fields

joy_id: u32

Specific attached joystick identifier.

button_idx: u8

Specific joystick button being released.

JoyDeviceAdded

User joystick connected event.

Fields

joy_id: u32

Specific attached joystick identifier.

JoyDeviceRemoved

User joystick disconnected event.

Fields

joy_id: u32

Specific attached joystick identifier.

ControllerAxisMotion

User controller axis movement event.

Fields

controller_id: u32

Specific attached controller identifier.

axis: Axis

Specific controller axis being moved.

value: i16

Relative value of axis motion.

ControllerDown

User controller button pressed event.

Fields

controller_id: u32

Specific attached controller identifier.

button: ControllerButton

Specific controller button being pressed.

ControllerUp

User controller button released event.

Fields

controller_id: u32

Specific attached controller identifier.

button: ControllerButton

Specific controller button being released.

ControllerAdded

User controller connected event.

Fields

controller_id: u32

Specific attached controller identifier.

ControllerRemoved

User controller disconnected event.

Fields

controller_id: u32

Specific attached controller identifier.

ControllerRemapped

User controller remapped event.

Fields

controller_id: u32

Specific attached controller identifier.

FingerDown

User finger press event.

Fields

touch_id: i64

Specific touch device identifier.

finger_id: i64

Specific finger identifier.

x: f32

Current horizontal finger position after press.

y: f32

Current vertical finger position after press.

dx: f32

Relative horizontal finger position since last event.

dy: f32

Relative vertical finger position since last event.

pressure: f32

Amount of finger pressure being applied during press.

FingerUp

User finger released event.

Fields

touch_id: i64

Specific touch device identifier.

finger_id: i64

Specific finger identifier.

x: f32

Current horizontal finger position after press.

y: f32

Current vertical finger position after press.

dx: f32

Relative horizontal finger position since last event.

dy: f32

Relative vertical finger position since last event.

pressure: f32

Amount of finger pressure being applied during press.

FingerMotion

User finger movement event.

Fields

touch_id: i64

Specific touch device identifier.

finger_id: i64

Specific finger identifier.

x: f32

Current horizontal finger position after press.

y: f32

Current vertical finger position after press.

dx: f32

Relative horizontal finger position since last event.

dy: f32

Relative vertical finger position since last event.

pressure: f32

Amount of finger pressure being applied during press.

AudioDeviceAdded

Audio device connected event.

Fields

device_id: u32

Specific audio device identifier.

iscapture: bool

Whether this device is a capture device or not.

AudioDeviceRemoved

Audio device disconnected event.

Fields

device_id: u32

Specific audio device identifier.

iscapture: bool

Whether this device is a capture device or not.

Unhandled

An unknown/unsupported event.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl Default for Event

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Event

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Event

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Event

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Event