Man page - sdl_getjoystickplayerindex(3)

Packages contains this manual

Manual

SDL_GetJoystickPlayerIndex

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY
SEE ALSO

NAME

SDL_GetJoystickPlayerIndex - Get the player index of an opened joystick.

HEADER FILE

Defined in SDL3/SDL_joystick.h

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.2.0.

SEE ALSO

• (3), SDL_SetJoystickPlayerIndex (3)