SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Update the properties of an effect.

Header File

Defined in <SDL3/SDL_haptic.h>


int SDL_UpdateHapticEffect(SDL_Haptic *haptic, int effect, const SDL_HapticEffect *data);

Function Parameters

SDL_Haptic * haptic the SDL_Haptic device that has the effect.
int effect the identifier of the effect to update.
const SDL_HapticEffect * data an SDL_HapticEffect structure containing the new effect properties to use.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.


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_UpdateHapticEffect().


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryHaptic

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.