Struct MouseState

pub struct MouseState {
    pub mouse_cursor_type: Option<MouseCursorType>,
    pub cursor_position: CursorPosition,
    pub is_cursor_locked: bool,
    pub left_down: bool,
    pub right_down: bool,
    pub middle_down: bool,
    pub scroll_x: Option<f32>,
    pub scroll_y: Option<f32>,
}

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

Fields

mouse_cursor_type: Option<MouseCursorType>

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

cursor_position: CursorPosition

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

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)

scroll_x: Option<f32>

Scroll amount in pixels in the horizontal direction. Gets reset to 0 after every frame (READONLY)

scroll_y: Option<f32>

Scroll amount in pixels in the vertical direction. Gets reset to 0 after every frame (READONLY)

Implementations

impl MouseState

pub fn mouse_down(&self) -> bool

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

pub fn get_scroll_x(&self) -> f32

pub fn get_scroll_y(&self) -> f32

pub fn get_scroll(&self) -> (f32, f32)

Trait Implementations

impl Clone for MouseState

fn clone(&self) -> MouseState

Returns a copy of the value.

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

Performs copy-assignment from source.

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 PartialEq for MouseState

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

impl StructuralPartialEq for MouseState