Mercurial > sdl-ios-xcode
annotate include/SDL_joystick.h @ 2960:91708bc14aab
It's probably not worth pushing palettized textures. The memory optimization
isn't worth the effort on modern hardware with the sorts of games that would
be using the SDL 1.3 texture API.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Fri, 02 Jan 2009 09:27:36 +0000 |
| parents | 99210400e8b9 |
| children | d3baf5ac4e37 |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
| 2859 | 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 | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
23 /** |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
24 * \file SDL_joystick.h |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
25 * |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
26 * Include file for SDL joystick event handling |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
27 */ |
| 0 | 28 |
| 29 #ifndef _SDL_joystick_h | |
| 30 #define _SDL_joystick_h | |
| 31 | |
|
1356
67114343400d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
32 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
33 #include "SDL_error.h" |
| 0 | 34 |
| 35 #include "begin_code.h" | |
| 36 /* Set up for C function definitions, even when using C++ */ | |
| 37 #ifdef __cplusplus | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
38 /* *INDENT-OFF* */ |
| 0 | 39 extern "C" { |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
40 /* *INDENT-ON* */ |
| 0 | 41 #endif |
| 42 | |
| 43 /* In order to use these functions, SDL_Init() must have been called | |
| 44 with the SDL_INIT_JOYSTICK flag. This causes SDL to scan the system | |
| 45 for joysticks, and load appropriate drivers. | |
| 46 */ | |
| 47 | |
| 48 /* The joystick structure used to identify an SDL joystick */ | |
| 49 struct _SDL_Joystick; | |
| 50 typedef struct _SDL_Joystick SDL_Joystick; | |
| 51 | |
| 52 | |
| 53 /* Function prototypes */ | |
| 54 /* | |
| 55 * Count the number of joysticks attached to the system | |
| 56 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
57 extern DECLSPEC int SDLCALL SDL_NumJoysticks(void); |
| 0 | 58 |
| 59 /* | |
| 60 * Get the implementation dependent name of a joystick. | |
| 61 * This can be called before any joysticks are opened. | |
| 62 * If no name can be found, this function returns NULL. | |
| 63 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
64 extern DECLSPEC const char *SDLCALL SDL_JoystickName(int device_index); |
| 0 | 65 |
| 66 /* | |
| 67 * Open a joystick for use - the index passed as an argument refers to | |
| 68 * the N'th joystick on the system. This index is the value which will | |
| 69 * identify this joystick in future joystick events. | |
| 70 * | |
| 71 * This function returns a joystick identifier, or NULL if an error occurred. | |
| 72 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
73 extern DECLSPEC SDL_Joystick *SDLCALL SDL_JoystickOpen(int device_index); |
| 0 | 74 |
| 75 /* | |
| 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 |
| 80 /* | |
| 81 * Get the device index of an opened joystick. | |
| 82 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
83 extern DECLSPEC int SDLCALL SDL_JoystickIndex(SDL_Joystick * joystick); |
| 0 | 84 |
| 85 /* | |
| 86 * Get the number of general axis controls on a joystick | |
| 87 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
88 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick * joystick); |
| 0 | 89 |
| 90 /* | |
| 91 * Get the number of trackballs on a joystick | |
| 92 * Joystick trackballs have only relative motion events associated | |
| 93 * with them and their state cannot be polled. | |
| 94 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
95 extern DECLSPEC int SDLCALL SDL_JoystickNumBalls(SDL_Joystick * joystick); |
| 0 | 96 |
| 97 /* | |
| 98 * Get the number of POV hats on a joystick | |
| 99 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
100 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick * joystick); |
| 0 | 101 |
| 102 /* | |
| 103 * Get the number of buttons on a joystick | |
| 104 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
105 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick * joystick); |
| 0 | 106 |
| 107 /* | |
| 108 * Update the current state of the open joysticks. | |
| 109 * This is called automatically by the event loop if any joystick | |
| 110 * events are enabled. | |
| 111 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
112 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void); |
| 0 | 113 |
| 114 /* | |
| 115 * Enable/disable joystick event polling. | |
| 116 * If joystick events are disabled, you must call SDL_JoystickUpdate() | |
| 117 * yourself and check the state of the joystick when you want joystick | |
| 118 * information. | |
| 119 * The state can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE. | |
| 120 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
121 extern DECLSPEC int SDLCALL SDL_JoystickEventState(int state); |
| 0 | 122 |
| 123 /* | |
| 124 * Get the current state of an axis control on a joystick | |
| 125 * The state is a value ranging from -32768 to 32767. | |
| 126 * The axis indices start at index 0. | |
| 127 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
128 extern DECLSPEC Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick * joystick, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
129 int axis); |
| 0 | 130 |
| 131 /* | |
| 132 * Get the current state of a POV hat on a joystick | |
| 133 * The return value is one of the following positions: | |
| 134 */ | |
| 135 #define SDL_HAT_CENTERED 0x00 | |
| 136 #define SDL_HAT_UP 0x01 | |
| 137 #define SDL_HAT_RIGHT 0x02 | |
| 138 #define SDL_HAT_DOWN 0x04 | |
| 139 #define SDL_HAT_LEFT 0x08 | |
| 140 #define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP) | |
| 141 #define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN) | |
| 142 #define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP) | |
| 143 #define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN) | |
| 144 /* | |
| 145 * The hat indices start at index 0. | |
| 146 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
147 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick * joystick, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
148 int hat); |
| 0 | 149 |
| 150 /* | |
| 151 * Get the ball axis change since the last poll | |
| 152 * This returns 0, or -1 if you passed it invalid parameters. | |
| 153 * The ball indices start at index 0. | |
| 154 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
155 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick * joystick, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
156 int ball, int *dx, int *dy); |
| 0 | 157 |
| 158 /* | |
| 159 * Get the current state of a button on a joystick | |
| 160 * The button indices start at index 0. | |
| 161 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
162 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick * joystick, |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
163 int button); |
| 0 | 164 |
| 165 /* | |
| 166 * Close a joystick previously opened with SDL_JoystickOpen() | |
| 167 */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
168 extern DECLSPEC void SDLCALL SDL_JoystickClose(SDL_Joystick * joystick); |
| 0 | 169 |
| 170 | |
| 171 /* Ends C function definitions when using C++ */ | |
| 172 #ifdef __cplusplus | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
173 /* *INDENT-OFF* */ |
| 0 | 174 } |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
175 /* *INDENT-ON* */ |
| 0 | 176 #endif |
| 177 #include "close_code.h" | |
| 178 | |
| 179 #endif /* _SDL_joystick_h */ | |
|
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
180 |
|
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1358
diff
changeset
|
181 /* vi: set ts=4 sw=4 expandtab: */ |