---
name: "SDL_RunHapticEffect"
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_RunHapticEffect"
---

# SDL\_RunHapticEffect(3)

Run the haptic effect on its associated haptic device.

## NAME

SDL\_RunHapticEffect - Run the haptic effect on its associated haptic device.

## HEADER FILE

Defined in SDL3/SDL\_haptic.h

## SYNOPSIS

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

**bool SDL\_RunHapticEffect(SDL\_Haptic \*haptic, int effect, Uint32 iterations);**

## DESCRIPTION

To repeat the effect over and over indefinitely, set **iterations** to

**SDL\_HAPTIC\_INFINITY** . (Repeats the envelope - attack and fade.) To make one instance of the effect last indefinitely (so the effect does not fade), set the effect's **length** in its structure/union to  **SDL\_HAPTIC\_INFINITY** instead.

## FUNCTION PARAMETERS

- *haptic*

  the  **SDL\_Haptic**\
    device to run the effect on.

- *effect*

  the ID of the haptic effect to run.

- *iterations*

  the number of iterations to run the effect; use  **SDL\_HAPTIC\_INFINITY** to repeat forever.

## RETURN VALUE

Returns true on success or false on failure; call

**SDL\_GetError** () for more information.

## AVAILABILITY

This function is available since SDL 3.2.0.

## SEE ALSO

**•**(3), [**SDL\_GetHapticEffectStatus**(3)](/SDL_GetHapticEffectStatus/3.md), **•**(3), [**SDL\_StopHapticEffect**(3)](/SDL_StopHapticEffect/3.md), **•**(3), [**SDL\_StopHapticEffects**(3)](/SDL_StopHapticEffects/3.md)