SDL_GetKeyFromScancode - Man Page
Get the key code corresponding to the given scancode according to the current keyboard layout.
Header File
Defined in SDL3/SDL_keyboard.h
Synopsis
#include "SDL3/SDL.h" SDL_Keycode SDL_GetKeyFromScancode(SDL_Scancode scancode, SDL_Keymod modstate, bool key_event);
Description
If you want to get the keycode as it would be delivered in key events, including options specified in
SDL_HINT_KEYCODE_OPTIONS , then you should pass key_event as true. Otherwise this function simply translates the scancode based on the given modifier state.
Function Parameters
- scancode
the desired SDL_Scancode
to query.- modstate
the modifier state to use when translating the scancode to a keycode.
- key_event
true if the keycode will be used in key events.
Return Value
( SDL_Keycode ) Returns the SDL_Keycode
that corresponds to the given SDL_Scancode .
Thread Safety
This function is not thread safe.
Availability
This function is available since SDL 3.2.0.
See Also
·(3), SDL_GetKeyName(3), ·(3), SDL_GetScancodeFromKey(3)
Referenced By
SDL_GetKeyFromName(3), SDL_GetKeyName(3), SDL_GetScancodeFromKey(3), SDL_KeyboardEvent.3type(3).