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 > UNiagaraDataInterfaceExport

Light Theme

Dark Theme

UNiagaraDataInterfaceExport

This Data Interface can be used to gather particles at execution time and call either a C++ or blueprint object with the gathered particle data each tick.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceExport

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Category="Export", Meta=(DisplayName="Export particle data"))
class UNiagaraDataInterfaceExport : public UNiagaraDataInterface

Remarks

This Data Interface can be used to gather particles at execution time and call either a C++ or blueprint object with the gathered particle data each tick.

Variables

	Name	Description
FNiagaraUserPar...	CallbackHandlerParameter	Reference to a user parameter that should receive the particle data after the simulation tick.
int	GPUAllocationFixedSize	Reserve a fixed number of elements we can write per frame.
ENDIExport_GPUA...	GPUAllocationMode
float	GPUAllocationPerParticleSize	Uses the emitter property particle count * this to determine the number of elements we reserve for write per frame.

Constructors

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

Functions

		Name	Description
	void	ExportData ( FVectorVMContext& Context )
	void	StoreData ( FVectorVMContext& Context )

Overridden from UNiagaraDataInterface

	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.
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
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.
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 )
void	GetVMExternalFunction ( const FVMExternalFunctionBindingInf..., void* InstanceData, FVMExternalFunction& OutFunc )	Returns the delegate for the passed function signature.
bool	HasPostSimulateTick()
bool	HasPreSimulateTick()
bool	InitPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* System... )	Initializes the per instance data for this interface.
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 )

Overridden from UNiagaraDataInterfaceBase

	Name	Description
void	BindParameters ( FNiagaraDataInterfaceParametersCS&..., const FNiagaraDataInterfaceGPUParam..., const FShaderParameterMap& Paramet... )	Methods that operate on an instance of type FNiagaraDataInterfaceParametersCS*, created by the above CreateComputeParameters() method
FNiagaraData...	CreateComputeParameters()	Constructs the correct CS parameter type for this DI (if any).
const FTypeL...	GetComputeParametersTypeDesc()
bool	HasInternalAttributeReads ( const UNiagaraEmitter* OwnerEm..., const UNiagaraEmitter* Provide... )	Returns true if the DI (owned by OwnerEmitter) reads any attributes from the Provider emitter
void	SetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )
void	UnsetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )

Overridden from UObject

		Name	Description
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

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

Take our survey

Dismiss