SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


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

Header File

Defined in <SDL3/SDL_haptic.h>


int SDL_GetHapticEffectStatus(SDL_Haptic *haptic, int effect);

Function Parameters

SDL_Haptic * haptic the SDL_Haptic device to query for the effect status on.
int effect the ID of the haptic effect to query its status.

Return Value

(int) 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.


Device must support the SDL_HAPTIC_STATUS feature.


This function is available since SDL 3.0.0.

CategoryAPI, CategoryAPIFunction, CategoryHaptic

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.