From d64761558ccffb2dcf77cc2b7f67203402ee92b7 Mon Sep 17 00:00:00 2001 From: David Ludwig Date: Sun, 15 Mar 2020 13:35:03 -0400 Subject: [PATCH] virtual joysticks: improved docs for SDL_JoystickSetVirtual* functions --- include/SDL_joystick.h | 6 ++++++ 1 file changed, 6 insertions(+) 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);