UNiagaraDataInterfaceSTAudio Class Reference

This class serves as a data interface for interacting with audio data in Niagara systems. It provides access to audio buffers such as IO data, frequency bands, amplitudes, and pitches for use in Niagara effects. More...

#include <NiagaraDataInterfaceSTAudio.h>

Public Member Functions
void	SetSTAudioBuffers (FST_AudioIOData_GameThread InST_AudioIOData_GT)
virtual void	PostInitProperties () override
virtual void	GetFunctions (TArray< FNiagaraFunctionSignature > &OutFunctions) override
virtual bool	CanExecuteOnTarget (ENiagaraSimTarget Target) const override
virtual void	BuildShaderParameters (FNiagaraShaderParametersBuilder &ShaderParametersBuilder) const override
virtual void	SetShaderParameters (const FNiagaraDataInterfaceSetShaderParametersContext &Context) const override
virtual bool	HasPreSimulateTick () const override
virtual bool	PerInstanceTick (void *PerInstanceData, FNiagaraSystemInstance *SystemInstance, float DeltaSeconds) override
virtual int32	PerInstanceDataSize () const override
virtual bool	InitPerInstanceData (void *PerInstanceData, FNiagaraSystemInstance *SystemInstance) override
virtual void	DestroyPerInstanceData (void *PerInstanceData, FNiagaraSystemInstance *SystemInstance) override

Detailed Description

This class serves as a data interface for interacting with audio data in Niagara systems. It provides access to audio buffers such as IO data, frequency bands, amplitudes, and pitches for use in Niagara effects.

UNiagaraDataInterfaceSTAudio class, derived from UNiagaraDataInterface.

Member Function Documentation

BuildShaderParameters()

void UNiagaraDataInterfaceSTAudio::BuildShaderParameters ( FNiagaraShaderParametersBuilder & ShaderParametersBuilder ) const

overridevirtual

Builds the shader parameters for this data interface.

Parameters

ShaderParametersBuilder

The builder used to configure shader parameters.

CanExecuteOnTarget()

virtual bool UNiagaraDataInterfaceSTAudio::CanExecuteOnTarget ( ENiagaraSimTarget Target ) const

inlineoverridevirtual

Determines if the data interface can be executed on the specified Niagara simulation target.

Parameters

Target

The Niagara simulation target.

Returns

True if the target is GPUComputeSim, otherwise false.

DestroyPerInstanceData()

void UNiagaraDataInterfaceSTAudio::DestroyPerInstanceData ( void * PerInstanceData, FNiagaraSystemInstance * SystemInstance )

overridevirtual

Destroys the per-instance data for this data interface.

Parameters

PerInstanceData	The per-instance data to destroy.
SystemInstance	The Niagara system instance.

GetFunctions()

void UNiagaraDataInterfaceSTAudio::GetFunctions ( TArray< FNiagaraFunctionSignature > & OutFunctions )

overridevirtual

Retrieves a list of available functions that can be executed on this data interface.

Parameters

OutFunctions

The array to populate with available function signatures.

HasPreSimulateTick()

virtual bool UNiagaraDataInterfaceSTAudio::HasPreSimulateTick ( ) const

inlineoverridevirtual

Determines if the data interface requires a pre-simulate tick.

Returns

True if a pre-simulate tick is required, otherwise false.

InitPerInstanceData()

bool UNiagaraDataInterfaceSTAudio::InitPerInstanceData ( void * PerInstanceData, FNiagaraSystemInstance * SystemInstance )

overridevirtual

Initializes the per-instance data for this data interface.

Parameters

PerInstanceData	The per-instance data to initialize.
SystemInstance	The Niagara system instance.

Returns

True if the per-instance data was successfully initialized, otherwise false.

PerInstanceDataSize()

int32 UNiagaraDataInterfaceSTAudio::PerInstanceDataSize ( ) const

overridevirtual

Retrieves the size of the per-instance data.

Returns

The size of the per-instance data.

PerInstanceTick()

bool UNiagaraDataInterfaceSTAudio::PerInstanceTick ( void * PerInstanceData, FNiagaraSystemInstance * SystemInstance, float DeltaSeconds )

overridevirtual

Executes a tick for each instance of the Niagara system.

Parameters

PerInstanceData	The instance data to tick.
SystemInstance	The Niagara system instance.
DeltaSeconds	The delta time for the tick.

Returns

True if the tick was successful, otherwise false.

PostInitProperties()

void UNiagaraDataInterfaceSTAudio::PostInitProperties ( )

overridevirtual

Initializes the object properties after they are initialized.

SetShaderParameters()

void UNiagaraDataInterfaceSTAudio::SetShaderParameters ( const FNiagaraDataInterfaceSetShaderParametersContext & Context ) const

overridevirtual

Sets the shader parameters for this data interface.

Parameters

Context

The context used to set the shader parameters.

SetSTAudioBuffers()

void UNiagaraDataInterfaceSTAudio::SetSTAudioBuffers ( FST_AudioIOData_GameThread InST_AudioIOData_GT )

inline

Sets the audio buffers used for ST Audio.

Parameters

InST_AudioIOData_GT

The audio I/O data to be set.

---

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

• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Niagara/DataInterfaces/NiagaraDataInterfaceSTAudio.h
• H:/Games/Unreal/Aaron/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Niagara/DataInterfaces/NiagaraDataInterfaceSTAudio.cpp