Wiki Page Content

DRAFT

SDL_HapticUpdateEffect

Use this function to update the properties of an effect.

Syntax

int SDL_HapticUpdateEffect(SDL_Haptic*       haptic,
                           int               effect,
                           SDL_HapticEffect* data)

Function Parameters

haptic

the SDL_Haptic device that has the effect

effect

the identifier of the effect to update

data

an SDL_HapticEffect structure containing the new effect properties to use

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

Can be used dynamically, although behavior when dynamically changing direction may be strange. Specifically the effect may re-upload itself and start playing from the start. You also cannot change the type either when running SDL_HapticUpdateEffect().

Version

This function is available since SDL 2.0.0.


CategoryAPI, CategoryForceFeedback

None: SDL_HapticUpdateEffect (last edited 2017-03-25 22:53:21 by PhilippWiesemann)

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