Struct coffee::input::mouse::Mouse

pub struct Mouse { /* fields omitted */ }

A simple mouse input tracker.

You can use this as your Game::Input directly!

Implementations

impl Mouse

pub fn cursor_position(&self) -> Point

Returns the current cursor position.

pub fn wheel_movement(&self) -> WheelMovement

Returns the wheel movements during the last interaction.

pub fn is_cursor_taken(&self) -> bool

Returns true if the cursor is currently not available.

This mostly happens when the cursor is currently over a UserInterface.

pub fn is_cursor_within_window(&self) -> bool

Returns true if the cursor is currently within the Window.

pub fn is_button_pressed(&self, button: Button) -> bool

Returns true if the given button is currently pressed.

pub fn button_clicks(&self, button: Button) -> &[Point]

Returns the positions of the clicks during the last interaction.

Clicks performed while the cursor is not available are automatically ignored.

Trait Implementations

impl Clone for Mouse

fn clone(&self) -> Mouse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mouse

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

Formats the value using the given formatter.

impl Input for Mouse

fn new() -> Mouse

Creates a new [Input].

fn update(&mut self, event: InputEvent)

Processes an input event.

fn clear(&mut self)

Clears any temporary state that should be consumed by [Game::interact] and could accumulate otherwise.