Struct SDL_Scancode 

#[repr(transparent)]
pub struct SDL_Scancode(pub c_uint);

The SDL keyboard scancode representation.

An SDL scancode is the physical representation of a key on the keyboard, independent of language and keyboard mapping.

Values of this type are used to represent keyboard keys, among other places in the scancode field of the SDL_KeyboardEvent structure.

The values in this enumeration are based on the USB usage page standard: https://usb.org/sites/default/files/hut1_5.pdf

Available Since: This enum is available since SDL 3.2.0.

Tuple Fields

0: c_uint

Implementations

impl SDL_Scancode

pub const SDL_SCANCODE_UNKNOWN: SDL_Scancode

pub const SDL_SCANCODE_A: SDL_Scancode

pub const SDL_SCANCODE_B: SDL_Scancode

pub const SDL_SCANCODE_C: SDL_Scancode

pub const SDL_SCANCODE_D: SDL_Scancode

pub const SDL_SCANCODE_E: SDL_Scancode

pub const SDL_SCANCODE_F: SDL_Scancode

pub const SDL_SCANCODE_G: SDL_Scancode

pub const SDL_SCANCODE_H: SDL_Scancode

pub const SDL_SCANCODE_I: SDL_Scancode

pub const SDL_SCANCODE_J: SDL_Scancode

pub const SDL_SCANCODE_K: SDL_Scancode

pub const SDL_SCANCODE_L: SDL_Scancode

pub const SDL_SCANCODE_M: SDL_Scancode

pub const SDL_SCANCODE_N: SDL_Scancode

pub const SDL_SCANCODE_O: SDL_Scancode

pub const SDL_SCANCODE_P: SDL_Scancode

pub const SDL_SCANCODE_Q: SDL_Scancode

pub const SDL_SCANCODE_R: SDL_Scancode

pub const SDL_SCANCODE_S: SDL_Scancode

pub const SDL_SCANCODE_T: SDL_Scancode

pub const SDL_SCANCODE_U: SDL_Scancode

pub const SDL_SCANCODE_V: SDL_Scancode

pub const SDL_SCANCODE_W: SDL_Scancode

pub const SDL_SCANCODE_X: SDL_Scancode

pub const SDL_SCANCODE_Y: SDL_Scancode

pub const SDL_SCANCODE_Z: SDL_Scancode

pub const SDL_SCANCODE_1: SDL_Scancode

pub const SDL_SCANCODE_2: SDL_Scancode

pub const SDL_SCANCODE_3: SDL_Scancode

pub const SDL_SCANCODE_4: SDL_Scancode

pub const SDL_SCANCODE_5: SDL_Scancode

pub const SDL_SCANCODE_6: SDL_Scancode

pub const SDL_SCANCODE_7: SDL_Scancode

pub const SDL_SCANCODE_8: SDL_Scancode

pub const SDL_SCANCODE_9: SDL_Scancode

pub const SDL_SCANCODE_0: SDL_Scancode

pub const SDL_SCANCODE_RETURN: SDL_Scancode

pub const SDL_SCANCODE_ESCAPE: SDL_Scancode

pub const SDL_SCANCODE_BACKSPACE: SDL_Scancode

pub const SDL_SCANCODE_TAB: SDL_Scancode

pub const SDL_SCANCODE_SPACE: SDL_Scancode

pub const SDL_SCANCODE_MINUS: SDL_Scancode

pub const SDL_SCANCODE_EQUALS: SDL_Scancode

pub const SDL_SCANCODE_LEFTBRACKET: SDL_Scancode

pub const SDL_SCANCODE_RIGHTBRACKET: SDL_Scancode

pub const SDL_SCANCODE_BACKSLASH: SDL_Scancode

