SDL_GetGamepadPlayerIndex(3)

SDL_GetGamepadPlayerIndex3

Get the player index of an opened gamepad.

Usage

#include "SDL3/SDL.h"

int SDL_GetGamepadPlayerIndex(SDL_Gamepad *gamepad);

Header file

Defined in SDL3/SDL_gamepad.h

Overview

For XInput gamepads this returns the XInput user index.

Function parameters

gamepad

the gamepad object to query.

Return value

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

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.