Scroll to navigation

SDL_GetKeyName(3) SDL3 FUNCTIONS SDL_GetKeyName(3)

NAME

SDL_GetKeyName - Get a human-readable name for a key.

HEADER FILE

Defined in SDL3/SDL_keyboard.h

SYNOPSIS

#include "SDL3/SDL.h"
const char * SDL_GetKeyName(SDL_Keycode key);

DESCRIPTION

If the key doesn't have a name, this function returns an empty string ("").

FUNCTION PARAMETERS

the desired SDL_Keycode
to query.

RETURN VALUE

Returns a UTF-8 encoded string of the key name.

AVAILABILITY

This function is available since SDL 3.1.3.

SEE ALSO

(3), SDL_GetKeyFromName(3), (3), SDL_GetKeyFromScancode(3), (3), SDL_GetScancodeFromKey(3)

SDL 3.1.6 Simple Directmedia Layer