Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > UNiagaraDataInterface

Light Theme

Dark Theme

UNiagaraDataInterface

Base class for all Niagara data interfaces.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceAudioOscilloscope

UNiagaraDataInterfaceAudioSubmix

UNiagaraDataInterfaceAudioSpectrum

UNiagaraDataInterfaceCamera

UNiagaraDataInterfaceChaosDestruction

UNiagaraDataInterfaceCollisionQuery

UNiagaraDataInterfaceCurlNoise

UNiagaraDataInterfaceCurveBase

	UNiagaraDataInterfaceColorCurve
	UNiagaraDataInterfaceCurve
	UNiagaraDataInterfaceVector2DCurve
	UNiagaraDataInterfaceVector4Curve
	UNiagaraDataInterfaceVectorCurve

UNiagaraDataInterfaceExport

UNiagaraDataInterfaceHairStrands

UNiagaraDataInterfaceHoudiniCSV

UNiagaraDataInterfaceOcclusion

UNiagaraDataInterfaceParticleRead

UNiagaraDataInterfacePhysicsAsset

UNiagaraDataInterfaceRWBase

UNiagaraDataInterfaceGrid2D

UNiagaraDataInterfaceGrid2DCollection

UNiagaraDataInterfaceGrid3D

UNiagaraDataInterfaceNeighborGrid3D

UNiagaraDataInterfacePressureGrid

UNiagaraDataInterfaceSimpleCounter

UNiagaraDataInterfaceSkeletalMesh

UNiagaraDataInterfaceSpline

UNiagaraDataInterfaceStaticMesh

UNiagaraDataInterfaceTexture

UNiagaraDataInterfaceVectorField

UNiagaraDataInterfaceVolumeTexture

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, EditInlineNew)
class UNiagaraDataInterface : public UNiagaraDataInterfaceBase

Remarks

Base class for all Niagara data interfaces.

Variables

		Name	Description
	TUniquePtr< FNi...	Proxy

Constructors

	Name	Description
	UNiagaraDataInterface ( const FObjectInitializer& ObjectIn... )

Destructors

	Name	Description
	~UNiagaraDataInterface()

Functions

	Name	Description
bool	AppendCompileHash ( FNiagaraCompileHashVisitor* In... )	Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile.
ETickingGrou...	CalculateTickGroup ( void* PerInstanceData )
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
bool	CopyTo ( UNiagaraDataInterface* Destina... )	Copies the contents of this DataInterface to another.
bool	CopyToInternal ( UNiagaraDataInterface* Destina... )
void	DestroyPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* System... )	Destroys the per instance data for this interface.
bool	Equals ( const UNiagaraDataInterface* O... )	Determines if this DataInterface is the same as another.
void	GetCommonHLSL ( FString& OutHLSL )	Allows data interfaces to provide common functionality that will be shared across interfaces on that type.
void	GetEmitterDependencies ( void* PerInstanceData, FNiagaraSystemInstance* System..., TArray< FNiagaraEmitterInstance... )	Allows a DI to specify data dependencies between emitters, so the system can ensure that the emitter instances are executed in the correct order.
TArray< FNia...	GetErrors()	Refreshes and returns the errors detected with the corresponding data, if any.
void	GetFeedback ( UNiagaraDataInterface* DataInt..., TArray< FNiagaraDataInterfaceError ..., TArray< FNiagaraDataInterfaceFeedba..., TArray< FNiagaraDataInterfaceFeedba... )
void	GetFeedback ( UNiagaraSystem* InAsset, UNiagaraComponent* InComponent, TArray< FNiagaraDataInterfaceError ..., TArray< FNiagaraDataInterfaceFeedba..., TArray< FNiagaraDataInterfaceFeedba... )	Query the data interface to give feedback to the end user.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParam..., const FNiagaraDataInterfaceGenerate..., int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctions ( TArray< FNiagaraFunctionSignature >... )	Gets all the available functions for this data interface.
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParam..., FString& OutHLSL )
FNiagaraData...	GetProxy()
T *	GetProxyAs()
void	GetVMExternalFunction ( const FVMExternalFunctionBindingInf..., void* InstanceData, FVMExternalFunction& OutFunc )	Returns the delegate for the passed function signature.
bool	HasTickGroupPrereqs()
bool	InitPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* System... )	Initializes the per instance data for this interface.
bool	IsDataInterfaceType ( const FNiagaraTypeDefinition& Type... )	Determines if this type definition matches to a known data interface type.
FSimpleMulti...	OnErrorsRefreshed()
int32	PerInstanceDataPassedToRenderThreadSize()	The size of the data this class will provide to ProvidePerInstanceDataForRenderThread.
int32	PerInstanceDataSize()	Returns the size of the per instance data for this interface.
bool	PerInstanceTick ( void* PerInstanceData, FNiagaraSystemInstance* System..., float DeltaSeconds )	Ticks the per instance data for this interface, if it has any.
bool	PerInstanceTickPostSimulate ( void* PerInstanceData, FNiagaraSystemInstance* System..., float DeltaSeconds )
void	PostExecute()
void	ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread, void* PerInstanceData, const FNiagaraSystemInstanceID& Sy... )	Subclasses that wish to work with GPU systems/emitters must implement this.
void	RefreshErrors()
bool	RequiresDepthBuffer()
bool	RequiresDistanceFieldData()
bool	RequiresEarlyViewData()
bool	UpgradeFunctionCall ( FNiagaraFunctionSignature& Functio... )	Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.
void	ValidateFunction ( const FNiagaraFunctionSignature& F..., TArray< FText >& OutValidationErro... )	Validates a function being compiled and allows interface classes to post custom compile errors when their API changes.

Overridden from UObject

		Name	Description
	void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss