SDL_SetScancodeName(3)

SDL_SetScancodeName3

Set a human-readable name for a scancode.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_keyboard.h

Function parameters

scancode

the desired SDL_Scancode .

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

Returns true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

This function is not thread safe.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.