SDL_GetKeyboards(3)

SDL_GetKeyboards3

Get a list of currently connected keyboards.

Usage

#include "SDL3/SDL.h"

SDL_KeyboardID * SDL_GetKeyboards(int *count);

Header file

Defined in SDL3/SDL_keyboard.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.