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

Draft

THIS PAGE IS A WORK IN PROGRESS ... Please make edits to this page to improve it!

SDL_HapticUpdateEffect

Update the properties of an effect.

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

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 3.0.0.

SDL_HapticDestroyEffect
SDL_HapticNewEffect
SDL_HapticRunEffect

CategoryAPI, CategoryForceFeedback, CategoryDraft


[ 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.