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

SDL_SetScancodeName

Set a human-readable name for a scancode.

Header File

Defined in <SDL3/SDL_keyboard.h>

Syntax

SDL_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

(SDL_bool) Returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 3.0.0.

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.