Wiki Page Content

Differences between revisions 3 and 6 (spanning 3 versions)
Revision 3 as of 2010-09-24 23:15:02
Size: 953
Editor: SheenaSmith
Comment: minor change
Revision 6 as of 2016-07-15 20:39:45
Size: 1006
Comment: Removed old formatting.
Deletions are marked like this. Additions are marked like this.
Line 17: Line 17:
||'''haptic'''||^a pointer to the^ haptic device to stop the effect on||
||'''effect'''||^ID^ ,,identifier,, of the ^haptic^ effect to stop||
||'''haptic'''||the SDL_Haptic device to stop the effect on||
||'''effect'''||the /* ID */ identifier of the haptic effect to stop||
Line 31: Line 31:
== Version ==
This function is available since SDL 2.0.0.

DRAFT

SDL_HapticStopEffect

Use this function to stop the haptic effect on its associated haptic device.

Syntax

int SDL_HapticStopEffect(SDL_Haptic* haptic,
                         int         effect)

Function Parameters

haptic

the SDL_Haptic device to stop the effect on

effect

the identifier of the haptic effect to stop

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

You can add useful comments here

Version

This function is available since SDL 2.0.0.


CategoryAPI, CategoryForceFeedback

None: SDL_HapticStopEffect (last edited 2016-07-15 20:39:45 by PhilippWiesemann)

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