SDL_StopHapticEffect - Man Page

Stop the haptic effect on its associated haptic device.

Synopsis

#include <SDL3/SDL_haptic.h>

bool SDL_StopHapticEffect(SDL_Haptic *haptic, SDL_HapticEffectID effect);

Function Parameters

haptic

the SDL_Haptic device to stop the effect on.

effect

the ID of the haptic effect to stop.

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

SDL_RunHapticEffect(3), SDL_StopHapticEffects(3)

Referenced By

SDL_RunHapticEffect(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS