devela::_dep::sdl3::sys::gamepad

Function SDL_GetGamepadAxis

pub unsafe extern "C" fn SDL_GetGamepadAxis(
    gamepad: *mut SDL_Gamepad,
    axis: SDL_GamepadAxis,
) -> i16
Available on crate feature dep_sdl3 only.
Expand description

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.

§Parameters

  • gamepad: a gamepad.
  • axis: an axis index (one of the SDL_GamepadAxis values).

§Return value

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

§Availability

This function is available since SDL 3.2.0.

§See also