NAME¶

SDL_GetJoystickPlayerIndex - Get the player index of an opened joystick.

SYNOPSIS¶

#include "SDL3/SDL.h"

int SDL_GetJoystickPlayerIndex(SDL_Joystick *joystick);

DESCRIPTION¶

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

FUNCTION PARAMETERS¶

joystick

the SDL_Joystick
obtained from SDL_OpenJoystick ()

RETURN VALUE¶

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

AVAILABILITY¶

This function is available since SDL 3.0.0.

SEE ALSO¶

SDL_SetJoystickPlayerIndex(3)