|
⇤ ← Revision 1 as of 2010-03-22 19:50:02
Size: 1046
Comment: create page, add content (Rev 5321)
|
Size: 1089
Comment: update content - standard return value
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 18: | Line 18: |
| ||'''effect'''||^ID^ ,,identifier,, of the ^haptic^ effect to query ,,it's status,,|| | ||'''effect'''||^the ID^ ,,identifier,, of the ^haptic^ effect to query ,,it's status,,|| |
| Line 21: | Line 21: |
| Returns 0 if it isn't playing, SDL_HAPTIC_PLAYING if it is playing, or -1 on error; call [[SDL_GetError]]() for more information. | Returns 0 if it isn't playing, SDL_HAPTIC_PLAYING if it is playing, ^or a negative error code on failure^,, -1 on error,,; call [[SDL_GetError]]() for more information. |
DRAFT |
SDL_HapticGetEffectStatus
Use this function to get the status of the current effect on the specified haptic device.
Contents
Syntax
int SDL_HapticGetEffectStatus(SDL_Haptic* haptic,
int effect)
Function Parameters
haptic |
the haptic device to query for the effect status on |
effect |
the ID identifier of the haptic effect to query it's status |
Return Value
Returns 0 if it isn't playing, SDL_HAPTIC_PLAYING if it is playing, or a negative error code on failure -1 on error; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
Device must support the SDL_HAPTIC_STATUS feature.
