SDL Wiki
(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)


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


int SDL_JoystickSetVirtualAxis(SDL_Joystick *joystick, int axis, Sint16 value);

Function Parameters


the virtual joystick on which to set state.


the specific axis on the virtual joystick to set.


the new value for the specified axis.

Return Value

Returns 0 on success, -1 on error.


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.


This function is available since SDL 2.0.14.


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.