Mercurial > sdl-ios-xcode
annotate include/SDL_joystick.h @ 1353:7ba544e2888d
Started the process of improving configure support, and merging C types
and library support into a single header.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Thu, 09 Feb 2006 09:07:13 +0000 |
| parents | c9b51268668f |
| children | 67114343400d |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
905
diff
changeset
|
3 Copyright (C) 1997-2006 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 | |
| 23 /* Include file for SDL joystick event handling */ | |
| 24 | |
| 25 #ifndef _SDL_joystick_h | |
| 26 #define _SDL_joystick_h | |
| 27 | |
| 28 #include "SDL_types.h" | |
| 29 | |
| 30 #include "begin_code.h" | |
| 31 /* Set up for C function definitions, even when using C++ */ | |
| 32 #ifdef __cplusplus | |
| 33 extern "C" { | |
| 34 #endif | |
| 35 | |
| 36 /* In order to use these functions, SDL_Init() must have been called | |
| 37 with the SDL_INIT_JOYSTICK flag. This causes SDL to scan the system | |
| 38 for joysticks, and load appropriate drivers. | |
| 39 */ | |
| 40 | |
| 41 /* The joystick structure used to identify an SDL joystick */ | |
| 42 struct _SDL_Joystick; | |
| 43 typedef struct _SDL_Joystick SDL_Joystick; | |
| 44 | |
| 45 | |
| 46 /* Function prototypes */ | |
| 47 /* | |
| 48 * Count the number of joysticks attached to the system | |
| 49 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
50 extern DECLSPEC int SDLCALL SDL_NumJoysticks(void); |
| 0 | 51 |
| 52 /* | |
| 53 * Get the implementation dependent name of a joystick. | |
| 54 * This can be called before any joysticks are opened. | |
| 55 * If no name can be found, this function returns NULL. | |
| 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 const char * SDLCALL SDL_JoystickName(int device_index); |
| 0 | 58 |
| 59 /* | |
| 60 * Open a joystick for use - the index passed as an argument refers to | |
| 61 * the N'th joystick on the system. This index is the value which will | |
| 62 * identify this joystick in future joystick events. | |
| 63 * | |
| 64 * This function returns a joystick identifier, or NULL if an error occurred. | |
| 65 */ | |
|
905
e6ceebb0f0eb
Date: Wed, 7 Jul 2004 12:57:58 +0200
Sam Lantinga <slouken@libsdl.org>
parents:
769
diff
changeset
|
66 extern DECLSPEC SDL_Joystick * SDLCALL SDL_JoystickOpen(int device_index); |
| 0 | 67 |
| 68 /* | |
| 69 * Returns 1 if the joystick has been opened, or 0 if it has not. | |
| 70 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
71 extern DECLSPEC int SDLCALL SDL_JoystickOpened(int device_index); |
| 0 | 72 |
| 73 /* | |
| 74 * Get the device index of an opened joystick. | |
| 75 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
76 extern DECLSPEC int SDLCALL SDL_JoystickIndex(SDL_Joystick *joystick); |
| 0 | 77 |
| 78 /* | |
| 79 * Get the number of general axis controls on a joystick | |
| 80 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
81 extern DECLSPEC int SDLCALL SDL_JoystickNumAxes(SDL_Joystick *joystick); |
| 0 | 82 |
| 83 /* | |
| 84 * Get the number of trackballs on a joystick | |
| 85 * Joystick trackballs have only relative motion events associated | |
| 86 * with them and their state cannot be polled. | |
| 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_JoystickNumBalls(SDL_Joystick *joystick); |
| 0 | 89 |
| 90 /* | |
| 91 * Get the number of POV hats on a joystick | |
| 92 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
93 extern DECLSPEC int SDLCALL SDL_JoystickNumHats(SDL_Joystick *joystick); |
| 0 | 94 |
| 95 /* | |
| 96 * Get the number of buttons on a joystick | |
| 97 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
98 extern DECLSPEC int SDLCALL SDL_JoystickNumButtons(SDL_Joystick *joystick); |
| 0 | 99 |
| 100 /* | |
| 101 * Update the current state of the open joysticks. | |
| 102 * This is called automatically by the event loop if any joystick | |
| 103 * events are enabled. | |
| 104 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
105 extern DECLSPEC void SDLCALL SDL_JoystickUpdate(void); |
| 0 | 106 |
| 107 /* | |
| 108 * Enable/disable joystick event polling. | |
| 109 * If joystick events are disabled, you must call SDL_JoystickUpdate() | |
| 110 * yourself and check the state of the joystick when you want joystick | |
| 111 * information. | |
| 112 * The state can be one of SDL_QUERY, SDL_ENABLE or SDL_IGNORE. | |
| 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 int SDLCALL SDL_JoystickEventState(int state); |
| 0 | 115 |
| 116 /* | |
| 117 * Get the current state of an axis control on a joystick | |
| 118 * The state is a value ranging from -32768 to 32767. | |
| 119 * The axis indices start at index 0. | |
| 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 Sint16 SDLCALL SDL_JoystickGetAxis(SDL_Joystick *joystick, int axis); |
| 0 | 122 |
| 123 /* | |
| 124 * Get the current state of a POV hat on a joystick | |
| 125 * The return value is one of the following positions: | |
| 126 */ | |
| 127 #define SDL_HAT_CENTERED 0x00 | |
| 128 #define SDL_HAT_UP 0x01 | |
| 129 #define SDL_HAT_RIGHT 0x02 | |
| 130 #define SDL_HAT_DOWN 0x04 | |
| 131 #define SDL_HAT_LEFT 0x08 | |
| 132 #define SDL_HAT_RIGHTUP (SDL_HAT_RIGHT|SDL_HAT_UP) | |
| 133 #define SDL_HAT_RIGHTDOWN (SDL_HAT_RIGHT|SDL_HAT_DOWN) | |
| 134 #define SDL_HAT_LEFTUP (SDL_HAT_LEFT|SDL_HAT_UP) | |
| 135 #define SDL_HAT_LEFTDOWN (SDL_HAT_LEFT|SDL_HAT_DOWN) | |
| 136 /* | |
| 137 * The hat indices start at index 0. | |
| 138 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
139 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetHat(SDL_Joystick *joystick, int hat); |
| 0 | 140 |
| 141 /* | |
| 142 * Get the ball axis change since the last poll | |
| 143 * This returns 0, or -1 if you passed it invalid parameters. | |
| 144 * The ball indices start at index 0. | |
| 145 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
146 extern DECLSPEC int SDLCALL SDL_JoystickGetBall(SDL_Joystick *joystick, int ball, int *dx, int *dy); |
| 0 | 147 |
| 148 /* | |
| 149 * Get the current state of a button on a joystick | |
| 150 * The button indices start at index 0. | |
| 151 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
152 extern DECLSPEC Uint8 SDLCALL SDL_JoystickGetButton(SDL_Joystick *joystick, int button); |
| 0 | 153 |
| 154 /* | |
| 155 * Close a joystick previously opened with SDL_JoystickOpen() | |
| 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 void SDLCALL SDL_JoystickClose(SDL_Joystick *joystick); |
| 0 | 158 |
| 159 | |
| 160 /* Ends C function definitions when using C++ */ | |
| 161 #ifdef __cplusplus | |
| 162 } | |
| 163 #endif | |
| 164 #include "close_code.h" | |
| 165 | |
| 166 #endif /* _SDL_joystick_h */ |