Wiki Page Content

Differences between revisions 5 and 6
Revision 5 as of 2013-06-12 21:34:01
Size: 1058
Comment: Updated return values to match SDL_haptic.h.
Revision 6 as of 2013-12-07 13:38:46
Size: 1057
Comment: Fixed typo.
Deletions are marked like this. Additions are marked like this.
Line 18: Line 18:
||'''effect'''||^the ID^ ,,identifier,, of the ^haptic^ effect to query ,,it's status,,|| ||'''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.

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 ID 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.


CategoryAPI, CategoryForceFeedback

None: SDL_HapticGetEffectStatus (last edited 2016-07-15 20:16:43 by PhilippWiesemann)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit