SDL_GetGamepadPlayerIndex

Get the player index of an opened gamepad.

Header File

Defined in <SDL3/SDL_gamepad.h>

Syntax

int SDL_GetGamepadPlayerIndex(SDL_Gamepad *gamepad);

Function Parameters

SDL_Gamepad * gamepad the gamepad object to query.

Return Value

(int) Returns the player index for gamepad, or -1 if it's not available.

Remarks

For XInput gamepads this returns the XInput user index.

Version

This function is available since SDL 3.2.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryGamepad