(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetJoystickPlayerIndex

Set the player index of an opened joystick.

Header File

Defined in <SDL3/SDL_joystick.h>

Syntax

bool SDL_SetJoystickPlayerIndex(SDL_Joystick *joystick, int player_index);

Function Parameters

SDL_Joystick *	joystick	the SDL_Joystick obtained from SDL_OpenJoystick().
int	player_index	player index to assign to this joystick, or -1 to clear the player index and turn off player LEDs.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetJoystickPlayerIndex

---

CategoryAPI, CategoryAPIFunction, CategoryJoystick

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.