Function sdl2_sys::SDL_HapticRunEffect

source · 
pub unsafe extern "C" fn SDL_HapticRunEffect(
    haptic: *mut SDL_Haptic,
    effect: c_int,
    iterations: Uint32,
) -> c_int
Expand description

Run the haptic effect on its associated haptic device.

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.

\param haptic the SDL_Haptic device to run the effect on \param effect the ID of the haptic effect to run \param iterations the number of iterations to run the effect; use SDL_HAPTIC_INFINITY to repeat forever \returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_HapticDestroyEffect \sa SDL_HapticGetEffectStatus \sa SDL_HapticStopEffect