Enum MouseEventKind 

#[non_exhaustive]
pub enum MouseEventKind {
    Down(MouseButton),
    Up(MouseButton),
    Drag(MouseButton),
    Moved,
    Scroll {
        dx: f32,
        dy: f32,
    },
}

Kinds of mouse events.

Does not derive Eq/Hash: Scroll’s f32 fields implement neither.

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.

Down(MouseButton)

Mouse button pressed.

Up(MouseButton)

Mouse button released.

Drag(MouseButton)

Mouse moved while a button was held down; carries which button.

Moved

Mouse moved.

Scroll

Mouse wheel/touchpad scroll.

dy > 0.0 is scroll up, dy < 0.0 is scroll down; dx > 0.0 is scroll right, dx < 0.0 is scroll left (mostly from a laptop touchpad). Magnitude is backend-dependent: the winit backend reports the exact pixel/line delta from the platform, while the crossterm backend synthesizes a fixed step of 1.0 per tick since terminals can’t report scroll precision.

Fields

dx: f32

Horizontal delta. See the variant docs for the sign convention.

dy: f32

Vertical delta. See the variant docs for the sign convention.

Trait Implementations

impl Clone for MouseEventKind

fn clone(&self) -> MouseEventKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseEventKind

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

Formats the value using the given formatter.

impl PartialEq for MouseEventKind

fn eq(&self, other: &MouseEventKind) -> 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 Copy for MouseEventKind

impl StructuralPartialEq for MouseEventKind