Enum sixtyfps_corelib::input::KeyEvent

#[repr(C)]pub enum KeyEvent {
    KeyPressed {
        code: KeyCode,
        modifiers: KeyboardModifiers,
    },
    KeyReleased {
        code: KeyCode,
        modifiers: KeyboardModifiers,
    },
    CharacterInput {
        unicode_scalar: u32,
        modifiers: KeyboardModifiers,
    },
}

Represents a key event sent by the windowing system.

Variants

KeyPressed

A key on a keyboard was pressed.

Fields of KeyPressed

code: KeyCode

The key code of the pressed key.

modifiers: KeyboardModifiers

The keyboard modifiers active at the time of the key press event.

KeyReleased

A key on a keyboard was released.

Fields of KeyReleased

code: KeyCode

The key code of the released key.

modifiers: KeyboardModifiers

The keyboard modifiers active at the time of the key release event.

CharacterInput

A key on a keyboard was released that results in a character that's suitable for text input.

Fields of CharacterInput

unicode_scalar: u32

The u32 is a unicode scalar value that is safe to convert to char.

modifiers: KeyboardModifiers

The keyboard modifiers active at the time of the char input event.

Trait Implementations

impl Clone for KeyEvent

pub fn clone(&self) -> KeyEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyEvent

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

Formats the value using the given formatter.

impl PartialEq<KeyEvent> for KeyEvent

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

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

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

This method tests for !=.

impl StructuralPartialEq for KeyEvent

impl<'_> TryFrom<(&'_ KeyboardInput, KeyboardModifiers)> for KeyEvent

type Error = ()

The type returned in the event of a conversion error.

pub fn try_from(
    input: (&KeyboardInput, KeyboardModifiers)
) -> Result<Self, Self::Error>

Performs the conversion.