SDL_GetScancodeFromKey(3)

SDL_GetScancodeFromKey3

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

Usage

#include "SDL3/SDL.h"

SDL_Scancode SDL_GetScancodeFromKey(SDL_Keycode key, SDL_Keymod *modstate);

Header file

Defined in SDL3/SDL_keyboard.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.