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


Get the current state of an axis control on a game controller.

Header File

Defined in SDL_gamecontroller.h


SDL_GameControllerGetAxis(SDL_GameController *gamecontroller, SDL_GameControllerAxis axis);

Function Parameters

SDL_GameController * gamecontroller a game controller.
SDL_GameControllerAxis axis an axis index (one of the SDL_GameControllerAxis values).

Return Value

(Sint16) Returns axis state (including 0) on success or 0 (also) on failure; call SDL_GetError() for more information.


The axis indices start at index 0.

For thumbsticks, the state is a value ranging from -32768 (up/left) to 32767 (down/right).

Triggers range from 0 when released to 32767 when fully pressed, and never return a negative value. Note that this differs from the value reported by the lower-level SDL_JoystickGetAxis(), which normally uses the full range.


This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryGameController

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