SDL_GetKeyboards - Man Page
Get a list of currently connected keyboards.
Header File
Defined in SDL3/SDL_keyboard.h
Synopsis
#include "SDL3/SDL.h" SDL_KeyboardID * SDL_GetKeyboards(int *count);
Description
Note that this will include any device or virtual driver that includes keyboard functionality, including some mice, KVM switches, motherboard power buttons, etc. You should wait for input from a device before you consider it actively in use.
Function Parameters
- count
a pointer filled in with the number of keyboards returned, may be NULL.
Return Value
( SDL_KeyboardID
*) Returns a 0 terminated array of keyboards instance IDs or NULL on failure; call
SDL_GetError () for more information. This should be freed with SDL_free () when it is no longer needed.
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_GetKeyboardNameForID(3), ·(3), SDL_HasKeyboard(3)
Referenced By
SDL_GetKeyboardNameForID(3), SDL_HasKeyboard(3).