Effect¶
Amplitude effect asset.
Inherits the following classes: SparkyStudios::Audio::Amplitude::Asset
Detailed Description¶
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 parameter can be updated at runtime using a Rtpc.
See also: Rtpc, EffectInstance
Public Functions¶
| Type | Name |
|---|---|
| virtual std::shared_ptr< EffectInstance > | CreateInstance () const = 0 Creates an instance of this effect. |
| virtual void | Update () = 0 Updates the effect parameters on each frame. |
Public Functions inherited from SparkyStudios::Audio::Amplitude::Asset¶
See SparkyStudios::Audio::Amplitude::Asset
| Type | Name |
|---|---|
| virtual Id | GetId () const = 0 Returns the unique ID of this asset. |
| virtual const AmString & | GetName () const = 0 Gets the name of this asset. |
| virtual | ~Asset () = default Destroys the asset and all related resources. |
Public Functions Documentation¶
CreateInstance
Creates an instance of this effect.
Returns:
The effect instance.
See also: EffectInstance
The documentation for this class was generated from the following file: include/SparkyStudios/Audio/Amplitude/Sound/Effect.h