|
Size: 1119
Comment: Added Version section.
|
← Revision 8 as of 2016-07-15 20:16:43 ⇥
Size: 1099
Comment: Removed old formatting.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 6: | Line 6: |
| Use this function to get the status of the current effect on the ^specified^ haptic device. | Use this function to get the status of the current effect on the specified haptic device. |
| Line 17: | Line 17: |
| ||'''haptic'''||^the^ SDL_Haptic device to query ^for^ ,,the,, effect status ,,on,,|| ||'''effect'''||^the ID^ ,,identifier,, of the ^haptic^ effect to query ,,its status,,|| |
||'''haptic'''||the SDL_Haptic device to query for the effect status on|| ||'''effect'''||the /* ID */ identifier of the haptic effect to query its status|| |
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 SDL_Haptic device to query for the effect status on |
effect |
the identifier of the haptic effect to query its status |
Return Value
Returns 0 if it isn't playing, 1 if it is playing, or a negative error code on failure; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
Device must support the SDL_HAPTIC_STATUS feature.
Version
This function is available since SDL 2.0.0.
