NAME¶

SDL_HapticStopEffect - Stop the haptic effect on its associated haptic device.

SYNOPSIS¶

#include "SDL3/SDL.h"

int SDL_HapticStopEffect(SDL_Haptic * haptic,
                         int effect);

DESCRIPTION¶

*

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.

AVAILABILITY¶

This function is available since SDL 3.0.0.

SEE ALSO¶

SDL_HapticDestroyEffect(3), SDL_HapticRunEffect(3)