SDL  2.0
SDL_sysjoystick.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2020 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 has_second_value; /* Whether we've seen a second value on the axis yet */
39  SDL_bool sent_initial_value; /* Whether we've sent the initial axis value */
41 
43 {
44  SDL_JoystickID instance_id; /* Device instance, monotonically increasing from 0 */
45  char *name; /* Joystick name - system dependent */
46  SDL_JoystickGUID guid; /* Joystick guid */
47 
48  int naxes; /* Number of axis controls on the joystick */
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 
66 
69  SDL_bool delayed_guide_button; /* SDL_TRUE if this device has the guide button event delayed */
70  SDL_bool force_recentering; /* SDL_TRUE if this device needs to have its state reset to 0 */
71  SDL_JoystickPowerLevel epowerlevel; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
72  struct _SDL_JoystickDriver *driver;
73 
74  struct joystick_hwdata *hwdata; /* Driver dependent information */
75 
76  int ref_count; /* Reference count for multiple opens */
77 
78  struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
79 };
80 
81 /* Device bus definitions */
82 #define SDL_HARDWARE_BUS_USB 0x03
83 #define SDL_HARDWARE_BUS_BLUETOOTH 0x05
84 
85 /* Macro to combine a USB vendor ID and product ID into a single Uint32 value */
86 #define MAKE_VIDPID(VID, PID) (((Uint32)(VID))<<16|(PID))
87 
88 typedef struct _SDL_JoystickDriver
89 {
90  /* Function to scan the system for joysticks.
91  * Joystick 0 should be the system default joystick.
92  * This function should return 0, or -1 on an unrecoverable error.
93  */
94  int (*Init)(void);
95 
96  /* Function to return the number of joystick devices plugged in right now */
97  int (*GetCount)(void);
98 
99  /* Function to cause any queued joystick insertions to be processed */
100  void (*Detect)(void);
101 
102  /* Function to get the device-dependent name of a joystick */
103  const char *(*GetDeviceName)(int device_index);
104 
105  /* Function to get the player index of a joystick */
106  int (*GetDevicePlayerIndex)(int device_index);
107 
108  /* Function to get the player index of a joystick */
109  void (*SetDevicePlayerIndex)(int device_index, int player_index);
110 
111  /* Function to return the stable GUID for a plugged in device */
112  SDL_JoystickGUID (*GetDeviceGUID)(int device_index);
113 
114  /* Function to get the current instance id of the joystick located at device_index */
115  SDL_JoystickID (*GetDeviceInstanceID)(int device_index);
116 
117  /* Function to open a joystick for use.
118  The joystick to open is specified by the device index.
119  This should fill the nbuttons and naxes fields of the joystick structure.
120  It returns 0, or -1 if there is an error.
121  */
122  int (*Open)(SDL_Joystick * joystick, int device_index);
123 
124  /* Rumble functionality */
125  int (*Rumble)(SDL_Joystick * joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble);
126 
127  /* Function to update the state of a joystick - called as a device poll.
128  * This function shouldn't update the joystick structure directly,
129  * but instead should call SDL_PrivateJoystick*() to deliver events
130  * and update joystick device state.
131  */
132  void (*Update)(SDL_Joystick * joystick);
133 
134  /* Function to close a joystick after use */
135  void (*Close)(SDL_Joystick * joystick);
136 
137  /* Function to perform any system-specific joystick related cleanup */
138  void (*Quit)(void);
139 
141 
142 /* Windows and Mac OSX has a limit of MAX_DWORD / 1000, Linux kernel has a limit of 0xFFFF */
143 #define SDL_MAX_RUMBLE_DURATION_MS 0xFFFF
144 
145 /* The available joystick drivers */
156 
157 #endif /* SDL_sysjoystick_h_ */
158 
159 /* vi: set ts=4 sw=4 expandtab: */
Uint8
uint8_t Uint8
Definition: SDL_stdinc.h:179
_SDL_Joystick::balldelta::dx
int dx
Definition: SDL_sysjoystick.h:56
Uint16
uint16_t Uint16
Definition: SDL_stdinc.h:191
_SDL_Joystick::buttons
Uint8 * buttons
Definition: SDL_sysjoystick.h:61
_SDL_Joystick::hwdata
struct joystick_hwdata * hwdata
Definition: SDL_sysjoystick.h:74
SDL_joystick_c.h
_SDL_Joystick::ref_count
int ref_count
Definition: SDL_sysjoystick.h:76
SDL_joystick.h
SDL_JoystickID
Sint32 SDL_JoystickID
Definition: SDL_joystick.h:81
SDL_BSD_JoystickDriver
SDL_JoystickDriver SDL_BSD_JoystickDriver
_SDL_Joystick::nballs
int nballs
Definition: SDL_sysjoystick.h:54
SDL_JoystickPowerLevel
SDL_JoystickPowerLevel
Definition: SDL_joystick.h:98
_SDL_Joystick::axes
SDL_JoystickAxisInfo * axes
Definition: SDL_sysjoystick.h:49
_SDL_Joystick::guid
SDL_JoystickGUID guid
Definition: SDL_sysjoystick.h:46
_SDL_Joystick::nbuttons
int nbuttons
Definition: SDL_sysjoystick.h:60
_SDL_Joystick::epowerlevel
SDL_JoystickPowerLevel epowerlevel
Definition: SDL_sysjoystick.h:71
_SDL_Joystick::balls
struct _SDL_Joystick::balldelta * balls
Uint32
uint32_t Uint32
Definition: SDL_stdinc.h:203
_SDL_Joystick::naxes
int naxes
Definition: SDL_sysjoystick.h:48
_SDL_Joystick::attached
SDL_bool attached
Definition: SDL_sysjoystick.h:67
SDL_JoystickAxisInfo::has_initial_value
SDL_bool has_initial_value
Definition: SDL_sysjoystick.h:37
_SDL_Joystick::force_recentering
SDL_bool force_recentering
Definition: SDL_sysjoystick.h:70
Sint16
int16_t Sint16
Definition: SDL_stdinc.h:185
_SDL_Joystick
Definition: SDL_sysjoystick.h:43
SDL_HAIKU_JoystickDriver
SDL_JoystickDriver SDL_HAIKU_JoystickDriver
SDL_DARWIN_JoystickDriver
SDL_JoystickDriver SDL_DARWIN_JoystickDriver
_SDL_Joystick::is_game_controller
SDL_bool is_game_controller
Definition: SDL_sysjoystick.h:68
SDL_JoystickAxisInfo
Definition: SDL_sysjoystick.h:33
_SDL_Joystick::low_frequency_rumble
Uint16 low_frequency_rumble
Definition: SDL_sysjoystick.h:63
SDL_DUMMY_JoystickDriver
SDL_JoystickDriver SDL_DUMMY_JoystickDriver
SDL_JoystickAxisInfo::value
Sint16 value
Definition: SDL_sysjoystick.h:35
_SDL_Joystick::rumble_expiration
Uint32 rumble_expiration
Definition: SDL_sysjoystick.h:65
SDL_WINDOWS_JoystickDriver
SDL_JoystickDriver SDL_WINDOWS_JoystickDriver
SDL_JoystickDriver
Definition: SDL_sysjoystick.h:89
_SDL_Joystick::instance_id
SDL_JoystickID instance_id
Definition: SDL_sysjoystick.h:44
_SDL_Joystick::balldelta
Definition: SDL_sysjoystick.h:55
SDL_JoystickAxisInfo::initial_value
Sint16 initial_value
Definition: SDL_sysjoystick.h:34
SDL_IOS_JoystickDriver
SDL_JoystickDriver SDL_IOS_JoystickDriver
Definition: SDL_sysjoystick.m:846
_SDL_Joystick::nhats
int nhats
Definition: SDL_sysjoystick.h:51
SDL_JoystickAxisInfo::sent_initial_value
SDL_bool sent_initial_value
Definition: SDL_sysjoystick.h:39
SDL_JoystickAxisInfo::zero
Sint16 zero
Definition: SDL_sysjoystick.h:36
_SDL_Joystick::name
char * name
Definition: SDL_sysjoystick.h:45
_SDL_Joystick::delayed_guide_button
SDL_bool delayed_guide_button
Definition: SDL_sysjoystick.h:69
_SDL_Joystick::driver
struct _SDL_JoystickDriver * driver
Definition: SDL_sysjoystick.h:72
SDL_LINUX_JoystickDriver
SDL_JoystickDriver SDL_LINUX_JoystickDriver
_SDL_Joystick::balldelta::dy
int dy
Definition: SDL_sysjoystick.h:57
SDL_bool
SDL_bool
Definition: SDL_stdinc.h:162
SDL_JoystickAxisInfo::has_second_value
SDL_bool has_second_value
Definition: SDL_sysjoystick.h:38
_SDL_Joystick::next
struct _SDL_Joystick * next
Definition: SDL_sysjoystick.h:78
_SDL_Joystick::hats
Uint8 * hats
Definition: SDL_sysjoystick.h:52
void
SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char int SDL_PRINTF_FORMAT_STRING const char const char SDL_SCANF_FORMAT_STRING const char return SDL_ThreadFunction const char void return Uint32 return Uint32 void
Definition: SDL_dynapi_procs.h:89
SDL_JoystickGUID
Definition: SDL_joystick.h:70
SDL_EMSCRIPTEN_JoystickDriver
SDL_JoystickDriver SDL_EMSCRIPTEN_JoystickDriver
SDL_HIDAPI_JoystickDriver
SDL_JoystickDriver SDL_HIDAPI_JoystickDriver
joystick_hwdata
Definition: SDL_sysjoystick_c.h:47
SDL_ANDROID_JoystickDriver
SDL_JoystickDriver SDL_ANDROID_JoystickDriver
_SDL_Joystick::high_frequency_rumble
Uint16 high_frequency_rumble
Definition: SDL_sysjoystick.h:64