UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Attributes | List of all members
Audio::FVectorRealToComplexFFT Class Reference

#include <VectorFFT.h>

+ Inheritance diagram for Audio::FVectorRealToComplexFFT:

Public Member Functions

 FVectorRealToComplexFFT (int32 InLog2Size)
 
virtual ~FVectorRealToComplexFFT ()
 
virtual int32 Size () const override
 
virtual EFFTScaling ForwardScaling () const override
 
virtual EFFTScaling InverseScaling () const override
 
virtual void ForwardRealToComplex (const float *RESTRICT InReal, float *RESTRICT OutComplex) override
 
virtual void InverseComplexToReal (const float *RESTRICT InComplex, float *RESTRICT OutReal) override
 
virtual void BatchForwardRealToComplex (int32 InCount, const float *const RESTRICT InReal[], float *RESTRICT OutComplex[]) override
 
virtual void BatchInverseComplexToReal (int32 InCount, const float *const RESTRICT InComplex[], float *RESTRICT OutReal[]) override
 
- Public Member Functions inherited from Audio::IFFTAlgorithm
virtual SIGNALPROCESSING_API ~IFFTAlgorithm ()
 
int32 NumInputFloats () const
 
int32 NumOutputFloats () const
 

Static Public Attributes

static const int32 MinLog2FFTSize = FVectorComplexFFT::MinLog2FFTSize + 1
 
static const int32 MaxLog2FFTSize = FVectorComplexFFT::MaxLog2FFTSize + 1
 

Constructor & Destructor Documentation

◆ FVectorRealToComplexFFT()

Audio::FVectorRealToComplexFFT::FVectorRealToComplexFFT ( int32  InLog2Size)

Construct a FVectorRealToComplex FFT

Parameters
InLog2Size- Determines the size of the FFT. FFTSize = 2^InLog2Size.

◆ ~FVectorRealToComplexFFT()

Audio::FVectorRealToComplexFFT::~FVectorRealToComplexFFT ( )
virtual

Member Function Documentation

◆ BatchForwardRealToComplex()

void Audio::FVectorRealToComplexFFT::BatchForwardRealToComplex ( int32  InCount,
const float *const RESTRICT  InReal[],
float *RESTRICT  OutComplex[] 
)
overridevirtual

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 FFTSize() elements.
OutComplex- Array of array of floats to store output of fourier transform. Must have InCount elements, each with (FFTSize() + 2) float elements which represent ((FFTSize() / 2) + 1) complex numbers in interleaved format.

Implements Audio::IFFTAlgorithm.

◆ BatchInverseComplexToReal()

void Audio::FVectorRealToComplexFFT::BatchInverseComplexToReal ( int32  InCount,
const float *const RESTRICT  InComplex[],
float *RESTRICT  OutReal[] 
)
overridevirtual

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 (FFTSize() + 2) float elements which represent ((FFTSize() / 2) + 1) complex numbers in interleaved format.
OutReal- Array of array of floats to store output of inverse fourier transform. Must have InCount elements, each with FFTSize() float elements.

Implements Audio::IFFTAlgorithm.

◆ ForwardRealToComplex()

void Audio::FVectorRealToComplexFFT::ForwardRealToComplex ( const float *RESTRICT  InReal,
float *RESTRICT  OutComplex 
)
overridevirtual

ForwardRealToComplex

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

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

Implements Audio::IFFTAlgorithm.

◆ ForwardScaling()

EFFTScaling Audio::FVectorRealToComplexFFT::ForwardScaling ( ) const
overridevirtual

Scaling applied when performing forward FFT.

Implements Audio::IFFTAlgorithm.

◆ InverseComplexToReal()

void Audio::FVectorRealToComplexFFT::InverseComplexToReal ( const float *RESTRICT  InComplex,
float *RESTRICT  OutReal 
)
overridevirtual

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 (FFTSize() + 2) float elements which represent ((FFTSize() / 2) + 1) complex numbers in interleaved format.
OutReal- Array of floats to store output of inverse fourier transform. Must have FFTSize() elements.

Implements Audio::IFFTAlgorithm.

◆ InverseScaling()

EFFTScaling Audio::FVectorRealToComplexFFT::InverseScaling ( ) const
overridevirtual

Scaling applied when performing inverse FFT.

Implements Audio::IFFTAlgorithm.

◆ Size()

int32 Audio::FVectorRealToComplexFFT::Size ( ) const
overridevirtual

Number of elements in FFT

Implements Audio::IFFTAlgorithm.

Member Data Documentation

◆ MaxLog2FFTSize

const int32 Audio::FVectorRealToComplexFFT::MaxLog2FFTSize = FVectorComplexFFT::MaxLog2FFTSize + 1
static

Maximum log 2 size of fft

◆ MinLog2FFTSize

const int32 Audio::FVectorRealToComplexFFT::MinLog2FFTSize = FVectorComplexFFT::MinLog2FFTSize + 1
static

Minimum log2 size of fft.

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