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

Function SDL_UpdateHapticEffect

pub unsafe extern "C" fn SDL_UpdateHapticEffect(
    haptic: *mut SDL_Haptic,
    effect: i32,
    data: *const SDL_HapticEffect,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Update the properties of an effect.

Can be used dynamically, although behavior when dynamically changing direction may be strange. Specifically the effect may re-upload itself and start playing from the start. You also cannot change the type either when running SDL_UpdateHapticEffect().

§Parameters

  • haptic: the SDL_Haptic device that has the effect.
  • effect: the identifier of the effect to update.
  • data: an SDL_HapticEffect structure containing the new effect properties to use.

§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