#pragma section-numbers off
#pragma camelcase off
||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||

= SDL_Scancode =
An enumeration of the SDL keyboard scancode representation.

<<TableOfContents()>>

== Values ==
<<Include(SDL_ScancodeAndKeycode, , , from="##Start include here.", to="##End include here.")>>

== Code Examples ==
{{{#!highlight cpp
  /* checks if a key is being remapped and prints what the remapping is */
  if (event->key.keysym.scancode != SDL_GetScancodeFromKey(event->key.keysym.sym)) {
    SDL_Log("Physical %s key acting as %s key",
      SDL_GetScancodeName(event->key.keysym.scancode),
      SDL_GetKeyName(event->key.keysym.sym));
  }
}}}

== Remarks ==
Values of this type are used to represent the physical location of a keyboard key on the keyboard.  This is correlated to the [[SDL_Keycode]] associated with that location to give a key press meaning.

/* These are used in many places, including */ Values of this type are used to represent keyboard keys, among other places in the `SDL_keysym::scancode` `key.keysym.scancode` field of the [[SDL_Event]] structure.

The values in this enumeration are based on the USB usage page standard:
 [[http://www.usb.org/developers/docs/]]

To look up a scancode or keycode by decimal or hexadecimal value you can use the following tables:
 .[[SDLScancodeLookup|SDL Scancode Lookup Table]]
 .[[SDLKeycodeLookup|SDL Keycode Lookup Table]]

== Related Enumerations ==
 .[[SDL_Keycode]]

== Related Functions ==
 .[[SDL_GetKeyboardState]]
 .[[SDL_GetKeyFromScancode]]
 .[[SDL_GetKeyName]]
 .[[SDL_GetScancodeFromKey]]
 .[[SDL_GetScancodeName]]

----
[[CategoryEnum]], [[CategoryKeyboard]]