(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_HapticDestroyEffect

Destroy a haptic effect on the device.

Header File

Defined in SDL_haptic.h

Syntax

void SDL_HapticDestroyEffect(SDL_Haptic * haptic,
                             int effect);

Function Parameters

haptic the SDL_Haptic device to destroy the effect on
effect the ID of the haptic effect to destroy

Remarks

This will stop the effect if it's running. Effects are automatically destroyed when the device is closed.

Version

This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryHaptic