THIS PAGE IS A WORK IN PROGRESS ... Please make edits to this page to improve it!
Run the haptic effect on its associated haptic device.
int SDL_HapticRunEffect(SDL_Haptic * haptic,
int effect,
Uint32 iterations);
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 |
Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
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.
This function is available since SDL 2.0.0.
CategoryAPI, CategoryForceFeedback, CategoryDraft