KeyboardState

Struct KeyboardState 

Source
pub struct KeyboardState {
    pub flags: [u128; 2],
}
Expand description

Represents a state of pressed keys on a keyboard. Can be used to track the current state of the keyboard or to represent a keyboard state for hotkeys.

Tracks pressed keys using two 128-bit flags, allowing support for 256 keys.

Fields§

§flags: [u128; 2]

Implementations§

Source§

impl KeyboardState

Source

pub fn new() -> KeyboardState

Creates a new KeyboardState with all keys released.

Source

pub fn keydown(&mut self, key: u16)

Marks a key as pressed.

Keys VK_Shift, VK_Control, and VK_Menu will be marked as pressed when either the left or right version is pressed.

Source

pub fn keyup(&mut self, key: u16)

Marks a key as released.

Source

pub fn is_down(&self, key: u16) -> bool

Checks if a key is currently pressed.

Source

pub fn sync(&mut self)

Checks the state of each pressed key against the OS and removes them if they are not pressed.

Source

pub fn clear(&mut self)

Clears the state of all keys, marking them as released.

Source

pub fn get_async_key_state(key: u16) -> bool

Returns whether a key is currently pressed according to the OS.

Trait Implementations§

Source§

impl Clone for KeyboardState

Source§

fn clone(&self) -> KeyboardState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyboardState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for KeyboardState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for KeyboardState

Source§

fn eq(&self, other: &KeyboardState) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for KeyboardState

Source§

impl Eq for KeyboardState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.