/
SDL_sysjoystick.h
210 lines (162 loc) · 7.72 KB
1
2
/*
Simple DirectMedia Layer
3
Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
#include "../SDL_internal.h"
23
24
#ifndef SDL_sysjoystick_h_
#define SDL_sysjoystick_h_
25
26
27
28
29
30
31
/* This is the system specific header for the SDL joystick API */
#include "SDL_joystick.h"
#include "SDL_joystick_c.h"
/* The SDL joystick structure */
32
33
typedef struct _SDL_JoystickAxisInfo
{
34
35
Sint16 initial_value; /* Initial axis state */
Sint16 value; /* Current axis state */
36
37
Sint16 zero; /* Zero point on the axis (-32768 for triggers) */
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 */
40
41
} SDL_JoystickAxisInfo;
42
43
44
45
46
47
48
49
50
51
52
53
54
55
typedef struct _SDL_JoystickTouchpadFingerInfo
{
Uint8 state;
float x;
float y;
float pressure;
} SDL_JoystickTouchpadFingerInfo;
typedef struct _SDL_JoystickTouchpadInfo
{
int nfingers;
SDL_JoystickTouchpadFingerInfo *fingers;
} SDL_JoystickTouchpadInfo;
56
57
58
59
60
61
62
typedef struct _SDL_JoystickSensorInfo
{
SDL_SensorType type;
SDL_bool enabled;
float data[3]; /* If this needs to expand, update SDL_ControllerSensorEvent */
} SDL_JoystickSensorInfo;
63
64
65
66
struct _SDL_Joystick
{
SDL_JoystickID instance_id; /* Device instance, monotonically increasing from 0 */
char *name; /* Joystick name - system dependent */
67
char *serial; /* Joystick serial */
68
SDL_JoystickGUID guid; /* Joystick guid */
69
70
int naxes; /* Number of axis controls on the joystick */
71
SDL_JoystickAxisInfo *axes;
72
73
74
75
76
77
78
79
80
81
82
83
84
int nhats; /* Number of hats on the joystick */
Uint8 *hats; /* Current hat states */
int nballs; /* Number of trackballs on the joystick */
struct balldelta {
int dx;
int dy;
} *balls; /* Current ball motion deltas */
int nbuttons; /* Number of buttons on the joystick */
Uint8 *buttons; /* Current button states */
85
86
87
int ntouchpads; /* Number of touchpads on the joystick */
SDL_JoystickTouchpadInfo *touchpads; /* Current touchpad states */
88
89
90
91
int nsensors; /* Number of sensors on the joystick */
int nsensors_enabled;
SDL_JoystickSensorInfo *sensors;
92
93
94
95
Uint16 low_frequency_rumble;
Uint16 high_frequency_rumble;
Uint32 rumble_expiration;
96
97
98
99
Uint16 left_trigger_rumble;
Uint16 right_trigger_rumble;
Uint32 trigger_rumble_expiration;
100
101
102
103
Uint8 led_red;
Uint8 led_green;
Uint8 led_blue;
104
SDL_bool attached;
105
SDL_bool is_game_controller;
106
SDL_bool delayed_guide_button; /* SDL_TRUE if this device has the guide button event delayed */
107
SDL_JoystickPowerLevel epowerlevel; /* power level of this joystick, SDL_JOYSTICK_POWER_UNKNOWN if not supported */
108
109
struct _SDL_JoystickDriver *driver;
110
111
struct joystick_hwdata *hwdata; /* Driver dependent information */
112
113
int ref_count; /* Reference count for multiple opens */
114
115
116
struct _SDL_Joystick *next; /* pointer to next joystick we have allocated */
};
117
118
119
120
/* Device bus definitions */
#define SDL_HARDWARE_BUS_USB 0x03
#define SDL_HARDWARE_BUS_BLUETOOTH 0x05
121
122
123
/* Macro to combine a USB vendor ID and product ID into a single Uint32 value */
#define MAKE_VIDPID(VID, PID) (((Uint32)(VID))<<16|(PID))
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
typedef struct _SDL_JoystickDriver
{
/* Function to scan the system for joysticks.
* Joystick 0 should be the system default joystick.
* This function should return 0, or -1 on an unrecoverable error.
*/
int (*Init)(void);
/* Function to return the number of joystick devices plugged in right now */
int (*GetCount)(void);
/* Function to cause any queued joystick insertions to be processed */
void (*Detect)(void);
/* Function to get the device-dependent name of a joystick */
const char *(*GetDeviceName)(int device_index);
142
143
144
/* Function to get the player index of a joystick */
int (*GetDevicePlayerIndex)(int device_index);
145
146
147
/* Function to get the player index of a joystick */
void (*SetDevicePlayerIndex)(int device_index, int player_index);
148
149
150
151
152
153
154
155
156
157
158
/* Function to return the stable GUID for a plugged in device */
SDL_JoystickGUID (*GetDeviceGUID)(int device_index);
/* Function to get the current instance id of the joystick located at device_index */
SDL_JoystickID (*GetDeviceInstanceID)(int device_index);
/* Function to open a joystick for use.
The joystick to open is specified by the device index.
This should fill the nbuttons and naxes fields of the joystick structure.
It returns 0, or -1 if there is an error.
*/
159
int (*Open)(SDL_Joystick *joystick, int device_index);
160
161
/* Rumble functionality */
162
163
int (*Rumble)(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble);
int (*RumbleTriggers)(SDL_Joystick *joystick, Uint16 left_rumble, Uint16 right_rumble);
164
165
/* LED functionality */
166
167
SDL_bool (*HasLED)(SDL_Joystick *joystick);
int (*SetLED)(SDL_Joystick *joystick, Uint8 red, Uint8 green, Uint8 blue);
168
169
170
171
/* Sensor functionality */
int (*SetSensorsEnabled)(SDL_Joystick *joystick, SDL_bool enabled);
172
173
174
175
176
/* Function to update the state of a joystick - called as a device poll.
* This function shouldn't update the joystick structure directly,
* but instead should call SDL_PrivateJoystick*() to deliver events
* and update joystick device state.
*/
177
void (*Update)(SDL_Joystick *joystick);
178
179
/* Function to close a joystick after use */
180
void (*Close)(SDL_Joystick *joystick);
181
182
183
184
/* Function to perform any system-specific joystick related cleanup */
void (*Quit)(void);
185
186
187
/* Function to get the autodetected controller mapping; returns false if there isn't any. */
SDL_bool (*GetGamepadMapping)(int device_index, SDL_GamepadMapping * out);
188
189
} SDL_JoystickDriver;
190
191
192
/* Windows and Mac OSX has a limit of MAX_DWORD / 1000, Linux kernel has a limit of 0xFFFF */
#define SDL_MAX_RUMBLE_DURATION_MS 0xFFFF
193
194
/* The available joystick drivers */
extern SDL_JoystickDriver SDL_ANDROID_JoystickDriver;
195
extern SDL_JoystickDriver SDL_BSD_JoystickDriver;
196
197
extern SDL_JoystickDriver SDL_DARWIN_JoystickDriver;
extern SDL_JoystickDriver SDL_DUMMY_JoystickDriver;
198
extern SDL_JoystickDriver SDL_EMSCRIPTEN_JoystickDriver;
199
extern SDL_JoystickDriver SDL_HAIKU_JoystickDriver;
200
extern SDL_JoystickDriver SDL_HIDAPI_JoystickDriver;
201
extern SDL_JoystickDriver SDL_RAWINPUT_JoystickDriver;
202
203
extern SDL_JoystickDriver SDL_IOS_JoystickDriver;
extern SDL_JoystickDriver SDL_LINUX_JoystickDriver;
204
extern SDL_JoystickDriver SDL_VIRTUAL_JoystickDriver;
205
extern SDL_JoystickDriver SDL_WGI_JoystickDriver;
206
extern SDL_JoystickDriver SDL_WINDOWS_JoystickDriver;
207
208
#endif /* SDL_sysjoystick_h_ */
209
210
/* vi: set ts=4 sw=4 expandtab: */