Struct MouseState 

#[repr(C)]
pub struct MouseState {
    pub pointer_device_id: u64,
    pub cursor_position: CursorPosition,
    pub mouse_cursor_type: OptionMouseCursorType,
    pub pointer_source: PointerSource,
    pub is_cursor_locked: bool,
    pub left_down: bool,
    pub right_down: bool,
    pub middle_down: bool,
    pub other_down: u8,
}

Mouse position, cursor type, user scroll input, etc.

Fields

pointer_device_id: u64

Which physical pointing device is driving, or 0 when the platform does not say. (READONLY)

cursor_position: CursorPosition

Where is the mouse cursor currently? Set to None if the window is not focused. (READWRITE)

mouse_cursor_type: OptionMouseCursorType

Current mouse cursor type, set to None if the cursor is hidden. (READWRITE)

pointer_source: PointerSource

What kind of device is currently driving the pointer. (READONLY)

On MouseState rather than on the event because it is a property of the DEVICE, not of one motion — an app can ask “is this a trackpad?” from any callback, not only from inside a pointer handler.

is_cursor_locked: bool

Is the mouse cursor locked to the current window (important for applications like games)? (READWRITE)

left_down: bool

Is the left mouse button down? (READONLY)

right_down: bool

Is the right mouse button down? (READONLY)

middle_down: bool

Is the middle mouse button down? (READONLY)

other_down: u8

Bitmask of the thumb buttons currently held. (READONLY)

A bitmask rather than two bools because the set is open-ended: a mouse can report buttons past forward, and the shells already carry them as MouseButton::Other(n). Bit 0 is back, bit 1 is forward — see MOUSE_OTHER_MASK_BACK / MOUSE_OTHER_MASK_FORWARD; use MouseState::back_down and MouseState::forward_down rather than testing bits by hand.

Implementations

impl MouseState

pub const fn back_down(&self) -> bool

Whether the thumb “back” button is held.

pub const fn forward_down(&self) -> bool

Whether the thumb “forward” button is held.

pub const fn matches(&self, context: &ContextMenuMouseButton) -> bool

impl MouseState

pub const fn mouse_down(&self) -> bool

Returns whether any mouse button (left, right or center) is currently held down

pub const fn button_state(&self) -> MouseButtonState

Snapshot the button-down flags as a MouseButtonState for drag tracking.

Trait Implementations

impl Clone for MouseState

fn clone(&self) -> MouseState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MouseState

impl Debug for MouseState

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

Formats the value using the given formatter.

impl Default for MouseState

fn default() -> Self

Returns the “default value” for a type.

impl Eq for MouseState

impl From<&MouseState> for MouseButtonState

fn from(s: &MouseState) -> Self

Converts to this type from the input type.

impl PartialEq for MouseState

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MouseState

fn partial_cmp(&self, other: &MouseState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for MouseState