Mercurial > sdl-ios-xcode

comparison include/SDL_haptic.h @ 2536:fe3ee345a5d2 gsoc2008_force_feedback

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed some typos in the doxygen.
author Edgar Simo <bobbens@gmail.com>
date Sat, 19 Jul 2008 16:06:43 +0000
parents f0ed8471497d
children 2681a04c2d3d
comparison
equal deleted inserted replaced
2535:f0ed8471497d 2536:fe3ee345a5d2
210 */ 210 */
211 #define SDL_HAPTIC_FRICTION (1<<10) /* Friction effect supported - uses axes movement */ 211 #define SDL_HAPTIC_FRICTION (1<<10) /* Friction effect supported - uses axes movement */
212 /** 212 /**
213 * \def SDL_HAPTIC_CUSTOM 213 * \def SDL_HAPTIC_CUSTOM
214 * 214 *
215 * \brief User defined custom haptic effect. @todo. 215 * \brief User defined custom haptic effect.
216 */ 216 */
217 #define SDL_HAPTIC_CUSTOM (1<<11) /* Custom effect is supported */ 217 #define SDL_HAPTIC_CUSTOM (1<<11) /* Custom effect is supported */
218 /* These last two are features the device has, not effects */ 218 /* These last two are features the device has, not effects */
219 /** 219 /**
220 * \def SDL_HAPTIC_GAIN 220 * \def SDL_HAPTIC_GAIN
260 * 260 *
261 * \sa SDL_HapticDirection 261 * \sa SDL_HapticDirection
262 */ 262 */
263 #define SDL_HAPTIC_CARTESIAN 1 263 #define SDL_HAPTIC_CARTESIAN 1
264 /** 264 /**
265 * \def SDL_HAPTIC_SHPERICAL 265 * \def SDL_HAPTIC_SPHERICAL
266 * 266 *
267 * \brief Uses spherical coordinates for the direction. 267 * \brief Uses spherical coordinates for the direction.
268 * 268 *
269 * \sa SDL_HapticDirection 269 * \sa SDL_HapticDirection
270 */ 270 */
945 * \sa SDL_HapticDestroyEffect 945 * \sa SDL_HapticDestroyEffect
946 */ 946 */
947 extern DECLSPEC int SDLCALL SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data); 947 extern DECLSPEC int SDLCALL SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data);
948 948
949 /** 949 /**
950 * \fn int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, int iterations) 950 * \fn int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, Uint32 iterations)
951 * 951 *
952 * \brief Runs the haptic effect on it's assosciated haptic device. 952 * \brief Runs the haptic effect on it's assosciated haptic device.
953 * 953 *
954 * If iterations are SDL_HAPTIC_INFINITY, it'll run the effect over and over 954 * If iterations are SDL_HAPTIC_INFINITY, it'll run the effect over and over
955 * repeating the envelope (attack and fade) every time. If you only want the 955 * repeating the envelope (attack and fade) every time. If you only want the