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

SDL_SetScancodeName

Set a human-readable name for a scancode.

Header File

Defined in <SDL3/SDL_keyboard.h>

Syntax

bool SDL_SetScancodeName(SDL_Scancode scancode, const char *name);

Function Parameters

SDL_Scancode	scancode	the desired SDL_Scancode.
const char *	name	the name to use for the scancode, encoded as UTF-8. The string is not copied, so the pointer given to this function must stay valid while SDL is being used.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Thread Safety

This function is not thread safe.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetScancodeName

---

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.