Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

IFilter

Base class for filters usable in synthesis.

Windows

MacOS

Linux

Inheritance Hierarchy

IFilter

References

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

Syntax

class IFilter

Remarks

Base class for filters usable in synthesis.

Variables

	Name	Description
float	BaseFrequency	The base filter cutoff frequency.
float	BaseQ	The base.
bool	bChanged
float	ExternalModFrequency	A modulatied frequency driven externally.
float	ExternalModQ	An external modulation of Q.
EFilter::Type	FilterType	The filter type of the filter.
float	Frequency	The cutoff frequency currently used by the filter (can be modulated)
FPatchDestinati...	ModCutoffFrequencyDest	Mod matrix patchable destinations.
float	ModFrequency	A modulated frequency.
FModulationMatr...	ModMatrix
float	ModQ	The modulated Q.
FPatchDestinati...	ModQDest
int32	NumChannels	Number of channels of the sound.
float	Q	The current Q.
float	SampleRate	Sample rate of the filter.
int32	VoiceId	The voice id of the owner of the filter (for use with mod matrix)

Constructors

	Name	Description
	IFilter()

Destructors

	Name	Description
	~IFilter()

Functions

	Name	Description
float	GetGCoefficient()
FPatchDestin...	GetModDestCutoffFrequency()	Filter patch destinations.
FPatchDestin...	GetModDestQ()
void	Init ( const float InSampleRate, const int32 InNumChannels, const int32 InVoiceId, FModulationMatrix* InModMatrix )	Initialize the filter.
void	ProcessAudio ( const float* InBuffer, const int32 InNumSamples, float* OutBuffer )	Process an audio buffer.
void	ProcessAudioFrame ( const float* InFrame, float* OutFrame )	Processes a single frame of audio. Number of channels MUST be what was used during filter initialization.
void	Reset()	Reset the filter.
void	SetBandStopControl ( const float InBandStop )	Sets the band stop control param (not used on all filters)
void	SetFilterType ( const EFilter::Type InFilterType )	Sets the filter type.
void	SetFrequency ( const float InCutoffFrequency )	Sets the cutoff frequency of the filter.
void	SetFrequencyMod ( const float InModFrequency )	Sets an external modulated frequency.
void	SetPassBandGainCompensation ( const float InPassBandGainCompensat... )	Sets the band pass gain compensation (not used on all filters)
void	SetQ ( const float InQ )	Sets the quality/resonance of the filter.
void	SetQMod ( const float InModQ )	Sets an external modulated quality/resonance of the filter.
void	SetSaturation ( const float InSaturation )	Sets the filter saturation (not used on all filters)
void	Update()	Updates the filter.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss