#pragma section-numbers off
#pragma disable-camelcase
||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||

= SDL_HapticPause =
Use this function to pause a haptic device.

<<TableOfContents()>>

== Syntax ==
{{{#!highlight cpp
int SDL_HapticPause(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.

== Code Examples ==
{{{#!highlight cpp
You can add your code example here
}}}

== 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.

== Related Functions ==
 .[[SDL_HapticUnpause]]

----
[[CategoryAPI]], [[CategoryForceFeedback]]