NAME¶

SDL_PauseHaptic - Pause a haptic device.

SYNOPSIS¶

#include "SDL3/SDL.h"

int SDL_PauseHaptic(SDL_Haptic *haptic);

DESCRIPTION¶

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.

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.

AVAILABILITY¶

This function is available since SDL 3.0.0.

SEE ALSO¶

SDL_ResumeHaptic(3)