plucky (3) SDL_GetKeyFromName.3.gz

NAME

       SDL_GetKeyFromName - Get a key code from a human-readable name.

HEADER FILE

       Defined in SDL3/SDL_keyboard.h

SYNOPSIS

       #include "SDL3/SDL.h"

       SDL_Keycode SDL_GetKeyFromName(const char *name);

FUNCTION PARAMETERS

       name   the human-readable key name.

RETURN VALUE

       ( SDL_Keycode ) Returns key code, or

        SDLK_UNKNOWN if the name wasn't recognized; call

       SDL_GetError () for more information.

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_GetKeyName(3), •(3), SDL_GetScancodeFromName(3)