Struct KeyState

pub struct KeyState { /* private fields */ }

Tracks the current state of all the keyboard keys.

This is repetitive code, so perhaps better handle it here. You can feed the keyboard events into its KeyState::update method.

KeyState keeps track of the ordering the keys were pressed, and you can call KeyState::get_ordered_keys to get a sequence of currently pressed keys, in the order they were pressed. This is useful for emitting keyboard events that must happen in a very particular ordering.

Implementations

impl KeyState

pub fn new() -> Self

Creates a new KeyState

pub fn update(&mut self, event: KeyEventType, key: Key)

Updates the key tracking state with the given key event pair.

pub fn is_pressed(&self, key: &Key) -> bool

Returns true if key is noted as pressed.

pub fn pressed_any(&self, keys: &[Key]) -> bool

Returns true if at least one key from keys is pressed.

pub fn pressed_all(&self, keys: &[Key]) -> bool

Returns true if all keys from keys are pressed.

pub fn get_set(&self) -> BTreeSet<Key>

Gets all the keys from the set.

pub fn get_ordered_keys(&self) -> Vec<Key>

Gets the list of all currently pressed keys, in the order they were pressed.

pub fn clear(&mut self)

Clears the state of Self, and expunges any stored key presses.

Trait Implementations

impl Clone for KeyState

fn clone(&self) -> KeyState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyState

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

Formats the value using the given formatter.

impl Default for KeyState

fn default() -> KeyState

Returns the “default value” for a type.