Function sdl2_sys::SDL_HapticPause

source · 
pub unsafe extern "C" fn SDL_HapticPause(
    haptic: *mut SDL_Haptic
) -> c_int
Expand description

Pause a haptic device.

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.

\param haptic the SDL_Haptic device to pause \returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_HapticUnpause