Struct winit::KeyboardInput

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

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

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

modifiers: ModifiersState

Modifier keys active at the time of this input.

This is tracked internally to avoid tracking errors arising from modifier key state changes when events from this device are not being delivered to the application, e.g. due to keyboard focus being elsewhere.

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 Debug for KeyboardInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyboardInput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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,
    Self: Sized,

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: &Rhs) -> bool

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

impl Serialize for KeyboardInput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for KeyboardInput

impl Eq for KeyboardInput

impl StructuralEq for KeyboardInput

impl StructuralPartialEq for KeyboardInput