SDL_RunHapticEffect3
Run the haptic effect on its associated haptic device.
Usage
#include "SDL3/SDL.h"
bool SDL_RunHapticEffect(SDL_Haptic *haptic, int effect, Uint32 iterations);
Header file
Defined in SDL3/SDL_haptic.h
Overview
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_INFINITYto repeat forever.
Return value
Returns true on success or false on failure; call
SDL_GetError () for more information.