SDL_GetScancodeName - Man Page
Get a human-readable name for a scancode.
Header File
Defined in SDL3/SDL_keyboard.h
Synopsis
#include "SDL3/SDL.h" const char * SDL_GetScancodeName(SDL_Scancode scancode);
Description
Warning : The returned name is by design not stable across platforms, e.g. the name for SDL_SCANCODE_LGUI is "Left GUI" under Linux but "Left Windows" under Microsoft Windows, and some scancodes like SDL_SCANCODE_NONUSBACKSLASH don't have any name at all. There are even scancodes that share names, e.g.
SDL_SCANCODE_RETURN and
SDL_SCANCODE_RETURN2 (both called "Return"). This function is therefore unsuitable for creating a stable cross-platform two-way mapping between strings and scancodes.
Function Parameters
- scancode
the desired SDL_Scancode
to query.
Return Value
Returns a pointer to the name for the scancode. If the scancode doesn't have a name this function returns an empty string ("").
Thread Safety
This function is not thread safe.
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_GetScancodeFromKey(3), ·(3), SDL_GetScancodeFromName(3), ·(3), SDL_SetScancodeName(3)
Referenced By
SDL_GetScancodeFromKey(3), SDL_GetScancodeFromName(3), SDL_SetScancodeName(3).