Struct SDL_KeyboardEvent 

#[repr(C)]
pub struct SDL_KeyboardEvent {
    pub type: SDL_EventType,
    pub reserved: Uint32,
    pub timestamp: Uint64,
    pub windowID: SDL_WindowID,
    pub which: SDL_KeyboardID,
    pub scancode: SDL_Scancode,
    pub key: SDL_Keycode,
    pub mod: SDL_Keymod,
    pub raw: Uint16,
    pub down: bool,
    pub repeat: bool,
}

Keyboard button event structure (event.key.*)

The key is the base SDL_Keycode generated by pressing the scancode using the current keyboard layout, applying any options specified in SDL_HINT_KEYCODE_OPTIONS. You can get the SDL_Keycode corresponding to the event scancode and modifiers directly from the keyboard layout, bypassing SDL_HINT_KEYCODE_OPTIONS, by calling SDL_GetKeyFromScancode().

Availability

This struct is available since SDL 3.2.0.

See also

• SDL_GetKeyFromScancode
• SDL_HINT_KEYCODE_OPTIONS

Fields

type: SDL_EventType

SDL_EVENT_KEY_DOWN or SDL_EVENT_KEY_UP

reserved: Uint32

timestamp: Uint64

In nanoseconds, populated using SDL_GetTicksNS()

windowID: SDL_WindowID

The window with keyboard focus, if any

which: SDL_KeyboardID

The keyboard instance id, or 0 if unknown or virtual

scancode: SDL_Scancode

SDL physical key code

key: SDL_Keycode

SDL virtual key code

mod: SDL_Keymod

current key modifiers

raw: Uint16

The platform dependent scancode for this event

down: bool

true if the key is pressed

repeat: bool

true if this is a key repeat

Trait Implementations

impl Clone for SDL_KeyboardEvent

fn clone(&self) -> SDL_KeyboardEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_KeyboardEvent

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

Formats the value using the given formatter.

impl Default for SDL_KeyboardEvent

fn default() -> SDL_KeyboardEvent

Returns the “default value” for a type.

impl Hash for SDL_KeyboardEvent

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 for SDL_KeyboardEvent

fn eq(&self, other: &SDL_KeyboardEvent) -> 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 Copy for SDL_KeyboardEvent

impl Eq for SDL_KeyboardEvent

impl StructuralPartialEq for SDL_KeyboardEvent