SDL_GetJoysticks

Get a list of currently connected joysticks.

Header File

Syntax

SDL_JoystickID * SDL_GetJoysticks(int *count);

Function Parameters

int *

count

a pointer filled in with the number of joysticks returned, may be NULL.

Return Value

(SDL_JoystickID *) Returns a 0 terminated array of joystick 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

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.