Skip to content

Effect

class Effect : public Asset<AmEffectID>

Amplitude Effect Asset.

An effect is a sound filter applied to one or more sound objects (sounds, collections, or switch containers) during playback.

Effects are customized using parameters and each parameters can be updated at runtime using a Rtpc.

See
Rtpc, EffectInstance

Functions

Name Description
Update Updates the effect parameters on each frames.
CreateInstance Creates an instance of this effect.
DestroyInstance Destroys an instance of this effect.

Function Details

CreateInstance

* CreateInstance() const

Creates an instance of this effect.

Return
The effect instance.

DestroyInstance

virtual void DestroyInstance(EffectInstance* instance) const = 0

Destroys an instance of this effect.

Parameter instance
The effect instance to delete.

Update

virtual void Update() = 0

Updates the effect parameters on each frames.