include/SDL_haptic.h
branchgsoc2008_force_feedback
changeset 2646 9408be170bff
parent 2645 269ba4f28d0e
     1.1 --- a/include/SDL_haptic.h	Sun Aug 24 17:17:45 2008 +0000
     1.2 +++ b/include/SDL_haptic.h	Sun Aug 24 17:32:50 2008 +0000
     1.3 @@ -764,6 +764,8 @@
     1.4   * \sa SDL_HapticClose
     1.5   * \sa SDL_HapticSetGain
     1.6   * \sa SDL_HapticSetAutocenter
     1.7 + * \sa SDL_HapticPause
     1.8 + * \sa SDL_HapticStopAll
     1.9   */
    1.10  extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index);
    1.11  
    1.12 @@ -1080,7 +1082,7 @@
    1.13  /**
    1.14   * \fn extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic)
    1.15   *
    1.16 - * \brief Pauses the haptic device.
    1.17 + * \brief Pauses a haptic device.
    1.18   *
    1.19   * Device must support the SDL_HAPTIC_PAUSE feature.  Call SDL_HapticUnpause
    1.20   *  to resume playback.
    1.21 @@ -1098,17 +1100,27 @@
    1.22  /**
    1.23   * \fn extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic)
    1.24   *
    1.25 - * \brief Unpauses the haptic device.
    1.26 + * \brief Unpauses a haptic device.
    1.27   *
    1.28   * Call to unpause after SDL_HapticPause.
    1.29   *
    1.30   *    \param haptic Haptic device to pause.
    1.31 - *     \return 0 on success or -1 on error.
    1.32 + *    \return 0 on success or -1 on error.
    1.33   *
    1.34   * \sa SDL_HapticPause
    1.35   */
    1.36  extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic);
    1.37  
    1.38 +/**
    1.39 + * \fn extern DECSLPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic)
    1.40 + *
    1.41 + * \brief Stops all the currently playing effects on a haptic device.
    1.42 + *
    1.43 + *    \param haptic Haptic device to stop.
    1.44 + *    \return 0 on success or -1 on error.
    1.45 + */
    1.46 +extern DECLSPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic);
    1.47 +
    1.48  
    1.49  /* Ends C function definitions when using C++ */
    1.50  #ifdef __cplusplus