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

#include <ConvolutionAlgorithm.h>

Static Public Member Functions

static SIGNALPROCESSING_API TUniquePtr< IConvolutionAlgorithmNewConvolutionAlgorithm (const FConvolutionSettings &InSettings, const FName &InAlgorithmFactoryName=AnyAlgorithmFactory)
 

Static Public Attributes

static SIGNALPROCESSING_API const FName AnyAlgorithmFactory = FName(TEXT("AnyAlgorithmFactory"))
 

Detailed Description

FConvolutionFactory

FConvolutionFactory creates convolution algorithms. It will choose hardware accelerated versions when they are available.

Member Function Documentation

◆ NewConvolutionAlgorithm()

TUniquePtr< IConvolutionAlgorithm > Audio::FConvolutionFactory::NewConvolutionAlgorithm ( const FConvolutionSettings InSettings,
const FName InAlgorithmFactoryName = AnyAlgorithmFactory 
)
static

NewConvolutionAlgorithm

Creates and returns a new ConvolutionAlgorithm.

Parameters
InSettings- The settings used to create the Convolution algorithm.
InAlgorithmFactoryName- If not equal to FConvolutionFactory::AnyAlgorithmFactory, will only uses Convolution algorithm facotry if IConvolutionAlgorithmFactory::GetFactoryName() equals InAlgorithmFactoryName.
Returns
A TUniquePtr<IConvolutionAlgorithm> to the created Convolution. This pointer can be invalid if an error occured or the fft algorithm could not be created.

Member Data Documentation

◆ AnyAlgorithmFactory

const FName Audio::FConvolutionFactory::AnyAlgorithmFactory = FName(TEXT("AnyAlgorithmFactory"))
static

This denotes that no specific IConvolutionAlgorithmFactory is desired.


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