Struct KeyboardState 

#[repr(C)]
pub struct KeyboardState {
    pub current_virtual_keycode: OptionVirtualKeyCode,
    pub pressed_virtual_keycodes: VirtualKeyCodeVec,
    pub pressed_scancodes: ScanCodeVec,
}

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

Fields

current_virtual_keycode: OptionVirtualKeyCode

Currently pressed virtual keycode - DO NOT USE THIS FOR TEXT INPUT.

For text input, use the text_input parameter in callbacks. For example entering à will fire a VirtualKeyCode::Grave, then VirtualKeyCode::A, so to correctly combine characters, the framework handles text composition internally.

pressed_virtual_keycodes: VirtualKeyCodeVec

Currently pressed virtual keycodes (READONLY) - it can happen that more than one key is pressed

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 text input will be handled by the framework automatically for contenteditable nodes.

pressed_scancodes: ScanCodeVec

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.)

Implementations

impl KeyboardState

pub fn shift_down(&self) -> bool

pub fn ctrl_down(&self) -> bool

pub fn alt_down(&self) -> bool

pub fn super_down(&self) -> bool

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

pub fn matches_accelerator(&self, chord: &[AcceleratorKey]) -> bool

Returns true iff every entry of chord is currently active in this keyboard state. Used by accelerator/keymap registrations to evaluate shortcuts like [Ctrl, Shift, Key(VirtualKeyCode::S)].

An empty chord matches trivially.

Trait Implementations

impl Clone for KeyboardState

fn clone(&self) -> KeyboardState

Returns a duplicate 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