(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetKeyName

Get a human-readable name for a key.

Header File

Defined in <SDL3/SDL_keyboard.h>

Syntax

const char * SDL_GetKeyName(SDL_Keycode key);

Function Parameters

SDL_Keycode

key

the desired SDL_Keycode to query.

Return Value

(const char *) Returns a UTF-8 encoded string of the key name.

Remarks

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

Thread Safety

This function is not thread safe.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetKeyFromName
• SDL_GetKeyFromScancode
• SDL_GetScancodeFromKey

---

CategoryAPI, CategoryAPIFunction, CategoryKeyboard

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.