(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_HapticStopEffect

Stop the haptic effect on its associated haptic device.

Header File

Defined in SDL_haptic.h

Syntax

int SDL_HapticStopEffect(SDL_Haptic * haptic,
                         int effect);

Function Parameters

SDL_Haptic *	haptic	the SDL_Haptic device to stop the effect on.
int	effect	the ID of the haptic effect to stop.

Return Value

(int) 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 2.0.0.

See Also

• SDL_HapticDestroyEffect
• SDL_HapticRunEffect

---

CategoryAPI, CategoryAPIFunction, CategoryHaptic

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.