|
Size: 1309
Comment: Fixed SDL_HapticUpdateEffect() return value information.
|
Size: 1371
Comment: Added Version section.
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 33: | Line 33: |
| == Version == This function is available since SDL 2.0.0. |
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 |
the SDL_Haptic device that has the effect |
effect |
the index 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 -1 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.
