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

SDL_SetJoystickPlayerIndex

Set the player index of an opened joystick.

Header File

Defined in <SDL3/SDL_joystick.h>

Syntax

int SDL_SetJoystickPlayerIndex(SDL_Joystick *joystick, int player_index);

Function Parameters

joystick the SDL_Joystick obtained from SDL_OpenJoystick()
player_index Player index to assign to this joystick, 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, CategoryJoystick