Struct InputState 

pub struct InputState {
    pub mouse: Mouse,
    pub keyboard: Keyboard,
}

A stored state of most common input events. It is used a “shortcut” in cases where event-based approach is too verbose. Important: this structure does not track from which device the corresponding event has come from, if you have more than one keyboard and/or mouse, use event-based approach instead! You should always prefer the event-based approach when possible.

Fields

mouse: Mouse

Represents the mouse state in the current frame.

keyboard: Keyboard

Represents the keyboard state in the current frame.

Implementations

impl InputState

pub fn is_key_down(&self, key: KeyCode) -> bool

Returns true if the specified key is pressed, false - otherwise.

pub fn is_key_pressed(&self, key: KeyCode) -> bool

Returns true if the specified key was pressed in the current frame, false - otherwise. This method will return false if the key is still pressed in the next frame. This is useful to check if a key was pressed and some action, but do not repeat the same action over and over until the key is released.

pub fn is_key_released(&self, key: KeyCode) -> bool

Returns true if the specified key was released in the current frame, false - otherwise. This method will return false if the key is still released in the next frame. This is useful to check if a key was released and some action, but do not repeat the same action over and over until the key is pressed.

pub fn is_mouse_button_down(&self, button_id: ButtonId) -> bool

Returns true if the specified mouse button is pressed, false - otherwise. Usually, the button indices are the following:

• 0 - left mouse button
• 1 - right mouse button
• 2 - middle mouse button
• 3 - additional mouse button (could back or forward)
• 4 - additional mouse button (could back or forward)
• 5 and higher - device-specific buttons

There are named constants for the tree most used ones - Mouse::LEFT_BUTTON, Mouse::RIGHT_BUTTON, Mouse::MIDDLE_BUTTON.

pub fn is_mouse_button_pressed(&self, button_id: ButtonId) -> bool

Returns true if the specified button was pressed in the current frame, false - otherwise. This method will return false if the button is still pressed in the next frame. This is useful to check if a button was pressed and some action, but do not repeat the same action over and over until the button is released. See the docs of Self::is_mouse_button_down for button ids.

pub fn is_mouse_button_released(&self, button_id: ButtonId) -> bool

Returns true if the specified button was released in the current frame, false - otherwise. This method will return false if the button is still released in the next frame. This is useful to check if a button was released and some action, but do not repeat the same action over and over until the button is pressed. See the docs of Self::is_mouse_button_down for button ids.

pub fn is_left_mouse_button_down(&self) -> bool

Returns true if the left mouse button is pressed, false - otherwise.

pub fn is_right_mouse_button_down(&self) -> bool

Returns true if the right mouse button is pressed, false - otherwise.

pub fn is_middle_mouse_button_down(&self) -> bool

Returns true if the middle mouse button pressed is pressed, false - otherwise.

pub fn is_left_mouse_button_pressed(&self) -> bool

Returns true if the left mouse button was pressed on the current frame, false - otherwise.

pub fn is_right_mouse_button_pressed(&self) -> bool

Returns true if the right mouse button was pressed on the current frame, false - otherwise.

pub fn is_middle_mouse_button_pressed(&self) -> bool

Returns true if the middle mouse button was pressed on the current frame, false - otherwise.

pub fn is_left_mouse_button_released(&self) -> bool

Returns true if the left mouse button was released on the current frame, false - otherwise.

pub fn is_right_mouse_button_released(&self) -> bool

Returns true if the right mouse button was released on the current frame, false - otherwise.

pub fn is_middle_mouse_button_released(&self) -> bool

Returns true if the middle mouse button was released on the current frame, false - otherwise.

pub fn mouse_speed(&self) -> Vector2<f32>

Returns mouse speed in the current frame, the speed expressed in some arbitrary units.

pub fn mouse_position(&self) -> Vector2<f32>

Returns mouse position in pixels relative to the top-left corner of the main window.

Trait Implementations

impl Clone for InputState

fn clone(&self) -> InputState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for InputState

fn default() -> InputState

Returns the “default value” for a type.