(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_HapticRunEffect

Run the haptic effect on its associated haptic device.

Header File

Syntax

int SDL_HapticRunEffect(SDL_Haptic * haptic,
                        int effect,
                        Uint32 iterations);

Function Parameters

SDL_Haptic *	haptic	the SDL_Haptic device to run the effect on.
int	effect	the ID of the haptic effect to run.
Uint32	iterations	the number of iterations to run the effect; use `SDL_HAPTIC_INFINITY` to repeat forever.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 2.0.0.