Mercurial > sdl-ios-xcode
annotate src/haptic/SDL_syshaptic.h @ 2491:10bc7aaf5114 gsoc2008_force_feedback
Commented SDL_syshaptic.h.
Removed SDL_haptic_c.h (no private functions).
Fixed bug with SDL_HapticFromJoystick().
| author | Edgar Simo <bobbens@gmail.com> |
|---|---|
| date | Wed, 02 Jul 2008 10:26:35 +0000 |
| parents | 8e2bdbccf7ff |
| children | 66c02abeef0e |
| rev | line source |
|---|---|
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
1 /* |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
2 SDL - Simple DirectMedia Layer |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
3 Copyright (C) 2008 Edgar Simo |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
4 |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
5 This library is free software; you can redistribute it and/or |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
7 License as published by the Free Software Foundation; either |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
9 |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
10 This library is distributed in the hope that it will be useful, |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
11 but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
13 Lesser General Public License for more details. |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
14 |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
18 |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
19 Sam Lantinga |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
20 slouken@libsdl.org |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
21 */ |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
22 |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
23 #include "SDL_config.h" |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
24 |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
25 #include "SDL_haptic.h" |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
26 |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
27 |
|
2477
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
28 struct haptic_effect |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
29 { |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
30 SDL_HapticEffect effect; /* The current event */ |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
31 struct haptic_hweffect *hweffect; /* The hardware behind the event */ |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
32 }; |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
33 |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
34 /* |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
35 * The real SDL_Haptic event. |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
36 */ |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
37 struct _SDL_Haptic |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
38 { |
|
2477
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
39 Uint8 index; /* Stores index it is attached to */ |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
40 const char* name; /* Stores the name of the device */ |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
41 |
|
2477
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
42 struct haptic_effect *effects; /* Allocated effects */ |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
43 int neffects; /* Maximum amount of effects */ |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
44 unsigned int supported; /* Supported effects */ |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
45 |
|
2477
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
46 struct haptic_hwdata *hwdata; /* Driver dependent */ |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
47 int ref_count; /* Count for multiple opens */ |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
48 }; |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
49 |
| 2491 | 50 /* |
| 51 * Scans the system for haptic devices. | |
| 52 * | |
| 53 * Returns 0 on success, -1 on error. | |
| 54 */ | |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
55 extern int SDL_SYS_HapticInit(void); |
| 2491 | 56 |
| 57 /* | |
| 58 * Gets the device dependent name of the haptic device | |
| 59 */ | |
| 2475 | 60 extern const char * SDL_SYS_HapticName(int index); |
| 2491 | 61 |
| 62 /* | |
| 63 * Opens the haptic device for usage. The haptic device should have | |
| 64 * the index value set previously. | |
| 65 * | |
| 66 * Returns 0 on success, -1 on error. | |
| 67 */ | |
| 2475 | 68 extern int SDL_SYS_HapticOpen(SDL_Haptic * haptic); |
| 2491 | 69 |
| 70 /* | |
| 71 * Checks to see if the joystick has haptic capabilities. | |
| 72 * | |
| 73 * Returns >0 if haptic capabilities are detected, 0 if haptic | |
| 74 * capabilities aren't detected and -1 on error. | |
| 75 */ | |
| 76 extern int SDL_JoystickIsHaptic(SDL_Joystick * joystick); | |
| 77 | |
| 78 /* | |
| 79 * Opens the haptic device for usage using the same device as | |
| 80 * the joystick. | |
| 81 * | |
| 82 * Returns 0 on success, -1 on error. | |
| 83 */ | |
| 84 extern int SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic, | |
| 85 SDL_Joystick * joystick); | |
| 86 | |
| 87 /* | |
| 88 * Checks to see if haptic device and joystick device are the same. | |
| 89 * | |
| 90 * Returns 1 if they are the same, 0 if they aren't. | |
| 91 */ | |
| 92 extern int SDL_SYS_JoystickSameHaptic(SDL_Haptic * haptic, | |
| 93 SDL_Joystick * joystick); | |
| 94 | |
| 95 /* | |
| 96 * Closes a haptic device after usage. | |
| 97 */ | |
| 2475 | 98 extern void SDL_SYS_HapticClose(SDL_Haptic * haptic); |
| 2491 | 99 |
| 100 /* | |
| 101 * Performs a cleanup on the haptic subsystem. | |
| 102 */ | |
| 2475 | 103 extern void SDL_SYS_HapticQuit(void); |
| 2491 | 104 |
| 105 /* | |
| 106 * Creates a new haptic effect on the haptic device using base | |
| 107 * as a template for the effect. | |
| 108 * | |
| 109 * Returns 0 on success, -1 on error. | |
| 110 */ | |
|
2479
b9eb2cfe16cd
Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents:
2477
diff
changeset
|
111 extern int SDL_SYS_HapticNewEffect(SDL_Haptic * haptic, |
| 2491 | 112 struct haptic_effect * effect, |
| 113 SDL_HapticEffect * base); | |
| 114 | |
| 115 /* | |
| 116 * Updates the haptic effect on the haptic device using data | |
| 117 * as a template. | |
| 118 * | |
| 119 * Returns 0 on success, -1 on error. | |
| 120 */ | |
|
2488
8e2bdbccf7ff
Added SDL_HapticUpdateEffect().
Edgar Simo <bobbens@gmail.com>
parents:
2485
diff
changeset
|
121 extern int SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic, |
| 2491 | 122 struct haptic_effect * effect, |
| 123 SDL_HapticEffect * data); | |
| 124 | |
| 125 /* | |
| 126 * Runs the effect on the haptic device. | |
| 127 * | |
| 128 * Returns 0 on success, -1 on error. | |
| 129 */ | |
|
2479
b9eb2cfe16cd
Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents:
2477
diff
changeset
|
130 extern int SDL_SYS_HapticRunEffect(SDL_Haptic * haptic, |
| 2491 | 131 struct haptic_effect * effect); |
| 132 | |
| 133 /* | |
| 134 * Stops the effect on the haptic device. | |
| 135 * | |
| 136 * Returns 0 on success, -1 on error. | |
| 137 */ | |
|
2485
67978eea6d10
Added SDL_HapticStopEffect().
Edgar Simo <bobbens@gmail.com>
parents:
2484
diff
changeset
|
138 extern int SDL_SYS_HapticStopEffect(SDL_Haptic * haptic, |
| 2491 | 139 struct haptic_effect * effect); |
| 140 | |
| 141 /* | |
| 142 * Cleanups up the effect on the haptic device. | |
| 143 */ | |
|
2479
b9eb2cfe16cd
Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents:
2477
diff
changeset
|
144 extern void SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic, |
| 2491 | 145 struct haptic_effect * effect); |
| 146 | |
| 147 /* | |
| 148 * Sets the global gain of the haptic device. | |
| 149 * | |
| 150 * Returns 0 on success, -1 on error. | |
| 151 */ | |
|
2483
9d52368ebcf5
Setting effects memory to 0.
Edgar Simo <bobbens@gmail.com>
parents:
2480
diff
changeset
|
152 extern int SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain); |
| 2491 | 153 |
| 154 /* | |
| 155 * Sets the autocenter feature of the haptic device. | |
| 156 * | |
| 157 * Returns 0 on success, -1 on error. | |
| 158 */ | |
| 159 extern int SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic, | |
| 160 int autocenter); | |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
161 |
|
2479
b9eb2cfe16cd
Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents:
2477
diff
changeset
|
162 |