SDL_GetScancodeFromKey - Man Page

Get the scancode corresponding to the given key code according to the current keyboard layout.

Header File

Defined in SDL3/SDL_keyboard.h

Synopsis

#include "SDL3/SDL.h"

SDL_Scancode SDL_GetScancodeFromKey(SDL_Keycode key, SDL_Keymod *modstate);

Description

Note that there may be multiple scancode+modifier states that can generate this keycode, this will just return the first one found.

Function Parameters

key

the desired SDL_Keycode
to query.

modstate

a pointer to the modifier state that would be used when the scancode generates this key, may be NULL.

Return Value

( SDL_Scancode ) Returns the SDL_Scancode

that corresponds to the given SDL_Keycode .

Thread Safety

This function is not thread safe.

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_GetKeyFromScancode(3), ·(3), SDL_GetScancodeName(3)

Referenced By

SDL_GetKeyFromScancode(3), SDL_GetKeyName(3), SDL_GetScancodeFromName(3), SDL_GetScancodeName(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS