Mercurial > sdl-ios-xcode

comparison include/SDL_haptic.h @ 2646:9408be170bff gsoc2008_force_feedback

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added SDL_HapticStopAll. Cleaned up the dummy haptic driver a bit.
author Edgar Simo <bobbens@gmail.com>
date Sun, 24 Aug 2008 17:32:50 +0000
parents 269ba4f28d0e
children
comparison
equal deleted inserted replaced
2645:269ba4f28d0e 2646:9408be170bff
762 * \sa SDL_HapticOpenFromMouse 762 * \sa SDL_HapticOpenFromMouse
763 * \sa SDL_HapticOpenFromJoystick 763 * \sa SDL_HapticOpenFromJoystick
764 * \sa SDL_HapticClose 764 * \sa SDL_HapticClose
765 * \sa SDL_HapticSetGain 765 * \sa SDL_HapticSetGain
766 * \sa SDL_HapticSetAutocenter 766 * \sa SDL_HapticSetAutocenter
767 * \sa SDL_HapticPause
768 * \sa SDL_HapticStopAll
767 */ 769 */
768 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index); 770 extern DECLSPEC SDL_Haptic *SDLCALL SDL_HapticOpen(int device_index);
769 771
770 /** 772 /**
771 * \fn int SDL_HapticOpened(int device_index) 773 * \fn int SDL_HapticOpened(int device_index)
1078 extern DECLSPEC int SDLCALL SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter); 1080 extern DECLSPEC int SDLCALL SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter);
1079 1081
1080 /** 1082 /**
1081 * \fn extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic) 1083 * \fn extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic)
1082 * 1084 *
1083 * \brief Pauses the haptic device. 1085 * \brief Pauses a haptic device.
1084 * 1086 *
1085 * Device must support the SDL_HAPTIC_PAUSE feature. Call SDL_HapticUnpause 1087 * Device must support the SDL_HAPTIC_PAUSE feature. Call SDL_HapticUnpause
1086 * to resume playback. 1088 * to resume playback.
1087 * 1089 *
1088 * Do not modify the effects nor add new ones while the device is paused. 1090 * Do not modify the effects nor add new ones while the device is paused.
1096 extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic); 1098 extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic);
1097 1099
1098 /** 1100 /**
1099 * \fn extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic) 1101 * \fn extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic)
1100 * 1102 *
1101 * \brief Unpauses the haptic device. 1103 * \brief Unpauses a haptic device.
1102 * 1104 *
1103 * Call to unpause after SDL_HapticPause. 1105 * Call to unpause after SDL_HapticPause.
1104 * 1106 *
1105 * \param haptic Haptic device to pause. 1107 * \param haptic Haptic device to pause.
1106 * \return 0 on success or -1 on error. 1108 * \return 0 on success or -1 on error.
1107 * 1109 *
1108 * \sa SDL_HapticPause 1110 * \sa SDL_HapticPause
1109 */ 1111 */
1110 extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic); 1112 extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic);
1113
1114 /**
1115 * \fn extern DECSLPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic)
1116 *
1117 * \brief Stops all the currently playing effects on a haptic device.
1118 *
1119 * \param haptic Haptic device to stop.
1120 * \return 0 on success or -1 on error.
1121 */
1122 extern DECLSPEC int SDLCALL SDL_HapticStopAll(SDL_Haptic * haptic);
1111 1123
1112 1124
1113 /* Ends C function definitions when using C++ */ 1125 /* Ends C function definitions when using C++ */
1114 #ifdef __cplusplus 1126 #ifdef __cplusplus
1115 /* *INDENT-OFF* */ 1127 /* *INDENT-OFF* */