Struct ggez::event::MouseState

pub struct MouseState { /* fields omitted */ }

Methods

impl MouseState

pub fn new(_e: &EventPump) -> MouseState

pub fn from_sdl_state(state: u32) -> MouseState

pub fn to_sdl_state(&self) -> u32

pub fn left(&self) -> bool

Returns true if the left mouse button is pressed.

Example

use sdl2::mouse::MouseButton;

fn is_a_pressed(e: &sdl2::EventPump) -> bool {
    e.mouse_state().left()
}

pub fn middle(&self) -> bool

Tests if the middle mouse button was pressed.

pub fn right(&self) -> bool

Tests if the right mouse button was pressed.

pub fn x1(&self) -> bool

Tests if the X1 mouse button was pressed.

pub fn x2(&self) -> bool

Tests if the X2 mouse button was pressed.

pub fn x(&self) -> i32

Returns the x coordinate of the state

pub fn y(&self) -> i32

Returns the y coordinate of the state

pub fn is_mouse_button_pressed(&self, mouse_button: MouseButton) -> bool

Returns true if the mouse button is pressed.

Example

use sdl2::mouse::MouseButton;

fn is_left_pressed(e: &sdl2::EventPump) -> bool {
    e.mouse_state().is_mouse_button_pressed(MouseButton::Left)
}

Important traits for MouseButtonIterator<'a>

impl<'a> Iterator for MouseButtonIterator<'a> type Item = (MouseButton, bool);

pub fn mouse_buttons(&self) -> MouseButtonIterator

Returns an iterator all mouse buttons with a boolean indicating if the scancode is pressed.

Example

use sdl2::mouse::MouseButton;
use std::collections::HashMap;

fn mouse_button_set(e: &sdl2::EventPump) -> HashMap<MouseButton, bool> {
    e.mouse_state().mouse_buttons().collect()
}

fn find_first_pressed(e: &sdl2::EventPump) -> bool {
    for (key,value) in mouse_button_set(e) {
        return value != false
    }
    false
}

Important traits for PressedMouseButtonIterator<'a>

impl<'a> Iterator for PressedMouseButtonIterator<'a> type Item = MouseButton;

pub fn pressed_mouse_buttons(&self) -> PressedMouseButtonIterator

Returns an iterator of pressed mouse buttons.

Example

use sdl2::mouse::MouseButton;
use std::collections::HashSet;

fn pressed_mouse_button_set(e: &sdl2::EventPump) -> HashSet<MouseButton> {
    e.mouse_state().pressed_mouse_buttons().collect()
}

fn newly_pressed(old: &HashSet<MouseButton>, new: &HashSet<MouseButton>) -> HashSet<MouseButton> {
    new - old
    // sugar for: new.difference(old).collect()
}

Trait Implementations

impl Copy for MouseState

impl Hash for MouseState

fn hash<__H>(&self, __arg_0: &mut __H) where
    __H: Hasher, 

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<MouseState> for MouseState

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &MouseState) -> bool

This method tests for !=.

impl Eq for MouseState

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.