UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
Audio::IFFTAlgorithm Class Referenceabstract

#include <FFTAlgorithm.h>

+ Inheritance diagram for Audio::IFFTAlgorithm:

Public Member Functions

virtual SIGNALPROCESSING_API ~IFFTAlgorithm ()
 
virtual int32 Size () const =0
 
int32 NumInputFloats () const
 
int32 NumOutputFloats () const
 
virtual EFFTScaling ForwardScaling () const =0
 
virtual EFFTScaling InverseScaling () const =0
 
virtual void ForwardRealToComplex (const float *RESTRICT InReal, float *RESTRICT OutComplex)=0
 
virtual void InverseComplexToReal (const float *RESTRICT InComplex, float *RESTRICT OutReal)=0
 
virtual void BatchForwardRealToComplex (int32 InCount, const float *const RESTRICT InReal[], float *RESTRICT OutComplex[])=0
 
virtual void BatchInverseComplexToReal (int32 InCount, const float *const RESTRICT InComplex[], float *RESTRICT OutReal[])=0
 

Detailed Description

IFFTAlgorithm

Interface for FFT algorithm.

Constructor & Destructor Documentation

◆ ~IFFTAlgorithm()

Audio::IFFTAlgorithm::~IFFTAlgorithm ( )
virtual

virtual destructor for inheritance.

Member Function Documentation

◆ BatchForwardRealToComplex()

virtual void Audio::IFFTAlgorithm::BatchForwardRealToComplex ( int32  InCount,
const float *const RESTRICT  InReal[],
float *RESTRICT  OutComplex[] 
)
pure virtual

BatchForwardRealToComplex

Perform the forward FFT on real data and produce complex data.

Parameters
InCount- The number of transforms to compute.
InReal- Array of array of floats to input into fourier transform. Must have InCount elements, each containing NumInputFloats() elements.
OutComplex- Array of array of floats to store output of fourier transform. Must have InCount elements, each with NumOutputFloats()elements which represent complex numbers in interleaved format.

Implemented in Audio::FVectorRealToComplexFFT.

◆ BatchInverseComplexToReal()

virtual void Audio::IFFTAlgorithm::BatchInverseComplexToReal ( int32  InCount,
const float *const RESTRICT  InComplex[],
float *RESTRICT  OutReal[] 
)
pure virtual

BatchInverseComplexToReal

Perform the inverse FFT on complex data and produce real data.

Parameters
InCount- The number of transforms to compute.
InComplex- Array of array of floats to input into inverse fourier transform. Must have InCount elements, each with NumOutputFloats() elements which represent complex numbers in interleaved format.
OutReal- Array of array of floats to store output of inverse fourier transform. Must have InCount elements, each with NumInputFloats() elements.

Implemented in Audio::FVectorRealToComplexFFT.

◆ ForwardRealToComplex()

virtual void Audio::IFFTAlgorithm::ForwardRealToComplex ( const float *RESTRICT  InReal,
float *RESTRICT  OutComplex 
)
pure virtual

ForwardRealToComplex

Perform the forward FFT on real data and produce complex data.

Parameters
InReal- Array of floats to input into fourier transform. Must have NumInputFloats() elements.
OutComplex- Array of floats to store output of fourier transform. Must have NumOutputFloats() elements which represent (NumOutputFloats() / 2) complex numbers in interleaved format.

Implemented in Audio::FVectorRealToComplexFFT.

◆ ForwardScaling()

virtual EFFTScaling Audio::IFFTAlgorithm::ForwardScaling ( ) const
pure virtual

Scaling applied when performing forward FFT.

Implemented in Audio::FVectorRealToComplexFFT.

◆ InverseComplexToReal()

virtual void Audio::IFFTAlgorithm::InverseComplexToReal ( const float *RESTRICT  InComplex,
float *RESTRICT  OutReal 
)
pure virtual

InverseComplexToReal

Perform the inverse FFT on complex data and produce real data.

Parameters
InComplex- Array of floats to input into inverse fourier transform. Must have NumOutputFloats() elements which represent complex numbers in interleaved format.
OutReal- Array of floats to store output of inverse fourier transform. Must have NumInputFloats() elements.

Implemented in Audio::FVectorRealToComplexFFT.

◆ InverseScaling()

virtual EFFTScaling Audio::IFFTAlgorithm::InverseScaling ( ) const
pure virtual

Scaling applied when performing inverse FFT.

Implemented in Audio::FVectorRealToComplexFFT.

◆ NumInputFloats()

int32 Audio::IFFTAlgorithm::NumInputFloats ( ) const
inline

Number of floats expected in input.

◆ NumOutputFloats()

int32 Audio::IFFTAlgorithm::NumOutputFloats ( ) const
inline

Number of floats produced in output.

◆ Size()

virtual int32 Audio::IFFTAlgorithm::Size ( ) const
pure virtual

Number of elements in FFT

Implemented in Audio::FVectorRealToComplexFFT.

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