SDL_SetJoystickPlayerIndex - Man Page

Set the player index of an opened joystick.

Header File

Defined in SDL3/SDL_joystick.h

Synopsis

#include "SDL3/SDL.h"

bool 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 true on success or false on failure; call

SDL_GetError () for more information.

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_GetJoystickPlayerIndex(3)

Referenced By

SDL_GetJoystickFromPlayerIndex(3), SDL_GetJoystickPlayerIndex(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS