Scroll to navigation

SDL_UpdateHapticEffect(3) SDL3 FUNCTIONS SDL_UpdateHapticEffect(3)

NAME

SDL_UpdateHapticEffect - Update the properties of an effect.

SYNOPSIS

#include "SDL3/SDL.h"
int SDL_UpdateHapticEffect(SDL_Haptic *haptic, int effect, const 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_UpdateHapticEffect ().

FUNCTION PARAMETERS

the SDL_Haptic
device that has the effect
the identifier of the effect to update
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_CreateHapticEffect(3), SDL_RunHapticEffect(3)

SDL 3.1.0 SDL