virtual joysticks: improved docs for SDL_JoystickSetVirtual* functions
authorDavid Ludwig <dludwig@pobox.com>
Sun, 15 Mar 2020 13:35:03 -0400
changeset 13627c88387a1e0e2
parent 13626 4377c59b636e
child 13628 a9723f168294
virtual joysticks: improved docs for SDL_JoystickSetVirtual* functions
include/SDL_joystick.h
     1.1 --- a/include/SDL_joystick.h	Sun Mar 15 13:25:49 2020 -0400
     1.2 +++ b/include/SDL_joystick.h	Sun Mar 15 13:35:03 2020 -0400
     1.3 @@ -222,6 +222,12 @@
     1.4  
     1.5  /**
     1.6   * Set values on an opened, virtual-joystick's controls.
     1.7 + * Please note that values set here will not be applied until the next
     1.8 + * call to SDL_JoystickUpdate, which can either be called directly,
     1.9 + * or can be called indirectly through various other SDL APIS,
    1.10 + * including, but not limited to the following: SDL_PollEvent,
    1.11 + * SDL_PumpEvents, SDL_WaitEventTimeout, SDL_WaitEvent.
    1.12 + * 
    1.13   * Returns 0 on success, -1 on error.
    1.14   */
    1.15  extern DECLSPEC int SDLCALL SDL_JoystickSetVirtualAxis(SDL_Joystick * joystick, int axis, Sint16 value);