Function sdl2_sys::SDL_GetKeyName

source ·

pub unsafe extern "C" fn SDL_GetKeyName(
    key: SDL_Keycode
) -> *const c_char

Expand description

Get a human-readable name for a key.

See SDL_Scancode and SDL_Keycode for details.

\param key the desired SDL_Keycode to query \returns a pointer to a UTF-8 string that stays valid at least until the next call to this function. If you need it around any longer, you must copy it. If the key doesn’t have a name, this function returns an empty string (“”).

\since This function is available since SDL 2.0.0.

\sa SDL_GetKeyFromName \sa SDL_GetKeyFromScancode \sa SDL_GetScancodeFromKey