< Located at the lower left of the return key on ISO keyboards and at the right end of the QWERTY row on ANSI keyboards. Produces REVERSE SOLIDUS (backslash) and VERTICAL LINE in a US layout, REVERSE SOLIDUS and VERTICAL LINE in a UK Mac layout, NUMBER SIGN and TILDE in a UK Windows layout, DOLLAR SIGN and POUND SIGN in a Swiss German layout, NUMBER SIGN and APOSTROPHE in a German layout, GRAVE ACCENT and POUND SIGN in a French Mac layout, and ASTERISK and MICRO SIGN in a French Windows layout.

pub const SDL_SCANCODE_NONUSHASH: SDL_Scancode

< ISO USB keyboards actually use this code instead of 49 for the same key, but all OSes I’ve seen treat the two codes identically. So, as an implementer, unless your keyboard generates both of those codes and your OS treats them differently, you should generate SDL_SCANCODE_BACKSLASH instead of this code. As a user, you should not rely on this code because SDL will never generate it with most (all?) keyboards.

pub const SDL_SCANCODE_SEMICOLON: SDL_Scancode

pub const SDL_SCANCODE_APOSTROPHE: SDL_Scancode

pub const SDL_SCANCODE_GRAVE: SDL_Scancode

< Located in the top left corner (on both ANSI and ISO keyboards). Produces GRAVE ACCENT and TILDE in a US Windows layout and in US and UK Mac layouts on ANSI keyboards, GRAVE ACCENT and NOT SIGN in a UK Windows layout, SECTION SIGN and PLUS-MINUS SIGN in US and UK Mac layouts on ISO keyboards, SECTION SIGN and DEGREE SIGN in a Swiss German layout (Mac: only on ISO keyboards), CIRCUMFLEX ACCENT and DEGREE SIGN in a German layout (Mac: only on ISO keyboards), SUPERSCRIPT TWO and TILDE in a French Windows layout, COMMERCIAL AT and NUMBER SIGN in a French Mac layout on ISO keyboards, and LESS-THAN SIGN and GREATER-THAN SIGN in a Swiss German, German, or French Mac layout on ANSI keyboards.

pub const SDL_SCANCODE_COMMA: SDL_Scancode

pub const SDL_SCANCODE_PERIOD: SDL_Scancode

pub const SDL_SCANCODE_SLASH: SDL_Scancode

pub const SDL_SCANCODE_CAPSLOCK: SDL_Scancode

pub const SDL_SCANCODE_F1: SDL_Scancode

pub const SDL_SCANCODE_F2: SDL_Scancode

pub const SDL_SCANCODE_F3: SDL_Scancode

pub const SDL_SCANCODE_F4: SDL_Scancode

pub const SDL_SCANCODE_F5: SDL_Scancode

pub const SDL_SCANCODE_F6: SDL_Scancode

pub const SDL_SCANCODE_F7: SDL_Scancode

pub const SDL_SCANCODE_F8: SDL_Scancode

pub const SDL_SCANCODE_F9: SDL_Scancode

pub const SDL_SCANCODE_F10: SDL_Scancode

pub const SDL_SCANCODE_F11: SDL_Scancode

pub const SDL_SCANCODE_F12: SDL_Scancode

pub const SDL_SCANCODE_PRINTSCREEN: SDL_Scancode

pub const SDL_SCANCODE_SCROLLLOCK: SDL_Scancode

pub const SDL_SCANCODE_PAUSE: SDL_Scancode

pub const SDL_SCANCODE_INSERT: SDL_Scancode

< insert on PC, help on some Mac keyboards (but does send code 73, not 117)

pub const SDL_SCANCODE_HOME: SDL_Scancode

pub const SDL_SCANCODE_PAGEUP: SDL_Scancode

pub const SDL_SCANCODE_DELETE: SDL_Scancode

pub const SDL_SCANCODE_END: SDL_Scancode

pub const SDL_SCANCODE_PAGEDOWN: SDL_Scancode

pub const SDL_SCANCODE_RIGHT: SDL_Scancode

pub const SDL_SCANCODE_LEFT: SDL_Scancode

pub const SDL_SCANCODE_DOWN: SDL_Scancode

