SDL_StopHapticEffect(3)

SDL_StopHapticEffect3

Stop the haptic effect on its associated haptic device.

Usage

#include "SDL3/SDL.h"

bool SDL_StopHapticEffect(SDL_Haptic *haptic, int effect);

Header file

Defined in SDL3/SDL_haptic.h

Function parameters

haptic

the SDL_Haptic
device to stop the effect on.

effect

the ID of the haptic effect to stop.

Return value

Returns true on success or false on failure; call

SDL_GetError () for more information.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.