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

SDL_JoystickGetPlayerIndex

Get the player index of an opened joystick.

Header File

Defined in SDL_joystick.h, but apps should only #include "SDL.h"!

Syntax

int SDL_JoystickGetPlayerIndex(SDL_Joystick *joystick);

Function Parameters

joystick

the SDL_Joystick obtained from SDL_JoystickOpen()

Return Value

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

Remarks

For XInput controllers this returns the XInput user index. Many joysticks will not be able to supply this information.

Version

This function is available since SDL 2.0.9.

---

CategoryAPI, CategoryAPIFunction

---

[ edit | delete | history | feedback | raw ]

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