(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

Draft

THIS PAGE IS A WORK IN PROGRESS ... Please make edits to this page to improve it!

SDL_GetKeyName

Get a human-readable name for a key.

Header File

Syntax

const char* SDL_GetKeyName(SDL_Keycode key);

Function Parameters

key

the desired SDL_Keycode to query

Return Value

Returns a pointer to a UTF-8 string that stays valid at least until the next call to this function. If you need it around any longer, you must copy it. If the key doesn't have a name, this function returns an empty string ("").

Remarks

See SDL_Scancode and SDL_Keycode for details.

Version

This function is available since SDL 3.0.0.