NAME¶

SDL_HapticUpdateEffect - Update the properties of an effect.

SYNOPSIS¶

#include "SDL3/SDL.h"

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

DESCRIPTION¶

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

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.

AVAILABILITY¶

This function is available since SDL 3.0.0.

SEE ALSO¶

SDL_HapticDestroyEffect(3), SDL_HapticNewEffect(3), SDL_HapticRunEffect(3)