====== (This is the documentation for SDL3, which is under heavy development and the API is changing! [https://wiki.libsdl.org/SDL2/ SDL2] is the current stable version!) ======

== Draft ==

'''THIS PAGE IS A WORK IN PROGRESS''' ... Please make edits to this page to improve it!
= SDL_HapticGetEffectStatus =

Get the status of the current effect on the specified haptic device.

== Syntax ==

<syntaxhighlight lang='c'>
int SDL_HapticGetEffectStatus(SDL_Haptic * haptic,
                              int effect);
</syntaxhighlight>

== Function Parameters ==

{|
|'''haptic'''
|the [[SDL_Haptic]] device to query for the effect status on
|-
|'''effect'''
|the ID 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.

== Remarks ==

Device must support the [[SDL_HAPTIC_STATUS]] feature.

== Version ==

This function is available since SDL 3.0.0.

== Related Functions ==

:[[SDL_HapticRunEffect]]
:[[SDL_HapticStopEffect]]

----
[[CategoryAPI]], [[CategoryForceFeedback]], [[CategoryDraft]]