Struct MouseEvent

pub struct MouseEvent {
    pub pos: Point,
    pub buttons: MouseButtons,
    pub mods: Modifiers,
    pub count: u8,
    pub focus: bool,
    pub button: MouseButton,
    pub wheel_delta: Vec2,
}

Information about the mouse event.

Every mouse event can have a new position. There is no guarantee of receiving a move event before another mouse event.

Fields

pos: Point

The location of the mouse in display points in relation to the current window.

buttons: MouseButtons

Mouse buttons being held down during a move or after a click event. Thus it will contain the button that triggered a mouse-down event, and it will not contain the button that triggered a mouse-up event.

mods: Modifiers

Keyboard modifiers at the time of the event.

count: u8

The number of mouse clicks associated with this event. This will always be 0 for a mouse-up and mouse-move events.

focus: bool

Focus is true on macOS when the mouse-down event (or its companion mouse-up event) with MouseButton::Left was the event that caused the window to gain focus.

button: MouseButton

The button that was pressed down in the case of mouse-down, or the button that was released in the case of mouse-up. This will always be MouseButton::None in the case of mouse-move.

wheel_delta: Vec2

The wheel movement.

The polarity is the amount to be added to the scroll position, in other words the opposite of the direction the content should move on scrolling. This polarity is consistent with the deltaX and deltaY values in a web WheelEvent.

Trait Implementations

impl Clone for MouseEvent

fn clone(&self) -> MouseEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MouseEvent

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

Formats the value using the given formatter.

impl PartialEq for MouseEvent

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

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

const 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 StructuralPartialEq for MouseEvent