SDL_StopHapticEffects

Stop all the currently playing effects on a haptic device.

Header File

Defined in <SDL3/SDL_haptic.h>

Syntax

bool SDL_StopHapticEffects(SDL_Haptic *haptic);

Function Parameters

Return Value

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

Version

This function is available since SDL 3.2.0.

See Also

• SDL_RunHapticEffect
• SDL_StopHapticEffects

CategoryAPI, CategoryAPIFunction, CategoryHaptic