Mercurial > sdl-ios-xcode
annotate include/SDL_joystick.h @ 4231:2d5c44f1be14 SDL-1.2
Added missing newline
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Tue, 22 Sep 2009 02:37:30 +0000 |
| parents | 4c4113c2162c |
| children |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
| 4159 | 3 Copyright (C) 1997-2009 Sam Lantinga |
| 0 | 4 |
| 5 This library is free software; you can redistribute it and/or | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
905
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
| 0 | 7 License as published by the Free Software Foundation; either |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
905
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
| 0 | 9 |
| 10 This library is distributed in the hope that it will be useful, | |
| 11 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
905
diff
changeset
|
13 Lesser General Public License for more details. |
| 0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
905
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
905
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
905
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 0 | 18 |
| 19 Sam Lantinga | |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
| 4217 | 23 /** @file SDL_joystick.h |
| 24 * Include file for SDL joystick event handling | |
| 25 */ | |
| 0 | 26 |
| 27 #ifndef _SDL_joystick_h | |
| 28 #define _SDL_joystick_h | |
| 29 | |
|
1356
67114343400d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
30 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
31 #include "SDL_error.h" |
| 0 | 32 |
| 33 #include "begin_code.h" | |
| 34 /* Set up for C function definitions, even when using C++ */ | |
| 35 #ifdef __cplusplus | |
| 36 extern "C" { | |
| 37 #endif | |
| 38 | |
| 4217 | 39 /** @file SDL_joystick.h |
| 40 * @note In order to use these functions, SDL_Init() must have been called | |
| 41 * with the SDL_INIT_JOYSTICK flag. This causes SDL to scan the system | |
| 42 * for joysticks, and load appropriate drivers. | |
| 43 */ | |
| 0 | 44 |
| 4217 | 45 /** The joystick structure used to identify an SDL joystick */ |
| 0 | 46 struct _SDL_Joystick; |
| 47 typedef struct _SDL_Joystick SDL_Joystick; | |
| 48 | |
| 49 /* Function prototypes */ | |
| 4217 | 50 /** |
| 0 | 51 * Count the number of joysticks attached to the system |
| 52 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
53 extern DECLSPEC int SDLCALL SDL_NumJoysticks(void); |
| 0 | 54 |
| 4217 | 55 /** |
| 0 | 56 * Get the implementation dependent name of a joystick. |
| 4217 | 57 * |
| 0 | 58 * This can be called before any joysticks are opened. |
| 59 * If no name can be found, this function returns NULL. | |
| 60 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
61 extern DECLSPEC const char * SDLCALL SDL_JoystickName(int device_index); |
| 0 | 62 |
| 4217 | 63 /** |
| 64 * Open a joystick for use. | |
| 65 * | |
| 66 * @param[in] device_index | |
| 67 * The index passed as an argument refers to | |
| 0 | 68 * the N'th joystick on the system. This index is the value which will |
| 69 * identify this joystick in future joystick events. | |
| 70 * | |
| 4217 | 71 * @return This function returns a joystick identifier, or NULL if an error occurred. |
| 0 | 72 */ |
|
905
e6ceebb0f0eb
Date: Wed, 7 Jul 2004 12:57:58 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
73 extern DECLSPEC SDL_Joystick * SDLCALL SDL_JoystickOpen(int device_index); |
| 0 | 74 |
| 4217 | 75 /** |
| 0 | 76 * Returns 1 if the joystick has been opened, or 0 if it has not. |
| 77 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
78 extern DECLSPEC int SDLCALL SDL_JoystickOpened(int device_index); |
| 0 | 79 |
| 4217 | 80 /** |
| 0 | 81 * Get the device index of an opened joystick. |
| 82 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
83 extern DECLSPEC int SDLCALL SDL_JoystickIndex(SDL_Joystick *joystick); |
| 0 | 84 |
| 4217 | 85 /** |
| 0 | 86 * Get the number of general axis controls on a joystick |
| 87 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
88 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick *joystick); |
| 0 | 89 |
| 4217 | 90 /** |
| 0 | 91 * Get the number of trackballs on a joystick |
| 4217 | 92 * |
| 0 | 93 * Joystick trackballs have only relative motion events associated |
| 94 * with them and their state cannot be polled. | |
| 95 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
96 extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick *joystick); |
| 0 | 97 |
| 4217 | 98 /** |
| 0 | 99 * Get the number of POV hats on a joystick |
| 100 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
101 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick *joystick); |
| 0 | 102 |
| 4217 | 103 /** |
| 0 | 104 * Get the number of buttons on a joystick |
| 105 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
106 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick *joystick); |
| 0 | 107 |
| 4217 | 108 /** |
| 0 | 109 * Update the current state of the open joysticks. |
| 4217 | 110 * |
| 0 | 111 * This is called automatically by the event loop if any joystick |
| 112 * events are enabled. | |
| 113 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
114 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void); |
| 0 | 115 |
| 4217 | 116 /** |
| 0 | 117 * Enable/disable joystick event polling. |
| 4217 | 118 * |
| 0 | 119 * If joystick events are disabled, you must call SDL_JoystickUpdate() |
| 120 * yourself and check the state of the joystick when you want joystick | |
| 121 * information. | |
| 4217 | 122 * |
| 123 * @param[in] state The state can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE. | |
| 0 | 124 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
125 extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state); |
| 0 | 126 |
| 4217 | 127 /** |
| 0 | 128 * Get the current state of an axis control on a joystick |
| 4217 | 129 * |
| 130 * @param[in] axis The axis indices start at index 0. | |
| 131 * | |
| 132 * @return The state is a value ranging from -32768 to 32767. | |
| 0 | 133 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
134 extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis); |
| 0 | 135 |
| 4217 | 136 /** |
| 137 * @name Hat Positions | |
| 138 * The return value of SDL_JoystickGetHat() is one of the following positions: | |
| 0 | 139 */ |
| 4217 | 140 /*@{*/ |
| 0 | 141 #define SDL_HAT_CENTERED 0x00 |
| 142 #define SDL_HAT_UP 0x01 | |
| 143 #define SDL_HAT_RIGHT 0x02 | |
| 144 #define SDL_HAT_DOWN 0x04 | |
| 145 #define SDL_HAT_LEFT 0x08 | |
| 146 #define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP) | |
| 147 #define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN) | |
| 148 #define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP) | |
| 149 #define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN) | |
| 4217 | 150 /*@}*/ |
| 151 | |
| 152 /** | |
| 153 * Get the current state of a POV hat on a joystick | |
| 154 * | |
| 155 * @param[in] hat The hat indices start at index 0. | |
| 0 | 156 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
157 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick *joystick, int hat); |
| 0 | 158 |
| 4217 | 159 /** |
| 0 | 160 * Get the ball axis change since the last poll |
| 4217 | 161 * |
| 162 * @param[in] ball The ball indices start at index 0. | |
| 163 * | |
| 164 * @return This returns 0, or -1 if you passed it invalid parameters. | |
| 0 | 165 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
166 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick *joystick, int ball, int *dx, int *dy); |
| 0 | 167 |
| 4217 | 168 /** |
| 0 | 169 * Get the current state of a button on a joystick |
| 4217 | 170 * |
| 171 * @param[in] button The button indices start at index 0. | |
| 0 | 172 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
173 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick *joystick, int button); |
| 0 | 174 |
| 4217 | 175 /** |
| 0 | 176 * Close a joystick previously opened with SDL_JoystickOpen() |
| 177 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
178 extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick *joystick); |
| 0 | 179 |
| 180 | |
| 181 /* Ends C function definitions when using C++ */ | |
| 182 #ifdef __cplusplus | |
| 183 } | |
| 184 #endif | |
| 185 #include "close_code.h" | |
| 186 | |
| 187 #endif /* _SDL_joystick_h */ |