Wiki Page Content

Differences between revisions 2 and 3
Revision 2 as of 2010-09-13 04:43:15
Size: 1089
Editor: SheenaSmith
Comment: update content - standard return value
Revision 3 as of 2010-09-22 23:04:32
Size: 1071
Editor: SheenaSmith
Comment: update content - standard return value
Deletions are marked like this. Additions are marked like this.
Line 21: Line 21:
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. Returns 0 if it isn't playing, SDL_HAPTIC_PLAYING if it is playing, or a negative error code on failure; 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.

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; 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