pub const SDL_SCANCODE_UP: SDL_Scancode

pub const SDL_SCANCODE_NUMLOCKCLEAR: SDL_Scancode

< num lock on PC, clear on Mac keyboards

pub const SDL_SCANCODE_KP_DIVIDE: SDL_Scancode

pub const SDL_SCANCODE_KP_MULTIPLY: SDL_Scancode

pub const SDL_SCANCODE_KP_MINUS: SDL_Scancode

pub const SDL_SCANCODE_KP_PLUS: SDL_Scancode

pub const SDL_SCANCODE_KP_ENTER: SDL_Scancode

pub const SDL_SCANCODE_KP_1: SDL_Scancode

pub const SDL_SCANCODE_KP_2: SDL_Scancode

pub const SDL_SCANCODE_KP_3: SDL_Scancode

pub const SDL_SCANCODE_KP_4: SDL_Scancode

pub const SDL_SCANCODE_KP_5: SDL_Scancode

pub const SDL_SCANCODE_KP_6: SDL_Scancode

pub const SDL_SCANCODE_KP_7: SDL_Scancode

pub const SDL_SCANCODE_KP_8: SDL_Scancode

pub const SDL_SCANCODE_KP_9: SDL_Scancode

pub const SDL_SCANCODE_KP_0: SDL_Scancode

pub const SDL_SCANCODE_KP_PERIOD: SDL_Scancode

pub const SDL_SCANCODE_NONUSBACKSLASH: SDL_Scancode

< This is the additional key that ISO keyboards have over ANSI ones, located between left shift and Z. Produces GRAVE ACCENT and TILDE in a US or UK Mac layout, REVERSE SOLIDUS (backslash) and VERTICAL LINE in a US or UK Windows layout, and LESS-THAN SIGN and GREATER-THAN SIGN in a Swiss German, German, or French layout.

pub const SDL_SCANCODE_APPLICATION: SDL_Scancode

< windows contextual menu, compose

pub const SDL_SCANCODE_POWER: SDL_Scancode

< The USB document says this is a status flag, not a physical key - but some Mac keyboards do have a power key.

pub const SDL_SCANCODE_KP_EQUALS: SDL_Scancode

pub const SDL_SCANCODE_F13: SDL_Scancode

pub const SDL_SCANCODE_F14: SDL_Scancode

pub const SDL_SCANCODE_F15: SDL_Scancode

pub const SDL_SCANCODE_F16: SDL_Scancode

pub const SDL_SCANCODE_F17: SDL_Scancode

pub const SDL_SCANCODE_F18: SDL_Scancode

pub const SDL_SCANCODE_F19: SDL_Scancode

pub const SDL_SCANCODE_F20: SDL_Scancode

pub const SDL_SCANCODE_F21: SDL_Scancode

pub const SDL_SCANCODE_F22: SDL_Scancode

pub const SDL_SCANCODE_F23: SDL_Scancode

pub const SDL_SCANCODE_F24: SDL_Scancode

pub const SDL_SCANCODE_EXECUTE: SDL_Scancode

pub const SDL_SCANCODE_HELP: SDL_Scancode

< AL Integrated Help Center

pub const SDL_SCANCODE_MENU: SDL_Scancode

< Menu (show menu)

pub const SDL_SCANCODE_SELECT: SDL_Scancode

pub const SDL_SCANCODE_STOP: SDL_Scancode

< AC Stop

pub const SDL_SCANCODE_AGAIN: SDL_Scancode

< AC Redo/Repeat

pub const SDL_SCANCODE_UNDO: SDL_Scancode

< AC Undo

pub const SDL_SCANCODE_CUT: SDL_Scancode

< AC Cut

pub const SDL_SCANCODE_COPY: SDL_Scancode

< AC Copy

pub const SDL_SCANCODE_PASTE: SDL_Scancode

< AC Paste

pub const SDL_SCANCODE_FIND: SDL_Scancode

