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

SDL_HapticPause

Pause a haptic device.

Header File

Defined in SDL_haptic.h

Syntax

int SDL_HapticPause(SDL_Haptic * haptic);

Function Parameters

SDL_Haptic *

haptic

the SDL_Haptic device to pause.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

Device must support the SDL_HAPTIC_PAUSE feature. Call SDL_HapticUnpause() 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 2.0.0.

See Also

• SDL_HapticUnpause

---

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.