(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_GameControllerGetPlayerIndex

Get the player index of an opened game controller.

Header File

Defined in SDL_gamecontroller.h

Syntax

int SDL_GameControllerGetPlayerIndex(SDL_GameController *gamecontroller);

Function Parameters

SDL_GameController *

gamecontroller

the game controller object to query.

Return Value

(int) Returns the player index for controller, or -1 if it's not available.

Remarks

For XInput controllers this returns the XInput user index.

Version

This function is available since SDL 2.0.9.

---

CategoryAPI, CategoryAPIFunction, CategoryGameController

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.