plucky (3) SDL_GetKeyboardNameForID.3.gz

Provided by: libsdl3-doc_3.2.4+ds-2_all bug

NAME

       SDL_GetKeyboardNameForID - Get the name of a keyboard.

HEADER FILE

       Defined in SDL3/SDL_keyboard.h

SYNOPSIS

       #include "SDL3/SDL.h"

       const char * SDL_GetKeyboardNameForID(SDL_KeyboardID instance_id);

DESCRIPTION

       This function returns "" if the keyboard doesn't have a name.

FUNCTION PARAMETERS

       instance_id
              the keyboard instance ID.

RETURN VALUE

       Returns the name of the selected keyboard or NULL on failure; call SDL_GetError () for more information.

THREAD SAFETY

       This function should only be called on the main thread.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

       (3), SDL_GetKeyboards(3)