SDL_GetJoystickPlayerIndex(3)

SDL_GetJoystickPlayerIndex3

Get the player index of an opened joystick.

Usage

#include "SDL3/SDL.h"

int SDL_GetJoystickPlayerIndex(SDL_Joystick *joystick);

Header file

Defined in SDL3/SDL_joystick.h

Overview

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.