Wiki Page Content

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


CategoryAPI, CategoryForceFeedback

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

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