(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_PauseHaptic

Pause a haptic device.

Header File

Defined in <SDL3/SDL_haptic.h>

Syntax

bool SDL_PauseHaptic(SDL_Haptic *haptic);

Function Parameters

SDL_Haptic *

haptic

the SDL_Haptic device to pause.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

Device must support the SDL_HAPTIC_PAUSE feature. Call SDL_ResumeHaptic() to resume playback.

Do not modify the effects nor add new ones while the device is paused. That can cause all sorts of weird errors.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_ResumeHaptic

---

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.