SDL  2.0
SDL_sysjoystick.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2018 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 #include "../SDL_internal.h"
22 
23 #ifndef SDL_sysjoystick_h_
24 #define SDL_sysjoystick_h_
25 
26 /* This is the system specific header for the SDL joystick API */
27 
28 #include "SDL_joystick.h"
29 #include "SDL_joystick_c.h"
30 
31 /* The SDL joystick structure */
32 typedef struct _SDL_JoystickAxisInfo
33 {
34  Sint16 initial_value; /* Initial axis state */
35  Sint16 value; /* Current axis state */
36  Sint16 zero; /* Zero point on the axis (-32768 for triggers) */
37  SDL_bool has_initial_value; /* Whether we've seen a value on the axis yet */
38  SDL_bool sent_initial_value; /* Whether we've sent the initial axis value */
39 } SDL_JoystickAxisInfo;
40 
41 struct _SDL_Joystick
42 {
43  SDL_JoystickID instance_id; /* Device instance, monotonically increasing from 0 */
44  char *name; /* Joystick name - system dependent */
45  int player_index; /* Joystick player index, or -1 if unavailable */
46  SDL_JoystickGUID guid; /* Joystick guid */
47 
48  int naxes; /* Number of axis controls on the joystick */
49  SDL_JoystickAxisInfo *axes;
50 
51  int nhats; /* Number of hats on the joystick */
52  Uint8 *hats; /* Current hat states */
53 
54  int nballs; /* Number of trackballs on the joystick */
55  struct balldelta {
56  int dx;
57  int dy;
58  } *balls; /* Current ball motion deltas */
59 
60  int nbuttons; /* Number of buttons on the joystick */
61  Uint8 *buttons; /* Current button states */
62 
63  SDL_bool attached;
64  SDL_bool is_game_controller;
65  SDL_bool delayed_guide_button; /* SDL_TRUE if this device has the guide button event delayed */
66  SDL_bool force_recentering; /* SDL_TRUE if this device needs to have its state reset to 0 */
67  SDL_JoystickPowerLevel epowerlevel; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
68  struct _SDL_JoystickDriver *driver;
69 
70  struct joystick_hwdata *hwdata; /* Driver dependent information */
71 
72  int ref_count; /* Reference count for multiple opens */
73 
74  struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
75 };
76 
77 #if defined(__IPHONEOS__) || defined(__ANDROID__)
78 #define HAVE_STEAMCONTROLLERS
79 #define USE_STEAMCONTROLLER_HIDAPI
80 #elif defined(__LINUX__)
81 #define HAVE_STEAMCONTROLLERS
82 #define USE_STEAMCONTROLLER_LINUX
83 #endif
84 
85 /* Device bus definitions */
86 #define SDL_HARDWARE_BUS_USB 0x03
87 #define SDL_HARDWARE_BUS_BLUETOOTH 0x05
88 
89 /* Macro to combine a USB vendor ID and product ID into a single Uint32 value */
90 #define MAKE_VIDPID(VID, PID) (((Uint32)(VID))<<16|(PID))
91 
92 typedef struct _SDL_JoystickDriver
93 {
94  /* Function to scan the system for joysticks.
95  * Joystick 0 should be the system default joystick.
96  * This function should return 0, or -1 on an unrecoverable error.
97  */
98  int (*Init)(void);
99 
100  /* Function to return the number of joystick devices plugged in right now */
101  int (*GetCount)(void);
102 
103  /* Function to cause any queued joystick insertions to be processed */
104  void (*Detect)(void);
105 
106  /* Function to get the device-dependent name of a joystick */
107  const char *(*GetDeviceName)(int device_index);
108 
109  /* Function to get the player index of a joystick */
110  int (*GetDevicePlayerIndex)(int device_index);
111 
112  /* Function to return the stable GUID for a plugged in device */
113  SDL_JoystickGUID (*GetDeviceGUID)(int device_index);
114 
115  /* Function to get the current instance id of the joystick located at device_index */
116  SDL_JoystickID (*GetDeviceInstanceID)(int device_index);
117 
118  /* Function to open a joystick for use.
119  The joystick to open is specified by the device index.
120  This should fill the nbuttons and naxes fields of the joystick structure.
121  It returns 0, or -1 if there is an error.
122  */
123  int (*Open)(SDL_Joystick * joystick, int device_index);
124 
125  /* Rumble functionality */
126  int (*Rumble)(SDL_Joystick * joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
127 
128  /* Function to update the state of a joystick - called as a device poll.
129  * This function shouldn't update the joystick structure directly,
130  * but instead should call SDL_PrivateJoystick*() to deliver events
131  * and update joystick device state.
132  */
133  void (*Update)(SDL_Joystick * joystick);
134 
135  /* Function to close a joystick after use */
136  void (*Close)(SDL_Joystick * joystick);
137 
138  /* Function to perform any system-specific joystick related cleanup */
139  void (*Quit)(void);
140 
141 } SDL_JoystickDriver;
142 
143 /* The available joystick drivers */
144 extern SDL_JoystickDriver SDL_ANDROID_JoystickDriver;
145 extern SDL_JoystickDriver SDL_BSD_JoystickDriver;
146 extern SDL_JoystickDriver SDL_DARWIN_JoystickDriver;
147 extern SDL_JoystickDriver SDL_DUMMY_JoystickDriver;
148 extern SDL_JoystickDriver SDL_EMSCRIPTEN_JoystickDriver;
149 extern SDL_JoystickDriver SDL_HAIKU_JoystickDriver;
150 extern SDL_JoystickDriver SDL_HIDAPI_JoystickDriver;
151 extern SDL_JoystickDriver SDL_IOS_JoystickDriver;
152 extern SDL_JoystickDriver SDL_LINUX_JoystickDriver;
153 extern SDL_JoystickDriver SDL_WINDOWS_JoystickDriver;
154 
155 #endif /* SDL_sysjoystick_h_ */
156 
157 /* vi: set ts=4 sw=4 expandtab: */