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

SDL_DestroyHapticEffect

Destroy a haptic effect on the device.

Header File

Defined in <SDL3/SDL_haptic.h>

Syntax

void SDL_DestroyHapticEffect(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 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryHaptic