Man page - sdl_stophapticeffect(3)

Packages contains this manual

Package:  libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:
• libsdl3-doc
• libsdl3-dev

Manual

SDL_StopHapticEffect

NAME
HEADER FILE
SYNOPSIS
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY
SEE ALSO

---

NAME

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

HEADER FILE

Defined in SDL3/SDL_haptic.h

SYNOPSIS

#include "SDL3/SDL.h"

bool SDL_StopHapticEffect(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 true on success or false on failure; call

SDL_GetError () for more information.

AVAILABILITY

This function is available since SDL 3.2.0.

SEE ALSO

• (3), SDL_RunHapticEffect (3), • (3), SDL_StopHapticEffects (3)

---