2 SDL - Simple DirectMedia Layer
3 Copyright (C) 2008 Edgar Simo
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
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
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with this library; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 #include "SDL_config.h"
25 #include "SDL_haptic.h"
29 * Number of haptic devices on the system.
31 extern Uint8 SDL_numhaptics;
36 SDL_HapticEffect effect; /* The current event */
37 struct haptic_hweffect *hweffect; /* The hardware behind the event */
41 * The real SDL_Haptic struct.
45 Uint8 index; /* Stores index it is attached to */
47 struct haptic_effect *effects; /* Allocated effects */
48 int neffects; /* Maximum amount of effects */
49 int nplaying; /* Maximum amount of effects to play at the same time */
50 unsigned int supported; /* Supported effects */
51 int naxes; /* Number of axes on the device. */
53 struct haptic_hwdata *hwdata; /* Driver dependent */
54 int ref_count; /* Count for multiple opens */
58 * Scans the system for haptic devices.
60 * Returns 0 on success, -1 on error.
62 extern int SDL_SYS_HapticInit(void);
65 * Gets the device dependent name of the haptic device
67 extern const char *SDL_SYS_HapticName(int index);
70 * Opens the haptic device for usage. The haptic device should have
71 * the index value set previously.
73 * Returns 0 on success, -1 on error.
75 extern int SDL_SYS_HapticOpen(SDL_Haptic * haptic);
78 * Returns the index of the haptic core pointer or -1 if none is found.
80 int SDL_SYS_HapticMouse(void);
83 * Checks to see if the joystick has haptic capabilities.
85 * Returns >0 if haptic capabilities are detected, 0 if haptic
86 * capabilities aren't detected and -1 on error.
88 extern int SDL_SYS_JoystickIsHaptic(SDL_Joystick * joystick);
91 * Opens the haptic device for usage using the same device as
94 * Returns 0 on success, -1 on error.
96 extern int SDL_SYS_HapticOpenFromJoystick(SDL_Haptic * haptic,
97 SDL_Joystick * joystick);
99 * Checks to see if haptic device and joystick device are the same.
101 * Returns 1 if they are the same, 0 if they aren't.
103 extern int SDL_SYS_JoystickSameHaptic(SDL_Haptic * haptic,
104 SDL_Joystick * joystick);
107 * Closes a haptic device after usage.
109 extern void SDL_SYS_HapticClose(SDL_Haptic * haptic);
112 * Performs a cleanup on the haptic subsystem.
114 extern void SDL_SYS_HapticQuit(void);
117 * Creates a new haptic effect on the haptic device using base
118 * as a template for the effect.
120 * Returns 0 on success, -1 on error.
122 extern int SDL_SYS_HapticNewEffect(SDL_Haptic * haptic,
123 struct haptic_effect *effect,
124 SDL_HapticEffect * base);
127 * Updates the haptic effect on the haptic device using data
130 * Returns 0 on success, -1 on error.
132 extern int SDL_SYS_HapticUpdateEffect(SDL_Haptic * haptic,
133 struct haptic_effect *effect,
134 SDL_HapticEffect * data);
137 * Runs the effect on the haptic device.
139 * Returns 0 on success, -1 on error.
141 extern int SDL_SYS_HapticRunEffect(SDL_Haptic * haptic,
142 struct haptic_effect *effect,
146 * Stops the effect on the haptic device.
148 * Returns 0 on success, -1 on error.
150 extern int SDL_SYS_HapticStopEffect(SDL_Haptic * haptic,
151 struct haptic_effect *effect);
154 * Cleanups up the effect on the haptic device.
156 extern void SDL_SYS_HapticDestroyEffect(SDL_Haptic * haptic,
157 struct haptic_effect *effect);
160 * Queries the device for the status of effect.
162 * Returns 0 if device is stopped, >0 if device is playing and
165 extern int SDL_SYS_HapticGetEffectStatus(SDL_Haptic * haptic,
166 struct haptic_effect *effect);
169 * Sets the global gain of the haptic device.
171 * Returns 0 on success, -1 on error.
173 extern int SDL_SYS_HapticSetGain(SDL_Haptic * haptic, int gain);
176 * Sets the autocenter feature of the haptic device.
178 * Returns 0 on success, -1 on error.
180 extern int SDL_SYS_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter);
183 * Pauses the haptic device.
185 * Returns 0 on success, -1 on error.
187 extern int SDL_SYS_HapticPause(SDL_Haptic * haptic);
190 * Unpauses the haptic device.
192 * Returns 0 on success, -1 on error.
194 extern int SDL_SYS_HapticUnpause(SDL_Haptic * haptic);
197 * Stops all the currently playing haptic effects on the device.
199 * Returns 0 on success, -1 on error.
201 extern int SDL_SYS_HapticStopAll(SDL_Haptic * haptic);