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

SDL_GameControllerGetJoystick

Get the Joystick ID from a Game Controller.

Header File

Defined in SDL_gamecontroller.h

Syntax

SDL_Joystick* SDL_GameControllerGetJoystick(SDL_GameController *gamecontroller);

Function Parameters

SDL_GameController *

gamecontroller

the game controller object that you want to get a joystick from.

Return Value

(SDL_Joystick *) Returns a SDL_Joystick object; call SDL_GetError() for more information.

Remarks

This function will give you a SDL_Joystick object, which allows you to use the SDL_Joystick functions with a SDL_GameController object. This would be useful for getting a joystick's position at any given time, even if it hasn't moved (moving it would produce an event, which would have the axis' value).

The pointer returned is owned by the SDL_GameController. You should not call SDL_JoystickClose() on it, for example, since doing so will likely cause SDL to crash.

Version

This function is available since SDL 2.0.0.

---

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.