Skip to content

Rtpc

Amplitude Real-Time Parameter Control asset.

Inherits the following classes: SparkyStudios::Audio::Amplitude::Asset

Detailed Description

A RTPC is a value updated by the game. The engine listens to any update on the RTPC to propagate the changes to other parameters linked to it.

A Rtpc object is shared between any objects and values linked to it.

Public Functions

Type Name
virtual AmReal64 GetDefaultValue () const = 0
Gets the default value of this RTPC.
virtual AmReal64 GetMaxValue () const = 0
Gets the maximum value of this RTPC.
virtual AmReal64 GetMinValue () const = 0
Gets the minimum value of this RTPC.
virtual AmReal64 GetValue () const = 0
Gets the current value of this RTPC.
virtual void Reset () = 0
Resets the current RTPC value to the default value.
virtual void SetValue (AmReal64 value) = 0
Sets the current value of this RTPC.
virtual void Update (AmTime deltaTime) = 0
Updates the value of the RTPC.

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

GetDefaultValue

Gets the default value of this RTPC. 

virtual AmReal64 Amplitude::Rtpc::GetDefaultValue () const = 0

Returns:

The default RTPC value.

GetMaxValue

Gets the maximum value of this RTPC. 

virtual AmReal64 Amplitude::Rtpc::GetMaxValue () const = 0

Returns:

The RTPC maximum value.

GetMinValue

Gets the minimum value of this RTPC. 

virtual AmReal64 Amplitude::Rtpc::GetMinValue () const = 0

Returns:

The RTPC minimum value.

GetValue

Gets the current value of this RTPC. 

virtual AmReal64 Amplitude::Rtpc::GetValue () const = 0

Returns:

The current RTPC value.

Reset

Resets the current RTPC value to the default value. 

virtual void Amplitude::Rtpc::Reset () = 0
SetValue

Sets the current value of this RTPC. 

virtual void Amplitude::Rtpc::SetValue (
    AmReal64 value
) = 0

Parameters:

  • value The value to set.
Update

Updates the value of the RTPC. 

virtual void Amplitude::Rtpc::Update (
    AmTime deltaTime
) = 0

This method is useful only for RTPCs that are using a curve to update their value.

Parameters:

  • deltaTime The time elapsed since the last update.

The documentation for this class was generated from the following file: include/SparkyStudios/Audio/Amplitude/Sound/Rtpc.h