Struct screen_13::prelude::MouseBuf

pub struct MouseBuf {
    pub delta: (f32, f32),
    pub wheel: (f32, f32),
    pub x: f32,
    pub y: f32,
    /* private fields */
}

A container for Window-based mouse, tablet and touch input events.

Fields

delta: (f32, f32)

Amount of mouse movement detected since the last update.

wheel: (f32, f32)

Amount of wheel scroll detected since the last update.

x: f32

The x-axis mouse position in pixels.

y: f32

The y-axis mouse position in pixels.

Implementations

impl MouseBuf

pub fn any_held(&self) -> bool

Returns true if any buttons have been pressed for multiple frames.

pub fn any_pressed(&self) -> bool

Returns true if any buttons have been pressed since the last frame.

pub fn any_released(&self) -> bool

Returns true if any buttons have been released since the last frame.

pub fn update(&mut self)

Call this before handling events.

pub fn handle_event(&mut self, event: &Event<'_, ()>) -> bool

Handles a single event.

pub fn is_held(&self, button: MouseButton) -> bool

Returns true if the given button has been pressed for multiple frames.

pub fn is_pressed(&self, button: MouseButton) -> bool

Returns true if the given button has been pressed since the last frame.

pub fn is_released(&self, button: MouseButton) -> bool

Returns true if the given button has been released since the last frame.

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

Centered around zero, so negative values are the bottom left of the screen.

Units are unspecified and vary by device.

Trait Implementations

impl Clone for MouseBuf

fn clone(&self) -> MouseBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseBuf

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

Formats the value using the given formatter.

impl Default for MouseBuf

fn default() -> MouseBuf

Returns the “default value” for a type.