NAME
SDL2::scancode - Defines Keyboard Scancodes
SYNOPSIS
use SDL2 qw[:scancode];DESCRIPTION
SDL2::scancode defines values of this type are used to represent keyboard keys, among other places in the scancode field of the SDL2::Event structure.
Definitions and Enumerations
The SDL keyboard scancode representation.
SDL_Scancode
The values in this enumeration are based on the USB usage page standard: https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf and may be imported by name or with the :scancode tag.
These values are from usage page 0x07 (USB keyboard page).
SDL_SCANCODE_UNKNOWNSDL_SCANCODE_ASDL_SCANCODE_BSDL_SCANCODE_CSDL_SCANCODE_DSDL_SCANCODE_ESDL_SCANCODE_FSDL_SCANCODE_GSDL_SCANCODE_HSDL_SCANCODE_ISDL_SCANCODE_JSDL_SCANCODE_KSDL_SCANCODE_LSDL_SCANCODE_MSDL_SCANCODE_NSDL_SCANCODE_OSDL_SCANCODE_PSDL_SCANCODE_QSDL_SCANCODE_RSDL_SCANCODE_SSDL_SCANCODE_TSDL_SCANCODE_USDL_SCANCODE_VSDL_SCANCODE_WSDL_SCANCODE_XSDL_SCANCODE_YSDL_SCANCODE_ZSDL_SCANCODE_1SDL_SCANCODE_2SDL_SCANCODE_3SDL_SCANCODE_4SDL_SCANCODE_5SDL_SCANCODE_6SDL_SCANCODE_7SDL_SCANCODE_8SDL_SCANCODE_9SDL_SCANCODE_0SDL_SCANCODE_RETURNSDL_SCANCODE_ESCAPESDL_SCANCODE_BACKSPACESDL_SCANCODE_TABSDL_SCANCODE_SPACESDL_SCANCODE_MINUSSDL_SCANCODE_EQUALSSDL_SCANCODE_LEFTBRACKETSDL_SCANCODE_RIGHTBRACKETSDL_SCANCODE_BACKSLASH-
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.
SDL_SCANCODE_NONUSHASH-
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 implementor, unless your keyboard generates both of those codes and your OS treats them differently, you should generate
SDL_SCANCODE_BACKSLASHinstead of this code. As a user, you should not rely on this code because SDL will never generate it with most (all?) keyboards. SDL_SCANCODE_SEMICOLONSDL_SCANCODE_APOSTROPHESDL_SCANCODE_GRAVE-
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.
SDL_SCANCODE_COMMASDL_SCANCODE_PERIODSDL_SCANCODE_SLASHSDL_SCANCODE_CAPSLOCKSDL_SCANCODE_F1SDL_SCANCODE_F2SDL_SCANCODE_F3SDL_SCANCODE_F4SDL_SCANCODE_F5SDL_SCANCODE_F6SDL_SCANCODE_F7SDL_SCANCODE_F8SDL_SCANCODE_F9SDL_SCANCODE_F10SDL_SCANCODE_F11SDL_SCANCODE_F12SDL_SCANCODE_PRINTSCREENSDL_SCANCODE_SCROLLLOCKSDL_SCANCODE_PAUSESDL_SCANCODE_INSERT-
insert on PC, help on some Mac keyboards (but does send code 73, not 117)
SDL_SCANCODE_HOMESDL_SCANCODE_PAGEUPSDL_SCANCODE_DELETESDL_SCANCODE_ENDSDL_SCANCODE_PAGEDOWNSDL_SCANCODE_RIGHTSDL_SCANCODE_LEFTSDL_SCANCODE_DOWNSDL_SCANCODE_UPSDL_SCANCODE_NUMLOCKCLEAR-
num lock on PC, clear on Mac keyboards
SDL_SCANCODE_KP_DIVIDESDL_SCANCODE_KP_MULTIPLYSDL_SCANCODE_KP_MINUSSDL_SCANCODE_KP_PLUSSDL_SCANCODE_KP_ENTERSDL_SCANCODE_KP_1SDL_SCANCODE_KP_2SDL_SCANCODE_KP_3SDL_SCANCODE_KP_4SDL_SCANCODE_KP_5SDL_SCANCODE_KP_6SDL_SCANCODE_KP_7SDL_SCANCODE_KP_8SDL_SCANCODE_KP_9SDL_SCANCODE_KP_0SDL_SCANCODE_KP_PERIODSDL_SCANCODE_NONUSBACKSLASH-
This is the additional key that ISO keyboards have over ANSI ones, located between left shift and Y. 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.
SDL_SCANCODE_APPLICATION-
windows contextual menu, compose
SDL_SCANCODE_POWER-
The USB document says this is a status flag, not a physical key - but some Mac keyboards do have a power key.
SDL_SCANCODE_KP_EQUALSSDL_SCANCODE_F13SDL_SCANCODE_F14SDL_SCANCODE_F15SDL_SCANCODE_F16SDL_SCANCODE_F17SDL_SCANCODE_F18SDL_SCANCODE_F19SDL_SCANCODE_F20SDL_SCANCODE_F21SDL_SCANCODE_F22SDL_SCANCODE_F23SDL_SCANCODE_F24SDL_SCANCODE_EXECUTESDL_SCANCODE_HELPSDL_SCANCODE_MENUSDL_SCANCODE_SELECTSDL_SCANCODE_STOPSDL_SCANCODE_AGAIN-
redo
SDL_SCANCODE_UNDOSDL_SCANCODE_CUTSDL_SCANCODE_COPYSDL_SCANCODE_PASTESDL_SCANCODE_FINDSDL_SCANCODE_MUTESDL_SCANCODE_VOLUMEUPSDL_SCANCODE_VOLUMEDOWNSDL_SCANCODE_KP_COMMASDL_SCANCODE_KP_EQUALSAS400SDL_SCANCODE_INTERNATIONAL1-
used on Asian keyboards, see footnotes in USB doc
SDL_SCANCODE_INTERNATIONAL2SDL_SCANCODE_INTERNATIONAL3-
Yen
SDL_SCANCODE_INTERNATIONAL4SDL_SCANCODE_INTERNATIONAL5SDL_SCANCODE_INTERNATIONAL6SDL_SCANCODE_INTERNATIONAL7SDL_SCANCODE_INTERNATIONAL8SDL_SCANCODE_INTERNATIONAL9SDL_SCANCODE_LANG1- Hangul/English toggleSDL_SCANCODE_LANG2- Hanja conversionSDL_SCANCODE_LANG3- KatakanaSDL_SCANCODE_LANG4- HiraganaSDL_SCANCODE_LANG5- Zenkaku/HankakuSDL_SCANCODE_LANG6- reservedSDL_SCANCODE_LANG7- reservedSDL_SCANCODE_LANG8- reservedSDL_SCANCODE_LANG9- reservedSDL_SCANCODE_ALTERASE- Erase-EazeSDL_SCANCODE_SYSREQSDL_SCANCODE_CANCELSDL_SCANCODE_CLEARSDL_SCANCODE_PRIORSDL_SCANCODE_RETURN2SDL_SCANCODE_SEPARATORSDL_SCANCODE_OUTSDL_SCANCODE_OPERSDL_SCANCODE_CLEARAGAINSDL_SCANCODE_CRSELSDL_SCANCODE_EXSELSDL_SCANCODE_KP_00SDL_SCANCODE_KP_000SDL_SCANCODE_THOUSANDSSEPARATORSDL_SCANCODE_DECIMALSEPARATORSDL_SCANCODE_CURRENCYUNITSDL_SCANCODE_CURRENCYSUBUNITSDL_SCANCODE_KP_LEFTPARENSDL_SCANCODE_KP_RIGHTPARENSDL_SCANCODE_KP_LEFTBRACESDL_SCANCODE_KP_RIGHTBRACESDL_SCANCODE_KP_TABSDL_SCANCODE_KP_BACKSPACESDL_SCANCODE_KP_ASDL_SCANCODE_KP_BSDL_SCANCODE_KP_CSDL_SCANCODE_KP_DSDL_SCANCODE_KP_ESDL_SCANCODE_KP_FSDL_SCANCODE_KP_XORSDL_SCANCODE_KP_POWERSDL_SCANCODE_KP_PERCENTSDL_SCANCODE_KP_LESSSDL_SCANCODE_KP_GREATERSDL_SCANCODE_KP_AMPERSANDSDL_SCANCODE_KP_DBLAMPERSANDSDL_SCANCODE_KP_VERTICALBARSDL_SCANCODE_KP_DBLVERTICALBARSDL_SCANCODE_KP_COLONSDL_SCANCODE_KP_HASHSDL_SCANCODE_KP_SPACESDL_SCANCODE_KP_ATSDL_SCANCODE_KP_EXCLAMSDL_SCANCODE_KP_MEMSTORESDL_SCANCODE_KP_MEMRECALLSDL_SCANCODE_KP_MEMCLEARSDL_SCANCODE_KP_MEMADDSDL_SCANCODE_KP_MEMSUBTRACTSDL_SCANCODE_KP_MEMMULTIPLYSDL_SCANCODE_KP_MEMDIVIDESDL_SCANCODE_KP_PLUSMINUSSDL_SCANCODE_KP_CLEARSDL_SCANCODE_KP_CLEARENTRYSDL_SCANCODE_KP_BINARYSDL_SCANCODE_KP_OCTALSDL_SCANCODE_KP_DECIMALSDL_SCANCODE_KP_HEXADECIMALSDL_SCANCODE_LCTRLSDL_SCANCODE_LSHIFTSDL_SCANCODE_LALT- alt, optionSDL_SCANCODE_LGUI- windows, command (apple), metaSDL_SCANCODE_RCTRLSDL_SCANCODE_RSHIFTSDL_SCANCODE_RALT- alt gr, optionSDL_SCANCODE_RGUI- windows, command (apple), metaSDL_SCANCODE_MODE-
I'm not sure if this is really not covered by any of the above, but since there's a special KMOD_MODE for it I'm adding it here
These values are mapped from usage page 0x0C (USB consumer page).
SDL_SCANCODE_AUDIONEXTSDL_SCANCODE_AUDIOPREVSDL_SCANCODE_AUDIOSTOPSDL_SCANCODE_AUDIOPLAYSDL_SCANCODE_AUDIOMUTESDL_SCANCODE_MEDIASELECTSDL_SCANCODE_WWWSDL_SCANCODE_MAILSDL_SCANCODE_CALCULATORSDL_SCANCODE_COMPUTERSDL_SCANCODE_AC_SEARCHSDL_SCANCODE_AC_HOMESDL_SCANCODE_AC_BACKSDL_SCANCODE_AC_FORWARDSDL_SCANCODE_AC_STOPSDL_SCANCODE_AC_REFRESHSDL_SCANCODE_AC_BOOKMARKS
These are values that Christian Walther added (for mac keyboard?).
SDL_SCANCODE_BRIGHTNESSDOWNSDL_SCANCODE_BRIGHTNESSUPSDL_SCANCODE_DISPLAYSWITCH- display mirroring/dual display switch, video mode switchSDL_SCANCODE_KBDILLUMTOGGLESDL_SCANCODE_KBDILLUMDOWNSDL_SCANCODE_KBDILLUMUP>SDL_SCANCODE_EJECTSDL_SCANCODE_SLEEPSDL_SCANCODE_APP1SDL_SCANCODE_APP2
These values are mapped from usage page 0x0C (USB consumer page).
SDL_SCANCODE_AUDIOREWINDSDL_SCANCODE_AUDIOFASTFORWARD
Add any other keys here.
SDL_NUM_SCANCODES-
not a key, just marks the number of scancodes for array bounds
LICENSE
Copyright (C) Sanko Robinson.
This library is free software; you can redistribute it and/or modify it under the terms found in the Artistic License 2. Other copyrights, terms, and conditions may apply to data transmitted through this module.
AUTHOR
Sanko Robinson <sanko@cpan.org>