< AC Find

pub const SDL_SCANCODE_MUTE: SDL_Scancode

pub const SDL_SCANCODE_VOLUMEUP: SDL_Scancode

pub const SDL_SCANCODE_VOLUMEDOWN: SDL_Scancode

pub const SDL_SCANCODE_KP_COMMA: SDL_Scancode

pub const SDL_SCANCODE_KP_EQUALSAS400: SDL_Scancode

pub const SDL_SCANCODE_INTERNATIONAL1: SDL_Scancode

< used on Asian keyboards, see footnotes in USB doc

pub const SDL_SCANCODE_INTERNATIONAL2: SDL_Scancode

pub const SDL_SCANCODE_INTERNATIONAL3: SDL_Scancode

< Yen

pub const SDL_SCANCODE_INTERNATIONAL4: SDL_Scancode

pub const SDL_SCANCODE_INTERNATIONAL5: SDL_Scancode

pub const SDL_SCANCODE_INTERNATIONAL6: SDL_Scancode

pub const SDL_SCANCODE_INTERNATIONAL7: SDL_Scancode

pub const SDL_SCANCODE_INTERNATIONAL8: SDL_Scancode

pub const SDL_SCANCODE_INTERNATIONAL9: SDL_Scancode

pub const SDL_SCANCODE_LANG1: SDL_Scancode

< Hangul/English toggle

pub const SDL_SCANCODE_LANG2: SDL_Scancode

< Hanja conversion

pub const SDL_SCANCODE_LANG3: SDL_Scancode

< Katakana

pub const SDL_SCANCODE_LANG4: SDL_Scancode

< Hiragana

pub const SDL_SCANCODE_LANG5: SDL_Scancode

< Zenkaku/Hankaku

pub const SDL_SCANCODE_LANG6: SDL_Scancode

< reserved

pub const SDL_SCANCODE_LANG7: SDL_Scancode

< reserved

pub const SDL_SCANCODE_LANG8: SDL_Scancode

< reserved

pub const SDL_SCANCODE_LANG9: SDL_Scancode

< reserved

pub const SDL_SCANCODE_ALTERASE: SDL_Scancode

< Erase-Eaze

pub const SDL_SCANCODE_SYSREQ: SDL_Scancode

pub const SDL_SCANCODE_CANCEL: SDL_Scancode

< AC Cancel

pub const SDL_SCANCODE_CLEAR: SDL_Scancode

pub const SDL_SCANCODE_PRIOR: SDL_Scancode

pub const SDL_SCANCODE_RETURN2: SDL_Scancode

pub const SDL_SCANCODE_SEPARATOR: SDL_Scancode

pub const SDL_SCANCODE_OUT: SDL_Scancode

pub const SDL_SCANCODE_OPER: SDL_Scancode

pub const SDL_SCANCODE_CLEARAGAIN: SDL_Scancode

pub const SDL_SCANCODE_CRSEL: SDL_Scancode

pub const SDL_SCANCODE_EXSEL: SDL_Scancode

pub const SDL_SCANCODE_KP_00: SDL_Scancode

pub const SDL_SCANCODE_KP_000: SDL_Scancode

pub const SDL_SCANCODE_THOUSANDSSEPARATOR: SDL_Scancode

pub const SDL_SCANCODE_DECIMALSEPARATOR: SDL_Scancode

pub const SDL_SCANCODE_CURRENCYUNIT: SDL_Scancode

pub const SDL_SCANCODE_CURRENCYSUBUNIT: SDL_Scancode

pub const SDL_SCANCODE_KP_LEFTPAREN: SDL_Scancode

pub const SDL_SCANCODE_KP_RIGHTPAREN: SDL_Scancode

pub const SDL_SCANCODE_KP_LEFTBRACE: SDL_Scancode

pub const SDL_SCANCODE_KP_RIGHTBRACE: SDL_Scancode

pub const SDL_SCANCODE_KP_TAB: SDL_Scancode

