(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_GetKeyFromName

Get a key code from a human-readable name.

Header File

Defined in SDL_keyboard.h

Syntax

SDL_Keycode SDL_GetKeyFromName(const char *name);

Function Parameters

name the human-readable key name

Return Value

Returns key code, or SDLK_UNKNOWN if the name wasn't recognized; call SDL_GetError() for more information.

Version

This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryKeyboard