1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceExport

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.

API > API/Plugins > API/Plugins/Niagara

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.

   
Name UNiagaraDataInterfaceExport
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceExport.h
Include Path #include "NiagaraDataInterfaceExport.h"

Syntax

UCLASS (EditInlineNew, Category="Export", Meta=(DisplayName="Export particle data"), MinimalAPI)  
class UNiagaraDataInterfaceExport : public UNiagaraDataInterface

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceExport ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceExport.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CallbackHandlerParameter FNiagaraUserParameterBinding Reference to a user parameter that should receive the particle data after the simulation tick. NiagaraDataInterfaceExport.h
  • EditAnywhere
  • Category="Export"
GPUAllocationFixedSize int Reserve a fixed number of elements we can write per frame. NiagaraDataInterfaceExport.h
  • EditAnywhere
  • Category="Export GPU"
  • Meta=(EditCondition="GPUAllocationMode == ENDIExport_GPUAllocationMode::FixedSize")
GPUAllocationMode ENDIExport_GPUAllocationMode   NiagaraDataInterfaceExport.h
  • EditAnywhere
  • Category="Export GPU"
  • Meta=(ToolTip="Sets the allocation scheme for the number of elements we reserve for the GPU. The number of elements reserved should be as low as possible to improve performance.")
GPUAllocationPerParticleSize float Uses the emitter property particle count * this to determine the number of elements we reserve for write per frame. NiagaraDataInterfaceExport.h
  • EditAnywhere
  • Category="Export GPU"
  • Meta=(EditCondition="GPUAllocationMode == ENDIExport_GPUAllocationMode::PerParticle", UIMin="0.0", ClampMin="0.0")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ExportData ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceExport.h  

virtual void StoreData ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceExport.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile. NiagaraDataInterfaceExport.h  

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceExport.h  

virtual void DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface. NiagaraDataInterfaceExport.h  

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

 Determines if this DataInterface is the same as another. NiagaraDataInterfaceExport.h  

virtual bool GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
FString& OutHLSL
)

   NiagaraDataInterfaceExport.h  

virtual void GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
FString& OutHLSL
)

   NiagaraDataInterfaceExport.h  

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

 Returns the delegate for the passed function signature. NiagaraDataInterfaceExport.h  

virtual bool HasPostSimulateTick()

   NiagaraDataInterfaceExport.h  

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceExport.h  

virtual bool InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface. NiagaraDataInterfaceExport.h  

virtual int32 PerInstanceDataSize ()

 Returns the size of the per instance data for this interface. NiagaraDataInterfaceExport.h  

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

 Ticks the per instance data for this interface, if it has any. NiagaraDataInterfaceExport.h  

virtual bool PerInstanceTickPostSimulate ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance,
float DeltaSeconds
)

   NiagaraDataInterfaceExport.h  
When set to true the simulation may not complete in the same frame it started, allowing maximum overlap with the GameThread. NiagaraDataInterfaceExport.h  
Set the shader parameters will only be called if the data interface provided shader parameters. NiagaraDataInterfaceExport.h  

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceExport.h  

virtual bool HasInternalAttributeReads ( const UNiagaraEmitter* OwnerEmitter,
const UNiagaraEmitter* Provider
) const

   NiagaraDataInterfaceExport.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceExport.h  

Protected

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceExport.h  

virtual void GetFunctionsInternal ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

   NiagaraDataInterfaceExport.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page