devela::_dep::sdl3::sys::joystick

Function SDL_SetJoystickVirtualAxis

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

Set the state of an axis on an opened virtual joystick.

Please note that values set here will not be applied until the next call to SDL_UpdateJoysticks, which can either be called directly, or can be called indirectly through various other SDL APIs, including, but not limited to the following: [SDL_PollEvent], [SDL_PumpEvents], [SDL_WaitEventTimeout], [SDL_WaitEvent].

Note that when sending trigger axes, you should scale the value to the full range of Sint16. For example, a trigger at rest would have the value of SDL_JOYSTICK_AXIS_MIN.

§Parameters

  • joystick: the virtual joystick on which to set state.
  • axis: the index of the axis on the virtual joystick to update.
  • value: the new value for the specified axis.

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Availability

This function is available since SDL 3.2.0.