UNiagaraDataInterfaceAudioSpectrum

Inheritance Hierarchy

References


Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceAudioSpectrum.h
Include	#include "NiagaraDataInterfaceAudioSpectrum.h"

Syntax

UCLASS (EditInlineNew, Category="Audio", Meta=(DisplayName="Audio Spectrum"), MinimalAPI)  
class UNiagaraDataInterfaceAudioSpectrum : public UNiagaraDataInterfaceAudioSubmix

Remarks

Data Interface allowing sampling of recent audio spectrum.

Variables

Type	Name	Description
float	MaximumFrequency	The maximum frequency represented in the spectrum.
float	MinimumFrequency	The minimum frequency represented in the spectrum.
float	NoiseFloorDb	The decibel level considered as silence. This is used to scale the output of the spectrum.
int32	Resolution	The number of spectrum samples to pass to the GPU

Constructors

	Type	Name	Description
		UNiagaraDataInterfaceAudioSpectrum ( const FObjectInitializer& ObjectInitializer )

Functions

Type	Name	Description
	BEGIN_SHADER_PARAMETER_STRUCT ( FShaderParameters )
void	GetNumChannels ( FVectorVMExternalFunctionContext& Context )
void	GetSpectrumValue ( FVectorVMExternalFunctionContext& Context )	VM function overrides:
NumChannels	SHADER_PARAMETER ( int, Resolution )

Overridden from UNiagaraDataInterface

Type	Name	Description
bool	AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor )	Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile.
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
bool	CopyToInternal ( UNiagaraDataInterface* Destination )
bool	Equals ( const UNiagaraDataInterface* Other )	Determines if this DataInterface is the same as another.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo, int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctionsInternal ( TArray< FNiagaraFunctionSignature >& OutFunctions )
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo, FString& OutHLSL )
void	GetVMExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo, void* InstanceData, FVMExternalFunction& OutFunc )	Returns the delegate for the passed function signature.
void	SetShaderParameters ( const FNiagaraDataInterfaceSetShaderParametersContext& Context )	Set the shader parameters will only be called if the data interface provided shader parameters.

Overridden from UNiagaraDataInterfaceBase

	Type	Name	Description
	void	BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder )	Override this method to provide parameters to the GPU (SRV / UAV / Constants / etc) The most common usage will be to provide a single structure which is nested with other parameters.

Overridden from UObject

Type	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )	Called when a property on this object has been modified externally
void	PostInitProperties ()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad ()	Do any object-specific cleanup required immediately after loading an object.