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

SDL_SetGamepadPlayerIndex

Set the player index of an opened gamepad.

Header File

Defined in <SDL3/SDL_gamepad.h>

Syntax

int SDL_SetGamepadPlayerIndex(SDL_Gamepad *gamepad, int player_index);

Function Parameters

gamepad the gamepad object to adjust.
player_index Player index to assign to this gamepad, or -1 to clear the player index and turn off player LEDs.

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryGamepad