(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetJoystickInstancePlayerIndex

Get the player index of a joystick.

Header File

Defined in <SDL3/SDL_joystick.h>

Syntax

int SDL_GetJoystickInstancePlayerIndex(SDL_JoystickID instance_id);

Function Parameters

instance_id the joystick instance ID

Return Value

Returns the player index of a joystick, or -1 if it's not available

Remarks

This can be called before any joysticks are opened.

Version

This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryJoystick