Commit e4b85091fd0eea25a149af2dd3c2a24f99128baa

Sam Lantinga 2022-08-25T10:15:45

Document the range of trigger axes for virtual joysticks Fixes https://github.com/libsdl-org/SDL/issues/6130

1
2
3
4
5
6
7
8
9
10
11
12
13
diff --git a/include/SDL_joystick.h b/include/SDL_joystick.h
index 1a7c66e..cb7be29 100644
--- a/include/SDL_joystick.h
+++ b/include/SDL_joystick.h
@@ -425,6 +425,8 @@ extern DECLSPEC SDL_bool SDLCALL SDL_JoystickIsVirtual(int device_index);
  * 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`.
+ *
  * \param joystick the virtual joystick on which to set state.
  * \param axis the specific axis on the virtual joystick to set.
  * \param value the new value for the specified axis.