Mercurial > sdl-ios-xcode

comparison include/SDL_haptic.h @ 2645:269ba4f28d0e gsoc2008_force_feedback

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added support for pausing/unpausing haptic devices.
author Edgar Simo <bobbens@gmail.com>
date Sun, 24 Aug 2008 17:17:45 +0000
parents 776f7f800131
children 9408be170bff
comparison
equal deleted inserted replaced
2644:ef0ba67154c1 2645:269ba4f28d0e
238 * \brief Device can be queried for effect status. 238 * \brief Device can be queried for effect status.
239 * 239 *
240 * \sa SDL_HapticGetEffectStatus 240 * \sa SDL_HapticGetEffectStatus
241 */ 241 */
242 #define SDL_HAPTIC_STATUS (1<<14) /* Device can be queried for effect status */ 242 #define SDL_HAPTIC_STATUS (1<<14) /* Device can be queried for effect status */
243 /**
244 * \def SDL_HAPTIC_PAUSE
245 *
246 * \brief Device can be paused.
247 *
248 * \sa SDL_HapticPause
249 * \sa SDL_HapticUnpause
250 */
251 #define SDL_HAPTIC_PAUSE (1<<15) /* Device can be paused. */
243 252
244 253
245 /* 254 /*
246 * Direction encodings 255 * Direction encodings
247 */ 256 */
1066 * 1075 *
1067 * \sa SDL_HapticQuery 1076 * \sa SDL_HapticQuery
1068 */ 1077 */
1069 extern DECLSPEC int SDLCALL SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter); 1078 extern DECLSPEC int SDLCALL SDL_HapticSetAutocenter(SDL_Haptic * haptic, int autocenter);
1070 1079
1080 /**
1081 * \fn extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic)
1082 *
1083 * \brief Pauses the haptic device.
1084 *
1085 * Device must support the SDL_HAPTIC_PAUSE feature. Call SDL_HapticUnpause
1086 * to resume playback.
1087 *
1088 * Do not modify the effects nor add new ones while the device is paused.
1089 * That can cause all sorts of weird errors.
1090 *
1091 * \param haptic Haptic device to pause.
1092 * \return 0 on success or -1 on error.
1093 *
1094 * \sa SDL_HapticUnpause
1095 */
1096 extern DECLSPEC int SDLCALL SDL_HapticPause(SDL_Haptic * haptic);
1097
1098 /**
1099 * \fn extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic)
1100 *
1101 * \brief Unpauses the haptic device.
1102 *
1103 * Call to unpause after SDL_HapticPause.
1104 *
1105 * \param haptic Haptic device to pause.
1106 * \return 0 on success or -1 on error.
1107 *
1108 * \sa SDL_HapticPause
1109 */
1110 extern DECLSPEC int SDLCALL SDL_HapticUnpause(SDL_Haptic * haptic);
1111
1071 1112
1072 /* Ends C function definitions when using C++ */ 1113 /* Ends C function definitions when using C++ */
1073 #ifdef __cplusplus 1114 #ifdef __cplusplus
1074 /* *INDENT-OFF* */ 1115 /* *INDENT-OFF* */
1075 } 1116 }