include/SDL_haptic.h
branchgsoc2008_force_feedback
changeset 2646 9408be170bff
parent 2645 269ba4f28d0e
--- a/include/SDL_haptic.h	Sun Aug 24 17:17:45 2008 +0000
+++ b/include/SDL_haptic.h	Sun Aug 24 17:32:50 2008 +0000
@@ -764,6 +764,8 @@
  * \sa SDL_HapticClose
  * \sa SDL_HapticSetGain
  * \sa SDL_HapticSetAutocenter
+ * \sa SDL_HapticPause
+ * \sa SDL_HapticStopAll
  */
 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index);
 
@@ -1080,7 +1082,7 @@
 /**
  * \fn extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic)
  *
- * \brief Pauses the haptic device.
+ * \brief Pauses a haptic device.
  *
  * Device must support the SDL_HAPTIC_PAUSE feature.  Call SDL_HapticUnpause
  *  to resume playback.
@@ -1098,17 +1100,27 @@
 /**
  * \fn extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic)
  *
- * \brief Unpauses the haptic device.
+ * \brief Unpauses a haptic device.
  *
  * Call to unpause after SDL_HapticPause.
  *
  *    \param haptic Haptic device to pause.
- *     \return 0 on success or -1 on error.
+ *    \return 0 on success or -1 on error.
  *
  * \sa SDL_HapticPause
  */
 extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic);
 
+/**
+ * \fn extern DECSLPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic)
+ *
+ * \brief Stops all the currently playing effects on a haptic device.
+ *
+ *    \param haptic Haptic device to stop.
+ *    \return 0 on success or -1 on error.
+ */
+extern DECLSPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic);
+
 
 /* Ends C function definitions when using C++ */
 #ifdef __cplusplus