Struct buttons::Mouse

pub struct Mouse<Button, Coord> where
    Button: Copy + PartialEq,
    Coord: Copy + Default + Add<Output = Coord>,  { /* fields omitted */ }

A structure representing the current state of a mouse.

Methods

impl<Button, Coord> Mouse<Button, Coord> where
    Button: Copy + PartialEq,
    Coord: Copy + Default + Add<Output = Coord>, 

pub fn new() -> Self

pub fn at_position(position: [Coord; 2]) -> Self

Create the Mouse at a specific pointer position.

pub fn begin_frame_input(&mut self) -> MouseInput<Button, Coord>

Returns a MouseInput structure that can be used to register changes to the button and pointer state of the mouse.

pub fn position(&self) -> [Coord; 2]

Returns the position of the mouse pointer.

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

Returns true if the given button is currently held down.

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

Returns true if the given button was pressed this frame.

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

Returns true if the given button was released this frame.

Trait Implementations

impl<Button: Clone, Coord: Clone> Clone for Mouse<Button, Coord> where
    Button: Copy + PartialEq,
    Coord: Copy + Default + Add<Output = Coord>, 

fn clone(&self) -> Mouse<Button, Coord>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Button: Debug, Coord: Debug> Debug for Mouse<Button, Coord> where
    Button: Copy + PartialEq,
    Coord: Copy + Default + Add<Output = Coord>, 

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

Formats the value using the given formatter.

impl<Button, Coord> Default for Mouse<Button, Coord> where
    Button: Copy + PartialEq,
    Coord: Copy + Default + Add<Output = Coord>, 

fn default() -> Self

Returns the "default value" for a type.