|
Size: 1344
Comment: update content for consistency
|
Size: 1322
Comment: update content - standard return value
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 23: | Line 23: |
| Returns the ID of the effect on success,,, or -1 on error,, ^or a negative error code on failure^; call [[SDL_GetError]]() for more information. | Returns the ID of the effect on success or a negative error code on failure; call [[SDL_GetError]]() for more information. |
DRAFT |
SDL_HapticUpdateEffect
Use this function to update the properties of an effect.
Contents
Syntax
int SDL_HapticUpdateEffect(SDL_Haptic* haptic,
int effect,
SDL_HapticEffect* data)
Function Parameters
haptic |
a pointer to the haptic device that has the effect |
effect |
the index of the effect to update |
data |
a pointer to the new effect properties to use |
Return Value
Returns the ID of the effect 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().
