Commit 8000e6d9e1af4d2422cc0d18c08bf2353d4ff104

Sam Lantinga 2016-12-27T09:59:36

Added documentation for the game controller axis values

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/SDL_gamecontroller.h b/include/SDL_gamecontroller.h
index 36af08d..1997471 100644
--- a/include/SDL_gamecontroller.h
+++ b/include/SDL_gamecontroller.h
@@ -247,6 +247,12 @@ extern DECLSPEC void SDLCALL SDL_GameControllerUpdate(void);
 
 /**
  *  The list of axes available from a controller
+ *
+ *  Thumbstick axis values range from SDL_JOYSTICK_AXIS_MIN to SDL_JOYSTICK_AXIS_MAX,
+ *  and are centered within ~8000 of zero, though advanced UI will allow users to set
+ *  or autodetect the dead zone, which varies between controllers.
+ *
+ *  Trigger axis values range from 0 to SDL_JOYSTICK_AXIS_MAX.
  */
 typedef enum
 {