Function SDL_GetJoystickAxisInitialState

pub unsafe extern "C" fn SDL_GetJoystickAxisInitialState(
    joystick: *mut SDL_Joystick,
    axis: i32,
    state: *mut i16,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Get the initial state of an axis control on a joystick.

The state is a value ranging from -32768 to 32767.

The axis indices start at index 0.

§Parameters

  • joystick: an SDL_Joystick structure containing joystick information.
  • axis: the axis to query; the axis indices start at index 0.
  • state: upon return, the initial value is supplied here.

§Return value

Returns true if this axis has any initial value, or false if not.

§Availability

This function is available since SDL 3.2.0.