UNiagaraDataInterfaceSTWaveformDisplay is a custom Niagara data interface for waveform display query. This interface allows querying and manipulating waveform data with color parameters for various audio measurements. More...

#include <NiagaraDataInterfaceSTWaveformDisplay.h>

Public Member Functions
virtual void	PostInitProperties () override

virtual bool	CopyToInternal (UNiagaraDataInterface *Destination) const override

virtual void	GetFunctions (TArray< FNiagaraFunctionSignature > &OutFunctions) override

virtual void	GetVMExternalFunction (const FVMExternalFunctionBindingInfo &BindingInfo, void *InstanceData, FVMExternalFunction &OutFunc) 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	InitPerInstanceData (void PerInstanceData, FNiagaraSystemInstance SystemInstance) override

virtual void	DestroyPerInstanceData (void PerInstanceData, FNiagaraSystemInstance SystemInstance) override

virtual int32	PerInstanceDataSize () const override

virtual bool	HasPreSimulateTick () const override

virtual bool	PerInstanceTick (void PerInstanceData, FNiagaraSystemInstance SystemInstance, float DeltaSeconds) override

virtual void	ProvidePerInstanceDataForRenderThread (void DataForRenderThread, void PerInstanceData, const FNiagaraSystemInstanceID &SystemInstance) override

void	GetSolidColourVM (FVectorVMExternalFunctionContext &Context)

void	GetRandomColourInRangeVM (FVectorVMExternalFunctionContext &Context)

void	GetRandomColourVM (FVectorVMExternalFunctionContext &Context)

void	GetRandomColourHSVVM (FVectorVMExternalFunctionContext &Context)

void	GetMappedColourInWheelVM (FVectorVMExternalFunctionContext &Context)

void	GetMappedColourInRangeVM (FVectorVMExternalFunctionContext &Context)

Public Attributes
EAudioMeasurement	Measurement = EAudioMeasurement::Frequency

Detailed Description

UNiagaraDataInterfaceSTWaveformDisplay is a custom Niagara data interface for waveform display query. This interface allows querying and manipulating waveform data with color parameters for various audio measurements.

Member Function Documentation

◆ BuildShaderParameters()

void UNiagaraDataInterfaceSTWaveformDisplay::BuildShaderParameters ( FNiagaraShaderParametersBuilder & ShaderParametersBuilder ) const

overridevirtual

Build shader parameters for this data interface.

◆ CanExecuteOnTarget()

virtual bool UNiagaraDataInterfaceSTWaveformDisplay::CanExecuteOnTarget ( ENiagaraSimTarget Target ) const

inlineoverridevirtual

Check if the data interface can execute on the given target.

◆ CopyToInternal()

bool UNiagaraDataInterfaceSTWaveformDisplay::CopyToInternal ( UNiagaraDataInterface * Destination ) const

overridevirtual

Copy this data interface to another instance.

◆ DestroyPerInstanceData()

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

overridevirtual

Destroy per-instance data for the system instance.

◆ GetFunctions()

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

overridevirtual

Get all available functions for this data interface.

◆ GetMappedColourInRangeVM()

void UNiagaraDataInterfaceSTWaveformDisplay::GetMappedColourInRangeVM ( FVectorVMExternalFunctionContext & Context )

Get the mapped color in the specified range for the waveform in VM.

◆ GetMappedColourInWheelVM()

void UNiagaraDataInterfaceSTWaveformDisplay::GetMappedColourInWheelVM ( FVectorVMExternalFunctionContext & Context )

Get the mapped color on the color wheel for the waveform in VM.

◆ GetRandomColourHSVVM()

void UNiagaraDataInterfaceSTWaveformDisplay::GetRandomColourHSVVM ( FVectorVMExternalFunctionContext & Context )

Get a random color in HSV space for the waveform in VM.

◆ GetRandomColourInRangeVM()

void UNiagaraDataInterfaceSTWaveformDisplay::GetRandomColourInRangeVM ( FVectorVMExternalFunctionContext & Context )

Get a random color within a specified range for the waveform in VM.

◆ GetRandomColourVM()

void UNiagaraDataInterfaceSTWaveformDisplay::GetRandomColourVM ( FVectorVMExternalFunctionContext & Context )

Get a random color for the waveform in VM.

◆ GetSolidColourVM()

void UNiagaraDataInterfaceSTWaveformDisplay::GetSolidColourVM ( FVectorVMExternalFunctionContext & Context )

Get the solid color for the waveform in VM.

◆ GetVMExternalFunction()

void UNiagaraDataInterfaceSTWaveformDisplay::GetVMExternalFunction	(	const FVMExternalFunctionBindingInfo &	BindingInfo,
		void *	InstanceData,
		FVMExternalFunction &	OutFunc )

overridevirtual

Bind external functions to the virtual machine for this data interface.

◆ HasPreSimulateTick()

virtual bool UNiagaraDataInterfaceSTWaveformDisplay::HasPreSimulateTick ( ) const

inlineoverridevirtual

Check if pre-simulation ticking is required.

◆ InitPerInstanceData()

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

overridevirtual

Initialize per-instance data for the system instance.

◆ PerInstanceDataSize()

int32 UNiagaraDataInterfaceSTWaveformDisplay::PerInstanceDataSize ( ) const

overridevirtual

Return the size of the per-instance data.

◆ PerInstanceTick()

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

overridevirtual

Per-instance ticking functionality.

◆ PostInitProperties()

void UNiagaraDataInterfaceSTWaveformDisplay::PostInitProperties ( )

overridevirtual

Initialize properties after they have been initialized.

◆ ProvidePerInstanceDataForRenderThread()

void UNiagaraDataInterfaceSTWaveformDisplay::ProvidePerInstanceDataForRenderThread	(	void *	DataForRenderThread,
		void *	PerInstanceData,
		const FNiagaraSystemInstanceID &	SystemInstance )

overridevirtual

Provide per-instance data to the render thread.

◆ SetShaderParameters()

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

overridevirtual

Set shader parameters for this data interface.

Member Data Documentation

◆ Measurement

EAudioMeasurement UNiagaraDataInterfaceSTWaveformDisplay::Measurement = EAudioMeasurement::Frequency

Shader parameters for color customization of the waveform display. < The solid color for waveform display. < The first color range for waveform display. The second color range for waveform display. Defines the audio measurement to display on the waveform (e.g., Frequency).

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

C:/Users/aaron/UE5/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Public/Niagara/DataInterfaces/NiagaraDataInterfaceSTWaveformDisplay.h
C:/Users/aaron/UE5/FunWithShaders/Plugins/ST_VJMaster/Source/ST_AudioVisualisation/Private/Niagara/DataInterfaces/NiagaraDataInterfaceSTWaveformDisplay.cpp

	VJ Master 1.3 Real-time audio analysis and visualisation.

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ BuildShaderParameters()

◆ CanExecuteOnTarget()

◆ CopyToInternal()

◆ DestroyPerInstanceData()

◆ GetFunctions()

◆ GetMappedColourInRangeVM()

◆ GetMappedColourInWheelVM()

◆ GetRandomColourHSVVM()

◆ GetRandomColourInRangeVM()

◆ GetRandomColourVM()

◆ GetSolidColourVM()

◆ GetVMExternalFunction()

◆ HasPreSimulateTick()

◆ InitPerInstanceData()

◆ PerInstanceDataSize()

◆ PerInstanceTick()

◆ PostInitProperties()

◆ ProvidePerInstanceDataForRenderThread()

◆ SetShaderParameters()

Member Data Documentation

◆ Measurement