Defines constants which identify keyboard keys and modifiers.

Please refer to the Best Keyboard Practices document for details on what this information means and how best to use it.

https://wiki.libsdl.org/SDL3/BestKeyboardPractices The SDL virtual key representation.

Values of this type are used to represent keyboard keys using the current layout of the keyboard. These values include Unicode values representing the unmodified character that would be generated by pressing the key, or an SDLK_* constant for those keys that do not generate characters.

A special exception is the number keys at the top of the keyboard which map by default to SDLK_0...SDLK_9 on AZERTY layouts.

Keys with the sDLK_EXTENDED_MASK bit set do not map to a scancode or Unicode code point.

Many common keycodes are listed below, but this list is not exhaustive.

See also

SDL_HINT_KEYCODE_OPTIONS

FFI conventions

Unsuffixed aliases are unsafe foreign imports; aliases suffixed Safe are safe. Functions whose callbacks fire during the call export only the Safe alias (the genuine unsafe import stays reachable under SDL3.Sys.Bindgen.Keycode.Unsafe); functions curated unsafe-only export only the unsuffixed one. Each alias's documentation records its flavor and rationale.

Full conventions: SDL3.Sys.

Since: 3.2.0