NAME¶

SDL_GetKeyboards - Get a list of currently connected keyboards.

SYNOPSIS¶

#include <SDL3/SDL_keyboard.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¶

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¶

SDL_GetKeyboardNameForID(3), SDL_HasKeyboard(3)