Mercurial > sdl-ios-xcode
diff include/SDL_haptic.h @ 2517:37c13c12c878 gsoc2008_force_feedback
Broke API by introducing iterations to SDL_HapticRunEffects().
Fixed minor issues.
author | Edgar Simo <bobbens@gmail.com> |
---|---|
date | Thu, 10 Jul 2008 17:54:08 +0000 |
parents | 030fc4375e63 |
children | af9df9662807 |
line wrap: on
line diff
--- a/include/SDL_haptic.h Thu Jul 10 17:52:57 2008 +0000 +++ b/include/SDL_haptic.h Thu Jul 10 17:54:08 2008 +0000 @@ -70,7 +70,7 @@ * effect_id = SDL_HapticNewEffect( haptic, &effect ); * * // Test the effect - * SDL_HapticRunEffect( haptic, effect_id ); + * SDL_HapticRunEffect( haptic, effect_id, 1 ); * SDL_Delay( 5000); // Wait for the effect to finish * * // We destroy the effect, although closing the device also does this @@ -263,6 +263,19 @@ #define SDL_HAPTIC_CARTESIAN 1 +/* + * Misc defines. + */ +/** + * \def SDL_HAPTIC_INFINITY + * + * \brief Used to play a device an infinite number of times. + * + * \sa SDL_HapticRunEffect + */ +#define SDL_HAPTIC_INFINITY -1 + + /** * \struct SDL_HapticDirection * @@ -681,7 +694,7 @@ * * \sa SDL_HapticOpenFromMouse */ -extern DECLSPEC SDL_MouseIsHaptic(void); +extern DECLSPEC int SDL_MouseIsHaptic(void); /** * \fn SDL_Haptic * SDL_HapticOpenFromMouse(void) @@ -830,19 +843,21 @@ extern DECLSPEC int SDL_HapticUpdateEffect(SDL_Haptic * haptic, int effect, SDL_HapticEffect * data); /** - * \fn int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect) + * \fn int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, int iterations) * * \brief Runs the haptic effect on it's assosciated haptic device. * * \param haptic Haptic device to run the effect on. * \param effect Identifier of the haptic effect to run. + * \param iterations Number of iterations to run the effect. Use + * SDL_HAPTIC_INFINITY for infinity. * \return 0 on success or -1 on error. * * \sa SDL_HapticStopEffect * \sa SDL_HapticDestroyEffect * \sa SDL_HapticGetEffectStatus */ -extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect); +extern DECLSPEC int SDL_HapticRunEffect(SDL_Haptic * haptic, int effect, int iterations); /** * \fn int SDL_HapticStopEffect(SDL_Haptic * haptic, int effect)