SDL_RunHapticEffect - Man Page
Run the haptic effect on its associated haptic device.
Synopsis
#include <SDL3/SDL_haptic.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
for more information.
Availability
This function is available since SDL 3.2.0.
See Also
SDL_GetHapticEffectStatus(3), SDL_StopHapticEffect(3), SDL_StopHapticEffects(3)
Referenced By
SDL_CreateHapticEffect(3), SDL_HAPTIC_INFINITY(3), SDL_StopHapticEffect(3), SDL_StopHapticEffects(3), SDL_UpdateHapticEffect(3).