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
22/**
23 * \file SDL_joystick.h
24 *
25 * Include file for SDL joystick event handling
26 *
27 * The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks(), with the exact joystick
28 * behind a device_index changing as joysticks are plugged and unplugged.
29 *
30 * The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
31 * then it will get a new instance_id, instance_id's are monotonically increasing identifiers of a joystick plugged in.
32 *
33 * The term JoystickGUID is a stable 128-bit identifier for a joystick device that does not change over time, it identifies class of
34 * the device (a X360 wired controller for example). This identifier is platform dependent.
35 *
36 *
37 */
38
39#ifndef SDL_joystick_h_
40#define SDL_joystick_h_
41
42#include "SDL_stdinc.h"
43#include "SDL_error.h"
44
45#include "begin_code.h"
46/* Set up for C function definitions, even when using C++ */
47#ifdef __cplusplus
48extern "C" {
49#endif
50
51/**
52 * \file SDL_joystick.h
53 *
54 * In order to use these functions, SDL_Init() must have been called
55 * with the ::SDL_INIT_JOYSTICK flag. This causes SDL to scan the system
56 * for joysticks, and load appropriate drivers.
57 *
58 * If you would like to receive joystick updates while the application
59 * is in the background, you should set the following hint before calling
60 * SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
61 */
62
63/**
64 * The joystick structure used to identify an SDL joystick
65 */
66struct _SDL_Joystick;
67typedef struct _SDL_Joystick SDL_Joystick;
68
69/* A structure that encodes the stable unique id for a joystick device */
70typedef struct {
71 Uint8 data[16];
72} SDL_JoystickGUID;
73
74/**
75 * This is a unique ID for a joystick for the time it is connected to the system,
76 * and is never reused for the lifetime of the application. If the joystick is
77 * disconnected and reconnected, it will get a new ID.
78 *
79 * The ID value starts at 0 and increments from there. The value -1 is an invalid ID.
80 */
81typedef Sint32 SDL_JoystickID;
82
83typedef enum
84{
85 SDL_JOYSTICK_TYPE_UNKNOWN,
86 SDL_JOYSTICK_TYPE_GAMECONTROLLER,
87 SDL_JOYSTICK_TYPE_WHEEL,
88 SDL_JOYSTICK_TYPE_ARCADE_STICK,
89 SDL_JOYSTICK_TYPE_FLIGHT_STICK,
90 SDL_JOYSTICK_TYPE_DANCE_PAD,
91 SDL_JOYSTICK_TYPE_GUITAR,
92 SDL_JOYSTICK_TYPE_DRUM_KIT,
93 SDL_JOYSTICK_TYPE_ARCADE_PAD,
94 SDL_JOYSTICK_TYPE_THROTTLE
95} SDL_JoystickType;
96
97typedef enum
98{
99 SDL_JOYSTICK_POWER_UNKNOWN = -1,
100 SDL_JOYSTICK_POWER_EMPTY,
101 SDL_JOYSTICK_POWER_LOW,
102 SDL_JOYSTICK_POWER_MEDIUM,
103 SDL_JOYSTICK_POWER_FULL,
104 SDL_JOYSTICK_POWER_WIRED,
105 SDL_JOYSTICK_POWER_MAX
106} SDL_JoystickPowerLevel;
107
108/* Function prototypes */
109
110/**
111 * Locking for multi-threaded access to the joystick API
112 *
113 * If you are using the joystick API or handling events from multiple threads
114 * you should use these locking functions to protect access to the joysticks.
115 *
116 * In particular, you are guaranteed that the joystick list won't change, so
117 * the API functions that take a joystick index will be valid, and joystick
118 * and game controller events will not be delivered.
119 */
120extern DECLSPEC void SDLCALL SDL_LockJoysticks(void);
121extern DECLSPEC void SDLCALL SDL_UnlockJoysticks(void);
122
123/**
124 * Count the number of joysticks attached to the system right now
125 */
126extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
127
128/**
129 * Get the implementation dependent name of a joystick.
130 * This can be called before any joysticks are opened.
131 * If no name can be found, this function returns NULL.
132 */
133extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
134
135/**
136 * Return the GUID for the joystick at this index
137 * This can be called before any joysticks are opened.
138 */
139extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index);
140
141/**
142 * Get the USB vendor ID of a joystick, if available.
143 * This can be called before any joysticks are opened.
144 * If the vendor ID isn't available this function returns 0.
145 */
146extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceVendor(int device_index);
147
148/**
149 * Get the USB product ID of a joystick, if available.
150 * This can be called before any joysticks are opened.
151 * If the product ID isn't available this function returns 0.
152 */
153extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProduct(int device_index);
154
155/**
156 * Get the product version of a joystick, if available.
157 * This can be called before any joysticks are opened.
158 * If the product version isn't available this function returns 0.
159 */
160extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetDeviceProductVersion(int device_index);
161
162/**
163 * Get the type of a joystick, if available.
164 * This can be called before any joysticks are opened.
165 */
166extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetDeviceType(int device_index);
167
168/**
169 * Get the instance ID of a joystick.
170 * This can be called before any joysticks are opened.
171 * If the index is out of range, this function will return -1.
172 */
173extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickGetDeviceInstanceID(int device_index);
174
175/**
176 * Open a joystick for use.
177 * The index passed as an argument refers to the N'th joystick on the system.
178 * This index is not the value which will identify this joystick in future
179 * joystick events. The joystick's instance id (::SDL_JoystickID) will be used
180 * there instead.
181 *
182 * \return A joystick identifier, or NULL if an error occurred.
183 */
184extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
185
186/**
187 * Return the SDL_Joystick associated with an instance id.
188 */
189extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickFromInstanceID(SDL_JoystickID joyid);
190
191/**
192 * Return the name for this currently opened joystick.
193 * If no name can be found, this function returns NULL.
194 */
195extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick * joystick);
196
197/**
198 * Return the GUID for this opened joystick
199 */
200extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick * joystick);
201
202/**
203 * Get the USB vendor ID of an opened joystick, if available.
204 * If the vendor ID isn't available this function returns 0.
205 */
206extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetVendor(SDL_Joystick * joystick);
207
208/**
209 * Get the USB product ID of an opened joystick, if available.
210 * If the product ID isn't available this function returns 0.
211 */
212extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProduct(SDL_Joystick * joystick);
213
214/**
215 * Get the product version of an opened joystick, if available.
216 * If the product version isn't available this function returns 0.
217 */
218extern DECLSPEC Uint16 SDLCALL SDL_JoystickGetProductVersion(SDL_Joystick * joystick);
219
220/**
221 * Get the type of an opened joystick.
222 */
223extern DECLSPEC SDL_JoystickType SDLCALL SDL_JoystickGetType(SDL_Joystick * joystick);
224
225/**
226 * Return a string representation for this guid. pszGUID must point to at least 33 bytes
227 * (32 for the string plus a NULL terminator).
228 */
229extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID);
230
231/**
232 * Convert a string into a joystick guid
233 */
234extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID);
235
236/**
237 * Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not.
238 */
239extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick * joystick);
240
241/**
242 * Get the instance ID of an opened joystick or -1 if the joystick is invalid.
243 */
244extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick * joystick);
245
246/**
247 * Get the number of general axis controls on a joystick.
248 */
249extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick);
250
251/**
252 * Get the number of trackballs on a joystick.
253 *
254 * Joystick trackballs have only relative motion events associated
255 * with them and their state cannot be polled.
256 */
257extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick);
258
259/**
260 * Get the number of POV hats on a joystick.
261 */
262extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick);
263
264/**
265 * Get the number of buttons on a joystick.
266 */
267extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick);
268
269/**
270 * Update the current state of the open joysticks.
271 *
272 * This is called automatically by the event loop if any joystick
273 * events are enabled.
274 */
275extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
276
277/**
278 * Enable/disable joystick event polling.
279 *
280 * If joystick events are disabled, you must call SDL_JoystickUpdate()
281 * yourself and check the state of the joystick when you want joystick
282 * information.
283 *
284 * The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
285 */
286extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
287
288#define SDL_JOYSTICK_AXIS_MAX 32767
289#define SDL_JOYSTICK_AXIS_MIN -32768
290/**
291 * Get the current state of an axis control on a joystick.
292 *
293 * The state is a value ranging from -32768 to 32767.
294 *
295 * The axis indices start at index 0.
296 */
297extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick,
298 int axis);
299
300/**
301 * Get the initial state of an axis control on a joystick.
302 *
303 * The state is a value ranging from -32768 to 32767.
304 *
305 * The axis indices start at index 0.
306 *
307 * \return SDL_TRUE if this axis has any initial value, or SDL_FALSE if not.
308 */
309extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAxisInitialState(SDL_Joystick * joystick,
310 int axis, Sint16 *state);
311
312/**
313 * \name Hat positions
314 */
315/* @{ */
316#define SDL_HAT_CENTERED 0x00
317#define SDL_HAT_UP 0x01
318#define SDL_HAT_RIGHT 0x02
319#define SDL_HAT_DOWN 0x04
320#define SDL_HAT_LEFT 0x08
321#define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP)
322#define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN)
323#define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP)
324#define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN)
325/* @} */
326
327/**
328 * Get the current state of a POV hat on a joystick.
329 *
330 * The hat indices start at index 0.
331 *
332 * \return The return value is one of the following positions:
333 * - ::SDL_HAT_CENTERED
334 * - ::SDL_HAT_UP
335 * - ::SDL_HAT_RIGHT
336 * - ::SDL_HAT_DOWN
337 * - ::SDL_HAT_LEFT
338 * - ::SDL_HAT_RIGHTUP
339 * - ::SDL_HAT_RIGHTDOWN
340 * - ::SDL_HAT_LEFTUP
341 * - ::SDL_HAT_LEFTDOWN
342 */
343extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick,
344 int hat);
345
346/**
347 * Get the ball axis change since the last poll.
348 *
349 * \return 0, or -1 if you passed it invalid parameters.
350 *
351 * The ball indices start at index 0.
352 */
353extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick,
354 int ball, int *dx, int *dy);
355
356/**
357 * Get the current state of a button on a joystick.
358 *
359 * The button indices start at index 0.
360 */
361extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick,
362 int button);
363
364/**
365 * Close a joystick previously opened with SDL_JoystickOpen().
366 */
367extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick);
368
369/**
370 * Return the battery level of this joystick
371 */
372extern DECLSPEC SDL_JoystickPowerLevel SDLCALL SDL_JoystickCurrentPowerLevel(SDL_Joystick * joystick);
373
374/* Ends C function definitions when using C++ */
375#ifdef __cplusplus
376}
377#endif
378#include "close_code.h"
379
380#endif /* SDL_joystick_h_ */
381
382/* vi: set ts=4 sw=4 expandtab: */
383