SDL_GetGamepadAxis - Man Page
Get the current state of an axis control on a gamepad.
Synopsis
#include <SDL3/SDL_gamepad.h> Sint16 SDL_GetGamepadAxis(SDL_Gamepad *gamepad, SDL_GamepadAxis axis);
Description
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_GetJoystickAxis(), which normally uses the full range.
Note that for invalid gamepads or axes, this will return 0. Zero is also a valid value in normal operation; usually it means a centered axis.
Function Parameters
- gamepad
a gamepad.
- axis
an axis index (one of the SDL_GamepadAxis values).
Return Value
Returns axis state.
Thread Safety
It is safe to call this function from any thread.
Availability
This function is available since SDL 3.2.0.
See Also
Referenced By
SDL_GamepadHasAxis(3), SDL_GetGamepadButton(3).