Wiki Page Content

Differences between revisions 1 and 5 (spanning 4 versions)
Revision 1 as of 2010-03-22 18:27:48
Size: 939
Editor: SheenaSmith
Comment: create page, add content (Rev 5321)
Revision 5 as of 2016-07-15 20:38:10
Size: 1006
Comment: Added Version section.
Deletions are marked like this. Additions are marked like this.
Line 6: Line 6:
Use this function to stop the haptic effect on ''its associated'' haptic device. Use this function to stop the haptic effect on its associated haptic device.
Line 17: Line 17:
||'''haptic'''||^a pointer to the^ haptic device to stop the effect on|| ||'''haptic'''||^the^ SDL_Haptic device to stop the effect on||
Line 21: Line 21:
Returns 0 on success, or -1 on failure; call [[SDL_GetError]]() for more information. Returns 0 on success or a negative error code on failure; call [[SDL_GetError]]() for more information.
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

ID 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