1. Epic GamesDeveloper
  3. FVolumeFader

FVolumeFader

Control-rate fader for managing volume fades of various standard shapes.

API > API/Runtime > API/Runtime/SignalProcessing > API/Runtime/SignalProcessing/DSP

References

   
Module SignalProcessing
Header /Engine/Source/Runtime/SignalProcessing/Public/DSP/VolumeFader.h
Include #include "DSP/VolumeFader.h"

Syntax

class FVolumeFader

Remarks

Control-rate fader for managing volume fades of various standard shapes.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Activates the fader if currently deactivated. Sets duration to indefinite (-1.0f)
Public function void Deactivates the fader, causing it to remain at the current value and disregard update.
Public function Const float Gets time fader is to remain active (-1.0f if always active).
Public function Const EFaderCurve Returns the curve type of the fader
Public function Const float Returns the duration of the fade.
Public function Const float Returns the target volume of the fader
Public function Const float Returns current volume of fader
Public function Const float

GetVolumeAfterTime ( float InDeltaTime
)

 Returns the volume given the delta from the current time into the future (Effectively like running to retrieve volume but without actually updating internal state).
Public function Const bool Whether or not the fader is active.
Public function Const bool Returns whether or not the fader is currently fading over time.
Public function Const bool Returns whether or not the fader is currently fading over time and value is increasing.
Public function Const bool Returns whether or not the fader is currently fading over time and value is decreasing.
Public function void

SetActiveDuration ( float InDuration
)

 Sets the duration the fader is to be active in the future, after which point the fader is disabled.
Public function void

SetVolume ( float InVolume
)

 Sets the volume immediately, interrupting any currently active fade.
Public function void

StartFade ( float InVolume,
float InDuration,
EFaderCurve InCurve
)

 Applies a volume fade over time with the provided parameters.
Public function void Stops fade, maintaining the current value as the target.
Public function void

Update ( float InDeltaTime
)

 Updates the fader's state with the given delta in time since last update.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page