Man page - sdl_getjoystickplayerindexforid(3)

Packages contains this manual

Manual

SDL_GetJoystickPlayerIndexForID

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

NAME

SDL_GetJoystickPlayerIndexForID - Get the player index of a joystick.

HEADER FILE

Defined in SDL3/SDL_joystick.h

SYNOPSIS

#include "SDL3/SDL.h"

int SDL_GetJoystickPlayerIndexForID(SDL_JoystickID instance_id);

DESCRIPTION

This can be called before any joysticks are opened.

FUNCTION PARAMETERS

instance_id

the joystick instance ID.

RETURN VALUE

Returns the player index of a joystick, or -1 if it’s not available.

AVAILABILITY

This function is available since SDL 3.2.0.

SEE ALSO

β€’ (3), SDL_GetJoystickPlayerIndex (3), β€’ (3), SDL_GetJoysticks (3)