Struct input_device::event::KeyboardInput

pub struct KeyboardInput {
    pub scancode: ScanCode,
    pub state: ElementState,
    pub virtual_keycode: Option<VirtualKeyCode>,
}

Describes a keyboard input event.

Fields

scancode: ScanCode

Identifies the physical key pressed

This should 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.

state: ElementState

Identifies the key is pressed, released or repeated.

virtual_keycode: Option<VirtualKeyCode>

Identifies the semantic meaning of the key

Use when the semantics of the key are more important than the physical location of the key, such as when implementing appropriate behavior for "page up."

Implementations

impl KeyboardInput

pub fn is_key_pressed(&self, key_code: VirtualKeyCode) -> bool

pub fn is_key_released(&self, key_code: VirtualKeyCode) -> bool

pub fn is_key_repeated(&self, key_code: VirtualKeyCode) -> bool

pub fn is_key_triggered(&self, key_code: VirtualKeyCode) -> bool

Trait Implementations

impl Clone for KeyboardInput

fn clone(&self) -> KeyboardInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for KeyboardInput

impl Debug for KeyboardInput

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

Formats the value using the given formatter.

impl Default for KeyboardInput

fn default() -> KeyboardInput

Returns the "default value" for a type.

impl Eq for KeyboardInput

impl Hash for KeyboardInput

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<KeyboardInput> for KeyboardInput

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for KeyboardInput

impl StructuralPartialEq for KeyboardInput