plucky (3) SDL_StopHapticEffect.3.gz

Provided by: libsdl3-doc_3.2.4+ds-2_all bug

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)