---
name: "SDL_GetHapticEffectStatus"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_GetHapticEffectStatus"
---

# SDL\_GetHapticEffectStatus(3)

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

## NAME

SDL\_GetHapticEffectStatus - Get the status of the current effect on the specified haptic device.

## HEADER FILE

Defined in SDL3/SDL\_haptic.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**bool SDL\_GetHapticEffectStatus(SDL\_Haptic \*haptic, int effect);**

## DESCRIPTION

Device must support the  **SDL\_HAPTIC\_STATUS**\
  feature.

## 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 true if it is playing, false if it isn't playing or haptic status isn't supported.

## AVAILABILITY

This function is available since SDL 3.2.0.

## SEE ALSO

**•**(3), [**SDL\_GetHapticFeatures**(3)](/SDL_GetHapticFeatures/3.md)
