(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_StopHapticEffect

Stop the haptic effect on its associated haptic device.

Header File

Defined in <SDL3/SDL_haptic.h>

Syntax

int SDL_StopHapticEffect(SDL_Haptic *haptic, int 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 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Version

This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryHaptic