Struct KeyboardState

pub struct KeyboardState {
    pub shift_down: bool,
    pub ctrl_down: bool,
    pub alt_down: bool,
    pub super_down: bool,
    pub current_char: Option<char>,
    pub current_virtual_keycode: Option<VirtualKeyCode>,
    pub pressed_virtual_keycodes: HashSet<VirtualKeyCode>,
    pub pressed_scancodes: HashSet<ScanCode>,
}

Determines which keys are pressed currently (modifiers, etc.)

Fields

shift_down: bool

Tracks, if the Shift key is currently pressed - (READONLY)

ctrl_down: bool

Tracks, if the Ctrl key is currently pressed - (READONLY)

alt_down: bool

Tracks, if the Alt key is currently pressed - (READONLY)

super_down: bool

Tracks, if the Super / Windows / Command key is currently pressed - (READONLY)

current_char: Option<char>

Currently pressed key, already converted to a char - (READONLY)

current_virtual_keycode: Option<VirtualKeyCode>

Same as current_char, but .

DO NOT USE THIS FOR TEXT INPUT, USE current_char and On::TextInput instead. For example entering à will fire a VirtualKeyCode::Grave, then VirtualKeyCode::A, so to correctly combine characters, use the current_char field.

pressed_virtual_keycodes: HashSet<VirtualKeyCode>

Currently pressed virtual keycodes (READONLY) - it can happen that more t

This is essentially an “extension” of current_scancodes - current_keys stores the characters, but what if the pressed key is not a character (such as ArrowRight or PgUp)?

Note that this can have an overlap, so pressing “a” on the keyboard will insert both a VirtualKeyCode::A into current_virtual_keycodes and an "a" as a char into current_keys.

pressed_scancodes: HashSet<ScanCode>

Same as current_virtual_keycodes, but the scancode identifies the physical key pressed, independent of the keyboard layout. The scancode does not change if the user adjusts the host’s keyboard map. Use when the physical location of the key is more important than the key’s host GUI semantics, such as for movement controls in a first-person game (German keyboard: Z key, UK keyboard: Y key, etc.)

Trait Implementations

impl Clone for KeyboardState

fn clone(&self) -> KeyboardState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardState

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

Formats the value using the given formatter.

impl Default for KeyboardState

fn default() -> KeyboardState

Returns the “default value” for a type.

impl PartialEq for KeyboardState

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for KeyboardState