table of contents
- experimental 3.1.0+ds-1
SDL_SetJoystickVirtualAxis(3) | SDL3 FUNCTIONS | SDL_SetJoystickVirtualAxis(3) |
NAME¶
SDL_SetJoystickVirtualAxis - Set values on an opened, virtual-joystick's axis.
SYNOPSIS¶
#include "SDL3/SDL.h"
int 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¶
RETURN VALUE¶
Returns 0 on success or a negative error code on failure; call
SDL_GetError () for more information.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SDL 3.1.0 | SDL |