(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_PauseHaptic

Pause a haptic device.

Header File

Defined in <SDL3/SDL_haptic.h>

Syntax

int SDL_PauseHaptic(SDL_Haptic *haptic);

Function Parameters

haptic the SDL_Haptic device to pause

Return Value

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_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.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryHaptic