SDL_GetScancodeName(3)

Usage

#include "SDL3/SDL.h"

const char * SDL_GetScancodeName(SDL_Scancode scancode);

Header file

Defined in SDL3/SDL_keyboard.h

Overview

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.

Referred to by

SDL_SetScancodeName(3) Set a human-readable name for a scancode. SDL_GetScancodeFromKey(3) Get the scancode corresponding to the given key code according to the current keyboard layout. SDL_GetScancodeFromName(3) Get a scancode from a human-readable name.