diff options
| author | David Ludwig <dludwig@pobox.com> | 2020-03-15 13:35:03 -0400 |
|---|---|---|
| committer | David Ludwig <dludwig@pobox.com> | 2020-03-15 13:35:03 -0400 |
| commit | 2801bf3f50557ce4d28fd74ba01eceeeb91de2e4 (patch) | |
| tree | d820c859b718fc6fde098b119bac8e16116f1cf3 /include/SDL_joystick.h | |
| parent | 3a0fd6e5a90a317b1d987c0ae5d6550190d5c525 (diff) | |
| download | sdl-2801bf3f50557ce4d28fd74ba01eceeeb91de2e4.tar.gz | |
virtual joysticks: improved docs for SDL_JoystickSetVirtual* functions
Diffstat (limited to 'include/SDL_joystick.h')
| -rw-r--r-- | include/SDL_joystick.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/include/SDL_joystick.h b/include/SDL_joystick.h index c489e4d2d..b638d1cbd 100644 --- a/include/SDL_joystick.h +++ b/include/SDL_joystick.h @@ -222,6 +222,12 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickIsVirtual(int device_index); /** * Set values on an opened, virtual-joystick's controls. + * 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. + * * Returns 0 on success, -1 on error. */ extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualAxis(SDL_Joystick * joystick, int axis, Sint16 value); |