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

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;EditInlineNew, Category&61;"Export", Meta&61;&40;DisplayName&61;"Export particle data"&41;, MinimalAPI&41;  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere FNiagaraUserParameterBinding CallbackHandlerParameter Reference to a user parameter that should receive the particle data after the simulation tick.
Public variable UProperty Category, EditAnywhere, Meta int GPUAllocationFixedSize Reserve a fixed number of elements we can write per frame.
Public variable UProperty Category, EditAnywhere, Meta ENDIExport_GPUAllocationMode GPUAllocationMode  
Public variable UProperty Category, EditAnywhere, Meta float GPUAllocationPerParticleSize Uses the emitter property particle count * this to determine the number of elements we reserve for write per frame.

Constructors

  Type Name Description
Public function  

UNiagaraDataInterfaceExport ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

ExportData ( FVectorVMExternalFunctionContext& Context
)

  
Public function Virtual void

StoreData ( FVectorVMExternalFunctionContext& Context
)

  

Overridden from UNiagaraDataInterface

  Type Name Description
Public function Virtual Const bool Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile.
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual void

DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface.
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

 Determines if this DataInterface is the same as another.
Public function Virtual bool

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

  
Public function Virtual void Gets all the available functions for this data interface.
Public function Virtual void  
Public function Virtual void

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

 Returns the delegate for the passed function signature.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual bool

InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface.
Public function Virtual Const int32 Returns the size of the per instance data for this interface.
Public function Virtual bool

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

 Ticks the per instance data for this interface, if it has any.
Public function Virtual bool

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

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

Overridden from UNiagaraDataInterfaceBase

  Type Name Description
Public function Virtual Const void Override this method to provide parameters to the GPU (SRV / UAV / Constants / etc) The most common usage will be to provide a single structure which is nested with other parameters.
Public function Virtual Const bool

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

 Returns true if the DI (owned by OwnerEmitter) reads any attributes from the Provider emitter

Overridden from UObject

  Type Name Description
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page