SDL_RunHapticEffect - Run the haptic effect on its associated haptic device.
Contents
Availability
This function is available since SDL 3.2.0.
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.
Header File
Defined in SDL3/SDL_haptic.h
Name
SDL_RunHapticEffect - Run the haptic effect on its associated haptic device.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
See Also
•(3), SDL_GetHapticEffectStatus(3), •(3), SDL_StopHapticEffect(3), •(3), SDL_StopHapticEffects(3) Simple Directmedia Layer SDL 3.2.10 SDL_RunHapticEffect(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_RunHapticEffect(SDL_Haptic*haptic,inteffect,Uint32iterations);
