2 Simple DirectMedia Layer
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.
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:
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.
23 * \file SDL_joystick.h
25 * Include file for SDL joystick event handling
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.
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.
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.
39 #ifndef _SDL_joystick_h
40 #define _SDL_joystick_h
42 #include "SDL_stdinc.h"
43 #include "SDL_error.h"
45 #include "begin_code.h"
46 /* Set up for C function definitions, even when using C++ */
52 * \file SDL_joystick.h
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.
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
63 /* The joystick structure used to identify an SDL joystick */
65 typedef struct _SDL_Joystick SDL_Joystick;
67 /* A structure that encodes the stable unique id for a joystick device */
72 typedef Sint32 SDL_JoystickID;
75 /* Function prototypes */
77 * Count the number of joysticks attached to the system right now
79 extern DECLSPEC int SDLCALL SDL_NumJoysticks(void);
82 * Get the implementation dependent name of a joystick.
83 * This can be called before any joysticks are opened.
84 * If no name can be found, this function returns NULL.
86 extern DECLSPEC const char *SDLCALL SDL_JoystickNameForIndex(int device_index);
89 * Open a joystick for use.
90 * The index passed as an argument refers tothe N'th joystick on the system.
91 * This index is the value which will identify this joystick in future joystick
94 * \return A joystick identifier, or NULL if an error occurred.
96 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index);
99 * Return the name for this currently opened joystick.
100 * If no name can be found, this function returns NULL.
102 extern DECLSPEC const char *SDLCALL SDL_JoystickName(SDL_Joystick * joystick);
105 * Return the GUID for the joystick at this index
107 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetDeviceGUID(int device_index);
110 * Return the GUID for this opened joystick
112 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUID(SDL_Joystick * joystick);
115 * Return a string representation for this guid. pszGUID must point to at least 33 bytes
116 * (32 for the string plus a NULL terminator).
118 extern DECLSPEC void SDLCALL SDL_JoystickGetGUIDString(SDL_JoystickGUID guid, char *pszGUID, int cbGUID);
121 * convert a string into a joystick formatted guid
123 extern DECLSPEC SDL_JoystickGUID SDLCALL SDL_JoystickGetGUIDFromString(const char *pchGUID);
126 * Returns SDL_TRUE if the joystick has been opened and currently connected, or SDL_FALSE if it has not.
128 extern DECLSPEC SDL_bool SDLCALL SDL_JoystickGetAttached(SDL_Joystick * joystick);
131 * Get the instance ID of an opened joystick or -1 if the joystick is invalid.
133 extern DECLSPEC SDL_JoystickID SDLCALL SDL_JoystickInstanceID(SDL_Joystick * joystick);
136 * Get the number of general axis controls on a joystick.
138 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick);
141 * Get the number of trackballs on a joystick.
143 * Joystick trackballs have only relative motion events associated
144 * with them and their state cannot be polled.
146 extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick);
149 * Get the number of POV hats on a joystick.
151 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick);
154 * Get the number of buttons on a joystick.
156 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick);
159 * Update the current state of the open joysticks.
161 * This is called automatically by the event loop if any joystick
162 * events are enabled.
164 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void);
167 * Enable/disable joystick event polling.
169 * If joystick events are disabled, you must call SDL_JoystickUpdate()
170 * yourself and check the state of the joystick when you want joystick
173 * The state can be one of ::SDL_QUERY, ::SDL_ENABLE or ::SDL_IGNORE.
175 extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state);
178 * Get the current state of an axis control on a joystick.
180 * The state is a value ranging from -32768 to 32767.
182 * The axis indices start at index 0.
184 extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick,
188 * \name Hat positions
191 #define SDL_HAT_CENTERED 0x00
192 #define SDL_HAT_UP 0x01
193 #define SDL_HAT_RIGHT 0x02
194 #define SDL_HAT_DOWN 0x04
195 #define SDL_HAT_LEFT 0x08
196 #define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP)
197 #define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN)
198 #define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP)
199 #define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN)
203 * Get the current state of a POV hat on a joystick.
205 * The hat indices start at index 0.
207 * \return The return value is one of the following positions:
208 * - ::SDL_HAT_CENTERED
213 * - ::SDL_HAT_RIGHTUP
214 * - ::SDL_HAT_RIGHTDOWN
216 * - ::SDL_HAT_LEFTDOWN
218 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick,
222 * Get the ball axis change since the last poll.
224 * \return 0, or -1 if you passed it invalid parameters.
226 * The ball indices start at index 0.
228 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick,
229 int ball, int *dx, int *dy);
232 * Get the current state of a button on a joystick.
234 * The button indices start at index 0.
236 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick,
240 * Close a joystick previously opened with SDL_JoystickOpen().
242 extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick);
245 /* Ends C function definitions when using C++ */
249 #include "close_code.h"
251 #endif /* _SDL_joystick_h */
253 /* vi: set ts=4 sw=4 expandtab: */