1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceArray

UNiagaraDataInterfaceArray

API > API/Plugins > API/Plugins/Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, EditInlineNew, MinimalAPI)  
class UNiagaraDataInterfaceArray :  
    public UNiagaraDataInterfaceRWBase ,  
    public INiagaraSimCacheCustomStorageInterface

Variables

  Type Name Description
Public variable FRWLock ArrayRWGuard ReadWrite lock to ensure safe access to the underlying array.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly ENiagaraGpuSyncMode GpuSyncMode How to do we want to synchronize modifications to the array data.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly int32 MaxElements When greater than 0 sets the maximum number of elements the array can hold, only relevant when using operations that modify the array size.

Constructors

  Type Name Description
Public function  

UNiagaraDataInterfaceArray ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const FString

SimCacheVisualizerRead ( const UNDIArraySimCacheData* CacheData,
const FNDIArraySimCacheDataFrame& FrameData,
int Element
)

  

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  
Public 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
)

  
Protected function Virtual Const void  
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 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 void

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

 Subclasses that wish to work with GPU systems/emitters must implement this.
Public function Virtual Const void Set the shader parameters will only be called if the data interface provided shader parameters.
Public function Virtual bool Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.

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.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Overridden from INiagaraSimCacheCustomStorageInterface

  Type Name Description
Public function Virtual Const UObject *

SimCacheBeginWrite ( UObject* SimCache,
FNiagaraSystemInstance* NiagaraSystemInstance,
const void* OptionalPerInstanceData,
FNiagaraSimCacheFeedbackContext& FeedbackContext
)

 Called when we begin to write data into a simulation cache.
Public function Virtual Const bool

SimCacheCompareFrame ( const UObject* LhsStorageObject,
const UObject* RhsStorageObject,
int FrameIndex,
TOptional< float > Tolerance,
FString& OutErrors
)

 Called to compare a frame between two separate simulation cache storages.
Public function Virtual bool

SimCacheReadFrame ( UObject* StorageObject,
int FrameA,
int FrameB,
float Interp,
FNiagaraSystemInstance* SystemInstance,
void* OptionalPerInstanceData
)

 Virtual bool SimCacheEndWrite(UObject* StorageObject) const override;
Public function Virtual Const bool

SimCacheWriteFrame ( UObject* StorageObject,
int FrameIndex,
FNiagaraSystemInstance* SystemInstance,
const void* OptionalPerInstanceData,
FNiagaraSimCacheFeedbackContext& FeedbackContext
)

 Called when we are ready to write data into the simulation cache.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page