devela::_dep::sdl3::sys::keyboard

Function SDL_GetScancodeName

pub unsafe extern "C" fn SDL_GetScancodeName(
    scancode: SDL_Scancode,
) -> *const i8
Available on crate feature dep_sdl3 only.
Expand description

Get a human-readable name for a scancode.

Warning: The returned name is by design not stable across platforms, e.g. the name for SDL_SCANCODE_LGUI is “Left GUI” under Linux but “Left Windows” under Microsoft Windows, and some scancodes like SDL_SCANCODE_NONUSBACKSLASH don’t have any name at all. There are even scancodes that share names, e.g. SDL_SCANCODE_RETURN and SDL_SCANCODE_RETURN2 (both called “Return”). This function is therefore unsuitable for creating a stable cross-platform two-way mapping between strings and scancodes.

§Parameters

§Return value

Returns a pointer to the name for the scancode. If the scancode doesn’t have a name this function returns an empty string (“”).

§Thread safety

This function is not thread safe.

§Availability

This function is available since SDL 3.2.0.

§See also