Static Public Member Functions
static SIGNALPROCESSING_API TUniquePtr< IFFTAlgorithm >	NewFFTAlgorithm (const FFFTSettings &InSettings, const FName &InAlgorithmFactoryName=AnyAlgorithmFactory)

static SIGNALPROCESSING_API bool	AreFFTSettingsSupported (const FFFTSettings &InSettings, const FName &InAlgorithmFactoryName=AnyAlgorithmFactory)

Static Public Attributes
static SIGNALPROCESSING_API const FName	AnyAlgorithmFactory = FName(TEXT("AnyAlgorithmFactory"))

Detailed Description

FFFTFactory creates fft algorithms. It will choose hardware accelerated versions of the FFT when they are available.

Member Function Documentation

bool Audio::FFFTFactory::AreFFTSettingsSupported	(	const FFFTSettings &	InSettings,
		const FName &	InAlgorithmFactoryName = `AnyAlgorithmFactory`
	)

static

AreFFTSettingsSupported

Returns true if a valid FFT algorithm can be created which satifies the given settings.

Parameters

InSettings	- Settings describing desired FFT algorithm.
InAlgorithmFactoryName	- If not equal to FFFTFactory::AnyAlgorithmFactory, will only uses FFT algorithm facotry if IFFTAlgorithmFactory::GetFactoryName() equals InAlgorithmFactoryName.

TUniquePtr< IFFTAlgorithm > Audio::FFFTFactory::NewFFTAlgorithm	(	const FFFTSettings &	InSettings,
		const FName &	InAlgorithmFactoryName = `AnyAlgorithmFactory`
	)

static

NewFFTAlgorithm

Creates and returns a new FFTAlgorithm.

Parameters

InSettings	- The settings used to create the FFT algorithm.
InAlgorithmFactoryName	- If not equal to FFFTFactory::AnyAlgorithmFactory, will only uses FFT algorithm facotry if IFFTAlgorithmFactory::GetFactoryName() equals InAlgorithmFactoryName.

Returns: A TUniquePtr<IFFTAlgorithm> to the created FFT. This pointer can be invalid if an error occured or the fft algorithm could not be created.

const FName Audio::FFFTFactory::AnyAlgorithmFactory = FName(TEXT("AnyAlgorithmFactory"))

static

This denotes that no specific IFFTAlgorithmFactory is desired.

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