pub const SDL_SCANCODE_KP_BACKSPACE: SDL_Scancode

pub const SDL_SCANCODE_KP_A: SDL_Scancode

pub const SDL_SCANCODE_KP_B: SDL_Scancode

pub const SDL_SCANCODE_KP_C: SDL_Scancode

pub const SDL_SCANCODE_KP_D: SDL_Scancode

pub const SDL_SCANCODE_KP_E: SDL_Scancode

pub const SDL_SCANCODE_KP_F: SDL_Scancode

pub const SDL_SCANCODE_KP_XOR: SDL_Scancode

pub const SDL_SCANCODE_KP_POWER: SDL_Scancode

pub const SDL_SCANCODE_KP_PERCENT: SDL_Scancode

pub const SDL_SCANCODE_KP_LESS: SDL_Scancode

pub const SDL_SCANCODE_KP_GREATER: SDL_Scancode

pub const SDL_SCANCODE_KP_AMPERSAND: SDL_Scancode

pub const SDL_SCANCODE_KP_DBLAMPERSAND: SDL_Scancode

pub const SDL_SCANCODE_KP_VERTICALBAR: SDL_Scancode

pub const SDL_SCANCODE_KP_DBLVERTICALBAR: SDL_Scancode

pub const SDL_SCANCODE_KP_COLON: SDL_Scancode

pub const SDL_SCANCODE_KP_HASH: SDL_Scancode

pub const SDL_SCANCODE_KP_SPACE: SDL_Scancode

pub const SDL_SCANCODE_KP_AT: SDL_Scancode

pub const SDL_SCANCODE_KP_EXCLAM: SDL_Scancode

pub const SDL_SCANCODE_KP_MEMSTORE: SDL_Scancode

pub const SDL_SCANCODE_KP_MEMRECALL: SDL_Scancode

pub const SDL_SCANCODE_KP_MEMCLEAR: SDL_Scancode

pub const SDL_SCANCODE_KP_MEMADD: SDL_Scancode

pub const SDL_SCANCODE_KP_MEMSUBTRACT: SDL_Scancode

pub const SDL_SCANCODE_KP_MEMMULTIPLY: SDL_Scancode

pub const SDL_SCANCODE_KP_MEMDIVIDE: SDL_Scancode

pub const SDL_SCANCODE_KP_PLUSMINUS: SDL_Scancode

pub const SDL_SCANCODE_KP_CLEAR: SDL_Scancode

pub const SDL_SCANCODE_KP_CLEARENTRY: SDL_Scancode

pub const SDL_SCANCODE_KP_BINARY: SDL_Scancode

pub const SDL_SCANCODE_KP_OCTAL: SDL_Scancode

pub const SDL_SCANCODE_KP_DECIMAL: SDL_Scancode

pub const SDL_SCANCODE_KP_HEXADECIMAL: SDL_Scancode

pub const SDL_SCANCODE_LCTRL: SDL_Scancode

pub const SDL_SCANCODE_LSHIFT: SDL_Scancode

pub const SDL_SCANCODE_LALT: SDL_Scancode

< alt, option

pub const SDL_SCANCODE_LGUI: SDL_Scancode

< windows, command (apple), meta

pub const SDL_SCANCODE_RCTRL: SDL_Scancode

pub const SDL_SCANCODE_RSHIFT: SDL_Scancode

pub const SDL_SCANCODE_RALT: SDL_Scancode

< alt gr, option

pub const SDL_SCANCODE_RGUI: SDL_Scancode

< windows, command (apple), meta

pub const SDL_SCANCODE_MODE: SDL_Scancode

< I’m not sure if this is really not covered by any of the above, but since there’s a special SDL_KMOD_MODE for it I’m adding it here

pub const SDL_SCANCODE_SLEEP: SDL_Scancode

< Sleep

pub const SDL_SCANCODE_WAKE: SDL_Scancode

< Wake

