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

Draft

THIS PAGE IS A WORK IN PROGRESS ... Please make edits to this page to improve it!

SDL_HapticStopEffect

Stop the haptic effect on its associated haptic device.

Syntax

int SDL_HapticStopEffect(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.

Remarks

Version

This function is available since SDL 3.0.0.


CategoryAPI, CategoryForceFeedback, CategoryDraft