SDL_GetJoystickPlayerIndex

Get the player index of an opened joystick.

Header File

Defined in <SDL3/SDL_joystick.h>

Syntax

int SDL_GetJoystickPlayerIndex(SDL_Joystick *joystick);

Function Parameters

SDL_Joystick *

joystick

the SDL_Joystick obtained from SDL_OpenJoystick().

Return Value

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

Remarks

For XInput controllers this returns the XInput user index. Many joysticks will not be able to supply this information.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.2.0.

See Also

• SDL_SetJoystickPlayerIndex

---

CategoryAPI, CategoryAPIFunction, CategoryJoystick

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