Wiki Page Content

Differences between revisions 2 and 4 (spanning 2 versions)
Revision 2 as of 2010-09-03 17:03:59
Size: 926
Editor: SheenaSmith
Comment: update content - standard return value
Revision 4 as of 2017-02-19 20:49:17
Size: 915
Comment: Removed old formatting.
Deletions are marked like this. Additions are marked like this.
Line 16: Line 16:
||'''haptic'''||^a pointer to the^ haptic device to pause|| ||'''haptic'''||the SDL_Haptic device to pause||

DRAFT

SDL_HapticPause

Use this function to pause a haptic device.

Syntax

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

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.


CategoryAPI, CategoryForceFeedback

None: SDL_HapticPause (last edited 2017-02-19 20:49:17 by PhilippWiesemann)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit