SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Run the haptic effect on its associated haptic device.

Header File

Defined in <SDL3/SDL_haptic.h>


int SDL_RunHapticEffect(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.


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 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryHaptic

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.