Function sdl2_sys::SDL_JoystickSetVirtualAxis

source · 
pub unsafe extern "C" fn SDL_JoystickSetVirtualAxis(
    joystick: *mut SDL_Joystick,
    axis: c_int,
    value: Sint16,
) -> c_int
Expand description

Set values on an opened, virtual-joystick’s axis.

Please note that values set here will not be applied until the next call to SDL_JoystickUpdate, 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.

\param joystick the virtual joystick on which to set state. \param axis the specific axis on the virtual joystick to set. \param value the new value for the specified axis. \returns 0 on success, -1 on error.

\since This function is available since SDL 2.0.14.