Scroll to navigation

SDL_GetDefaultScancodeFromKey(3) SDL3 FUNCTIONS SDL_GetDefaultScancodeFromKey(3)

NAME

SDL_GetDefaultScancodeFromKey - Get the scancode corresponding to the given key code according to a default en_US keyboard layout.

HEADER FILE

Defined in SDL3/SDL_keyboard.h

SYNOPSIS

#include "SDL3/SDL.h"
SDL_Scancode SDL_GetDefaultScancodeFromKey(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

the desired SDL_Keycode
to query.
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 .

AVAILABILITY

This function is available since SDL 3.0.0.

SEE ALSO

(3), SDL_GetScancodeFromKey(3), (3), SDL_GetScancodeName(3)

SDL 3.1.2 Simple Directmedia Layer