1. Epic GamesDeveloper
  3. FGain

FGain

[FGain](API\Plugins\MetasoundStandardNodes\FGain) represents a gain value.

API > API/Plugins > API/Plugins/MetasoundStandardNodes

References

   
Module MetasoundStandardNodes
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundStandardNodes/Public/MetasoundGain.h
Include #include "MetasoundGain.h"

Syntax

class FGain

Remarks

FGain represents a gain value. It provides clearly defined getters and setters as well as several convenience functions for converting gain to decibels.

Constructors

  Type Name Description
Public function  

FGain ()

 Construct gain of 1
Public function  

FGain ( float InValue
)

 FGain constructor used to pass in float literals from the metasound frontend.
Public function  

FGain ( float InValue,
EGainRepresentation InRep
)

 Construct a Gain with a given value and representation.

Functions

  Type Name Description
Public function Const float Get the gain in decibels
Public function Const float Return the gain in LinearScale.
Public function void

SetDecibels ( float InDecibels
)

 Set the gain in decibels
Public function void

SetLinear ( float InLinearScale
)

 Set the gain in LinearScale

Operators

  Type Name Description
Public function Const   Implicit operator used for math operations.
Public function FGain &

operator*= ( const FGain& InOther
)

  
Public function FGain &

operator/= ( const FGain& InOther
)

  
Public function FGain &

operator+= ( const FGain& InOther
)

  
Public function FGain &

operator-= ( const FGain& InOther
)

  

Constants

Name Description
DefaultGain  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page