getAxis method

int getAxis(int axis)

Get the current state of an axis control on a gamepad.

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.

\param gamepad a gamepad. \param axis an axis index (one of the SDL_GamepadAxis values). \returns axis state (including 0) on success or 0 (also) on failure; call SDL_GetError() for more information.

\since This function is available since SDL 3.1.3.

\sa SDL_GamepadHasAxis \sa SDL_GetGamepadButton

extern SDL_DECLSPEC Sint16 SDLCALL SDL_GetGamepadAxis(SDL_Gamepad *gamepad, SDL_GamepadAxis axis)

Implementation

int getAxis(int axis) {
  return sdlGetGamepadAxis(this, axis);
}