devela::_dep::sdl3::sys::haptic

Function SDL_RunHapticEffect

pub unsafe extern "C" fn SDL_RunHapticEffect(
    haptic: *mut SDL_Haptic,
    effect: i32,
    iterations: u32,
) -> bool
Available on crate feature dep_sdl3 only.
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.

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

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Availability

This function is available since SDL 3.2.0.

§See also