UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Audio::FLadderFilter Class Reference

#include <Filter.h>

+ Inheritance diagram for Audio::FLadderFilter:

Public Member Functions

SIGNALPROCESSING_API FLadderFilter ()
 
virtual SIGNALPROCESSING_API ~FLadderFilter ()
 
virtual SIGNALPROCESSING_API void Init (const float InSampleRate, const int32 InNumChannels, const int32 InVoiceId=0, FModulationMatrix *InModMatrix=nullptr) override
 
virtual SIGNALPROCESSING_API void Reset () override
 
virtual SIGNALPROCESSING_API void Update () override
 
virtual SIGNALPROCESSING_API void SetQ (const float InQ) override
 
virtual SIGNALPROCESSING_API void SetPassBandGainCompensation (const float InPassBandGainCompensation) override
 
virtual SIGNALPROCESSING_API void ProcessAudio (const float *InSamples, const int32 InNumSamples, float *OutSamples) override
 
virtual SIGNALPROCESSING_API void ProcessAudio (const float *const *InBuffers, const int32 InNumSamples, float *const *OutBuffers) override
 
SIGNALPROCESSING_API void ArrayCalculateResponseInPlace (TArrayView< float > InOutComplexValues) const
 
- Public Member Functions inherited from Audio::IFilter
SIGNALPROCESSING_API IFilter ()
 
SIGNALPROCESSING_API IFilter (const IFilter &)
 
virtual SIGNALPROCESSING_API ~IFilter ()
 
virtual SIGNALPROCESSING_API void SetFrequency (const float InCutoffFrequency)
 
virtual SIGNALPROCESSING_API void SetFrequencyMod (const float InModFrequency)
 
virtual SIGNALPROCESSING_API void SetQMod (const float InModQ)
 
virtual void SetSaturation (const float InSaturation)
 
virtual void SetBandStopControl (const float InBandStop)
 
virtual SIGNALPROCESSING_API void SetFilterType (const EFilter::Type InFilterType)
 
virtual void ProcessAudioFrame (const float *InFrame, float *OutFrame)
 
FPatchDestination GetModDestCutoffFrequency () const
 
FPatchDestination GetModDestQ () const
 

Protected Attributes

FOnePoleFilter OnePoleFilters [4]
 
float Beta [4]
 
float K
 
float Gamma
 
float Alpha
 
float Factors [5]
 
float PassBandGainCompensation
 
- Protected Attributes inherited from Audio::IFilter
int32 VoiceId
 
float SampleRate
 
int32 NumChannels
 
float Frequency
 
float BaseFrequency
 
float ModFrequency
 
float ExternalModFrequency
 
float Q
 
float ModQ
 
float BaseQ
 
float ExternalModQ
 
EFilter::Type FilterType
 
FModulationMatrixModMatrix
 
FPatchDestination ModCutoffFrequencyDest
 
FPatchDestination ModQDest
 
bool bChanged
 

Additional Inherited Members

- Protected Member Functions inherited from Audio::IFilter
float GetGCoefficient () const
 

Constructor & Destructor Documentation

◆ FLadderFilter()

Audio::FLadderFilter::FLadderFilter ( )

◆ ~FLadderFilter()

Audio::FLadderFilter::~FLadderFilter ( )
virtual

Member Function Documentation

◆ ArrayCalculateResponseInPlace()

void Audio::FLadderFilter::ArrayCalculateResponseInPlace ( TArrayView< float InOutComplexValues) const

◆ Init()

void Audio::FLadderFilter::Init ( const float  InSampleRate,
const int32  InNumChannels,
const int32  InVoiceId = 0,
FModulationMatrix InModMatrix = nullptr 
)
overridevirtual

Reimplemented from Audio::IFilter.

◆ ProcessAudio() [1/2]

void Audio::FLadderFilter::ProcessAudio ( const float *const *  InBuffers,
const int32  InNumSamples,
float *const *  OutBuffers 
)
overridevirtual

Implements Audio::IFilter.

◆ ProcessAudio() [2/2]

void Audio::FLadderFilter::ProcessAudio ( const float InSamples,
const int32  InNumSamples,
float OutSamples 
)
overridevirtual

Implements Audio::IFilter.

◆ Reset()

void Audio::FLadderFilter::Reset ( )
overridevirtual

Reimplemented from Audio::IFilter.

◆ SetPassBandGainCompensation()

void Audio::FLadderFilter::SetPassBandGainCompensation ( const float  InPassBandGainCompensation)
overridevirtual

Reimplemented from Audio::IFilter.

◆ SetQ()

void Audio::FLadderFilter::SetQ ( const float  InQ)
overridevirtual

Reimplemented from Audio::IFilter.

◆ Update()

void Audio::FLadderFilter::Update ( )
overridevirtual

Reimplemented from Audio::IFilter.

Member Data Documentation

◆ Alpha

float Audio::FLadderFilter::Alpha
protected

◆ Beta

float Audio::FLadderFilter::Beta[4]
protected

◆ Factors

float Audio::FLadderFilter::Factors[5]
protected

◆ Gamma

float Audio::FLadderFilter::Gamma
protected

◆ K

float Audio::FLadderFilter::K
protected

◆ OnePoleFilters

FOnePoleFilter Audio::FLadderFilter::OnePoleFilters[4]
protected

◆ PassBandGainCompensation

float Audio::FLadderFilter::PassBandGainCompensation
protected

The documentation for this class was generated from the following files: