SDL_SetJoystickVirtualAxis - Man Page
Set the state of an axis on an opened virtual joystick.
Synopsis
#include <SDL3/SDL_joystick.h> bool SDL_SetJoystickVirtualAxis(SDL_Joystick *joystick, int axis, Sint16 value);
Description
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.
Function 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.
Thread Safety
It is safe to call this function from any thread.
Availability
This function is available since SDL 3.2.0.
See Also
SDL_SetJoystickVirtualButton(3), SDL_SetJoystickVirtualBall(3), SDL_SetJoystickVirtualHat(3), SDL_SetJoystickVirtualTouchpad(3), SDL_SetJoystickVirtualSensorData(3)
Referenced By
SDL_AttachVirtualJoystick(3), SDL_SendJoystickVirtualSensorData(3), SDL_SetJoystickVirtualBall(3), SDL_SetJoystickVirtualButton(3), SDL_SetJoystickVirtualHat(3), SDL_SetJoystickVirtualTouchpad(3).