Mercurial > sdl-ios-xcode
annotate src/haptic/SDL_syshaptic.h @ 2523:366d84fdf8d1 gsoc2008_force_feedback
Haptic subsystem handles haptic axes now.
Support for SDL_HAPTIC_SPHERICAL on linux.
More error checking.
Improved documentation.
Added missing SDLCALLs to SDL_haptic.h.
| author | Edgar Simo <bobbens@gmail.com> |
|---|---|
| date | Thu, 17 Jul 2008 11:47:48 +0000 |
| parents | af9df9662807 |
| children | 1a55848ce198 |
| 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 |
|
2512
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
28 /* |
|
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
29 * Number of haptic devices on the system. |
|
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
30 */ |
|
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
31 extern Uint8 SDL_numhaptics; |
|
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
32 |
|
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
33 |
|
2477
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
34 struct haptic_effect |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
35 { |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
36 SDL_HapticEffect effect; /* The current event */ |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
37 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
|
38 }; |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
39 |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
40 /* |
|
2517
37c13c12c878
Broke API by introducing iterations to SDL_HapticRunEffects().
Edgar Simo <bobbens@gmail.com>
parents:
2515
diff
changeset
|
41 * The real SDL_Haptic struct. |
|
2477
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
42 */ |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
43 struct _SDL_Haptic |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
44 { |
|
2477
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
45 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
|
46 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
|
47 |
|
2477
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
48 struct haptic_effect *effects; /* Allocated effects */ |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
49 int neffects; /* Maximum amount of effects */ |
|
2515
030fc4375e63
Added SDL_HapticNumEffectsPlaying().
Edgar Simo <bobbens@gmail.com>
parents:
2512
diff
changeset
|
50 int nplaying; /* Maximum amount of effects to play at the same time */ |
|
2477
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
51 unsigned int supported; /* Supported effects */ |
|
2523
366d84fdf8d1
Haptic subsystem handles haptic axes now.
Edgar Simo <bobbens@gmail.com>
parents:
2519
diff
changeset
|
52 int naxes; /* Number of axes on the device. */ |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
53 |
|
2477
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
54 struct haptic_hwdata *hwdata; /* Driver dependent */ |
|
97f75ea43a93
Starting to add infrastructure to handle haptic effects.
Edgar Simo <bobbens@gmail.com>
parents:
2475
diff
changeset
|
55 int ref_count; /* Count for multiple opens */ |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
56 }; |
|
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
57 |
| 2491 | 58 /* |
| 59 * Scans the system for haptic devices. | |
| 60 * | |
| 61 * Returns 0 on success, -1 on error. | |
| 62 */ | |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
63 extern int SDL_SYS_HapticInit(void); |
| 2491 | 64 |
| 65 /* | |
| 66 * Gets the device dependent name of the haptic device | |
| 67 */ | |
| 2475 | 68 extern const char * SDL_SYS_HapticName(int index); |
| 2491 | 69 |
| 70 /* | |
| 71 * Opens the haptic device for usage. The haptic device should have | |
| 72 * the index value set previously. | |
| 73 * | |
| 74 * Returns 0 on success, -1 on error. | |
| 75 */ | |
| 2475 | 76 extern int SDL_SYS_HapticOpen(SDL_Haptic * haptic); |
| 2491 | 77 |
| 78 /* | |
|
2512
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
79 * Returns the index of the haptic core pointer or -1 if none is found. |
|
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
80 */ |
|
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
81 int SDL_SYS_HapticMouse(void); |
|
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
82 |
|
ef147ee4896c
Improved some ioctl handling.
Edgar Simo <bobbens@gmail.com>
parents:
2495
diff
changeset
|
83 /* |
| 2491 | 84 * Checks to see if the joystick has haptic capabilities. |
| 85 * | |
| 86 * Returns >0 if haptic capabilities are detected, 0 if haptic | |
| 87 * capabilities aren't detected and -1 on error. | |
| 88 */ | |
| 89 extern int SDL_JoystickIsHaptic(SDL_Joystick * joystick); | |
| 90 | |
| 91 /* | |
| 92 * Opens the haptic device for usage using the same device as | |
| 93 * the joystick. | |
| 94 * | |
| 95 * Returns 0 on success, -1 on error. | |
| 96 */ | |
| 97 extern int SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic, | |
| 98 SDL_Joystick * joystick); | |
| 99 /* | |
| 100 * Checks to see if haptic device and joystick device are the same. | |
| 101 * | |
| 102 * Returns 1 if they are the same, 0 if they aren't. | |
| 103 */ | |
| 104 extern int SDL_SYS_JoystickSameHaptic(SDL_Haptic * haptic, | |
| 105 SDL_Joystick * joystick); | |
| 106 | |
| 107 /* | |
| 108 * Closes a haptic device after usage. | |
| 109 */ | |
| 2475 | 110 extern void SDL_SYS_HapticClose(SDL_Haptic * haptic); |
| 2491 | 111 |
| 112 /* | |
| 113 * Performs a cleanup on the haptic subsystem. | |
| 114 */ | |
| 2475 | 115 extern void SDL_SYS_HapticQuit(void); |
| 2491 | 116 |
| 117 /* | |
| 118 * Creates a new haptic effect on the haptic device using base | |
| 119 * as a template for the effect. | |
| 120 * | |
| 121 * Returns 0 on success, -1 on error. | |
| 122 */ | |
|
2479
b9eb2cfe16cd
Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents:
2477
diff
changeset
|
123 extern int SDL_SYS_HapticNewEffect(SDL_Haptic * haptic, |
| 2491 | 124 struct haptic_effect * effect, |
| 125 SDL_HapticEffect * base); | |
| 126 | |
| 127 /* | |
| 128 * Updates the haptic effect on the haptic device using data | |
| 129 * as a template. | |
| 130 * | |
| 131 * Returns 0 on success, -1 on error. | |
| 132 */ | |
|
2488
8e2bdbccf7ff
Added SDL_HapticUpdateEffect().
Edgar Simo <bobbens@gmail.com>
parents:
2485
diff
changeset
|
133 extern int SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic, |
| 2491 | 134 struct haptic_effect * effect, |
| 135 SDL_HapticEffect * data); | |
| 136 | |
| 137 /* | |
| 138 * Runs the effect on the haptic device. | |
| 139 * | |
| 140 * Returns 0 on success, -1 on error. | |
| 141 */ | |
|
2479
b9eb2cfe16cd
Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents:
2477
diff
changeset
|
142 extern int SDL_SYS_HapticRunEffect(SDL_Haptic * haptic, |
|
2517
37c13c12c878
Broke API by introducing iterations to SDL_HapticRunEffects().
Edgar Simo <bobbens@gmail.com>
parents:
2515
diff
changeset
|
143 struct haptic_effect * effect, |
|
2519
af9df9662807
More explicit with iterations and length.
Edgar Simo <bobbens@gmail.com>
parents:
2517
diff
changeset
|
144 Uint32 iterations); |
| 2491 | 145 |
| 146 /* | |
| 147 * Stops the effect on the haptic device. | |
| 148 * | |
| 149 * Returns 0 on success, -1 on error. | |
| 150 */ | |
|
2485
67978eea6d10
Added SDL_HapticStopEffect().
Edgar Simo <bobbens@gmail.com>
parents:
2484
diff
changeset
|
151 extern int SDL_SYS_HapticStopEffect(SDL_Haptic * haptic, |
| 2491 | 152 struct haptic_effect * effect); |
| 153 | |
| 154 /* | |
| 155 * Cleanups up the effect on the haptic device. | |
| 156 */ | |
|
2479
b9eb2cfe16cd
Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents:
2477
diff
changeset
|
157 extern void SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic, |
| 2491 | 158 struct haptic_effect * effect); |
| 159 | |
| 160 /* | |
|
2495
66c02abeef0e
Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents:
2491
diff
changeset
|
161 * Queries the device for the status of effect. |
|
66c02abeef0e
Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents:
2491
diff
changeset
|
162 * |
|
66c02abeef0e
Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents:
2491
diff
changeset
|
163 * Returns 0 if device is stopped, >0 if device is playing and |
|
66c02abeef0e
Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents:
2491
diff
changeset
|
164 * -1 on error. |
|
66c02abeef0e
Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents:
2491
diff
changeset
|
165 */ |
|
66c02abeef0e
Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents:
2491
diff
changeset
|
166 extern int SDL_SYS_HapticGetEffectStatus(SDL_Haptic * haptic, |
|
66c02abeef0e
Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents:
2491
diff
changeset
|
167 struct haptic_effect * effect); |
|
66c02abeef0e
Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents:
2491
diff
changeset
|
168 |
|
66c02abeef0e
Added SDL_HapticGetEffectStatus().
Edgar Simo <bobbens@gmail.com>
parents:
2491
diff
changeset
|
169 /* |
| 2491 | 170 * Sets the global gain of the haptic device. |
| 171 * | |
| 172 * Returns 0 on success, -1 on error. | |
| 173 */ | |
|
2483
9d52368ebcf5
Setting effects memory to 0.
Edgar Simo <bobbens@gmail.com>
parents:
2480
diff
changeset
|
174 extern int SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain); |
| 2491 | 175 |
| 176 /* | |
| 177 * Sets the autocenter feature of the haptic device. | |
| 178 * | |
| 179 * Returns 0 on success, -1 on error. | |
| 180 */ | |
| 181 extern int SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic, | |
| 182 int autocenter); | |
|
2472
3f73c88c9abb
First commit of the SDL_haptic subsystem.
Edgar Simo <bobbens@gmail.com>
parents:
diff
changeset
|
183 |
|
2479
b9eb2cfe16cd
Added some preliminary support for haptic effect control.
Edgar Simo <bobbens@gmail.com>
parents:
2477
diff
changeset
|
184 |