pub const SDL_SCANCODE_CHANNEL_INCREMENT: SDL_Scancode

< Channel Increment

pub const SDL_SCANCODE_CHANNEL_DECREMENT: SDL_Scancode

< Channel Decrement

pub const SDL_SCANCODE_MEDIA_PLAY: SDL_Scancode

< Play

pub const SDL_SCANCODE_MEDIA_PAUSE: SDL_Scancode

< Pause

pub const SDL_SCANCODE_MEDIA_RECORD: SDL_Scancode

< Record

pub const SDL_SCANCODE_MEDIA_FAST_FORWARD: SDL_Scancode

< Fast Forward

pub const SDL_SCANCODE_MEDIA_REWIND: SDL_Scancode

< Rewind

pub const SDL_SCANCODE_MEDIA_NEXT_TRACK: SDL_Scancode

< Next Track

pub const SDL_SCANCODE_MEDIA_PREVIOUS_TRACK: SDL_Scancode

< Previous Track

pub const SDL_SCANCODE_MEDIA_STOP: SDL_Scancode

< Stop

pub const SDL_SCANCODE_MEDIA_EJECT: SDL_Scancode

< Eject

pub const SDL_SCANCODE_MEDIA_PLAY_PAUSE: SDL_Scancode

< Play / Pause

pub const SDL_SCANCODE_MEDIA_SELECT: SDL_Scancode

pub const SDL_SCANCODE_AC_NEW: SDL_Scancode

< AC New

pub const SDL_SCANCODE_AC_OPEN: SDL_Scancode

< AC Open

pub const SDL_SCANCODE_AC_CLOSE: SDL_Scancode

< AC Close

pub const SDL_SCANCODE_AC_EXIT: SDL_Scancode

< AC Exit

pub const SDL_SCANCODE_AC_SAVE: SDL_Scancode

< AC Save

pub const SDL_SCANCODE_AC_PRINT: SDL_Scancode

< AC Print

pub const SDL_SCANCODE_AC_PROPERTIES: SDL_Scancode

< AC Properties

pub const SDL_SCANCODE_AC_SEARCH: SDL_Scancode

< AC Search

pub const SDL_SCANCODE_AC_HOME: SDL_Scancode

< AC Home

pub const SDL_SCANCODE_AC_BACK: SDL_Scancode

< AC Back

pub const SDL_SCANCODE_AC_FORWARD: SDL_Scancode

< AC Forward

pub const SDL_SCANCODE_AC_STOP: SDL_Scancode

< AC Stop

pub const SDL_SCANCODE_AC_REFRESH: SDL_Scancode

< AC Refresh

pub const SDL_SCANCODE_AC_BOOKMARKS: SDL_Scancode

< AC Bookmarks

pub const SDL_SCANCODE_SOFTLEFT: SDL_Scancode

< Usually situated below the display on phones and used as a multi-function feature key for selecting a software defined function shown on the bottom left of the display.

pub const SDL_SCANCODE_SOFTRIGHT: SDL_Scancode

< Usually situated below the display on phones and used as a multi-function feature key for selecting a software defined function shown on the bottom right of the display.

pub const SDL_SCANCODE_CALL: SDL_Scancode

< Used for accepting phone calls.

pub const SDL_SCANCODE_ENDCALL: SDL_Scancode

< Used for rejecting phone calls.

pub const SDL_SCANCODE_RESERVED: SDL_Scancode

< 400-500 reserved for dynamic keycodes

pub const SDL_SCANCODE_COUNT: SDL_Scancode

< not a key, just marks the number of scancodes for array bounds

Trait Implementations

impl Clone for SDL_Scancode

fn clone(&self) -> SDL_Scancode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDL_Scancode

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

Formats the value using the given formatter.

impl Hash for SDL_Scancode

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_Scancode

fn eq(&self, other: &SDL_Scancode) -> 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_Scancode

impl Eq for SDL_Scancode

impl StructuralPartialEq for SDL_Scancode