1. Epic GamesDeveloper
  3. FNiagaraComputeExecutionContext

FNiagaraComputeExecutionContext

Unreal Engine C++ API Reference > Plugins > Niagara

References

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

Syntax

struct FNiagaraComputeExecutionContext

Variables

  Type Name Description
Public variable bool bHasTickedThisFrame_RT Used to track if we have processed any ticks for this context this frame.
Public variable bool bResetPending_GT Do we have a reset pending, controlled by the game thread and passed to instance data.
Public variable uint32 BufferSwapsThisFrame_RT  
Public variable FNiagaraScriptInstanceParameterStore CombinedParamStore Dynamic state updated either from GT via RT commands or from the RT side sim code itself.
Public variable uint32 CountOffset_RT  
Public variable uint32 CPUCount The CPU instance count at the time the GPU count readback was issued. Always bigger or equal to the GPU count.
Public variable uint32 CurrentMaxAllocateInstances_RT The current maximum instances we should allocate on the RT.
Public variable uint32 CurrentMaxInstances_RT The current maximum of instances on the RT.
Public variable uint32 CurrentNumInstances_RT The current number of instances on the RT Before ticks are processed on the RT this will be CurrentData's NumInstances As ticks are processed (or we generated the tick batches) this will change and won't be accurate until dispatches are executed
Public variable FNiagaraDataBuffer *[2] DataBuffers_RT  
Public variable TArray< FNiagaraDataInterfaceProxy * > DataInterfaceProxies  
Public variable FNiagaraDataBuffer * DataSetOriginalBuffer_RT Used only when we multi-tick and need to keep track of pointing back to the correct FNiagaraDataBuffer.
Public variable FNiagaraDataBufferRef DataToRender Most current buffer that can be used for rendering.
Public variable FName DebugSimFName  
Public variable FString DebugSimName  
Public variable TArray< FName > DIClassNames  
Public variable FNiagaraComputeExecutionContext::@12645 EmitterInstanceReadback  
Public variable TRefCountPtr< FNiagaraRHIUniformBufferLayout > ExternalCBufferLayout  
Public variable uint32 ExternalCBufferLayoutSize Persistent layouts used to create the constant buffers for the compute sim shader
Public variable uint32 FinalDispatchGroup_RT  
Public variable uint32 FinalDispatchGroupInstance_RT  
Public variable uint32 GPUCountOffset The offset at which the GPU instance count (see FNiagaraGPUInstanceCountManager()).
Public variable UNiagaraScript * GPUScript  
Public variable FNiagaraShaderScript * GPUScript_RT  
Public variable FNiagaraGpuSpawnInfo GpuSpawnInfo_GT Game thread spawn info will be sent to the render thread inside FNiagaraComputeInstanceData.
Public variable bool HasInterpolationParameters  
Public variable FNiagaraDataSet * MainDataSet  
Public variable FNiagaraDataBufferRef MultiViewPreviousDataToRender For MultiView, we need to track the previous frame's data for rendering systems on other view families.
Public variable uint32 ParticleCountReadFence Particle count read fence, used to allow us to snoop the count written by the render thread but also avoid racing on a reset value.
Public variable uint32 ParticleCountWriteFence  
Public variable TWeakObjectPtr< class USceneComponent > ProfilingComponentPtr  
Public variable FVersionedNiagaraEmitterWeakPtr ProfilingEmitterPtr  
Public variable TArray< FSimulationStageMetaData > SimStageInfo  
Public variable FNiagaraDataBufferRef TranslucentDataToRender Optional buffer which can be used to render translucent data with no latency (i.e. this frames data)

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function void  
Public function Const FNiagaraDataInterfaceProxyRW *

FindIterationInterface ( const TArray< FNiagaraDataInterfaceProxyRW* >& InProxies,
uint32 SimulationStageIndex
)

  
Public function Const const TArray< UNiagaraDataInterface * > &  
Public function Const FNiagaraDataBuffer *

GetDataToRender ( bool bIsLowLatencyTranslucent
)

  
Public function Const FName  
Public function Const const TCHAR *  
Public function FNiagaraDataBuffer *  
Public function FNiagaraDataBuffer * Render thread data.
Public function Const bool  
Public function void

InitParams ( UNiagaraScript* InGPUComputeScript,
ENiagaraSimTarget InSimTarget
)

  
Public function Const bool

IsInputStage ( FNiagaraDataInterfaceProxy* DIProxy,
uint32 SimulationStageIndex
)

  
Public function Const bool

IsIterationStage ( FNiagaraDataInterfaceProxy* DIProxy,
uint32 SimulationStageIndex
)

  
Public function Const bool

IsOutputStage ( FNiagaraDataInterfaceProxy* DIProxy,
uint32 SimulationStageIndex
)

  
Public function bool

OptionalContexInit ( FNiagaraSystemInstance* ParentSystemInstance
)

  
Public function void  
Public function void

Reset ( FNiagaraGpuComputeDispatchInterface* ComputeDispatchInterface
)

  
Public function void

ResetInternal ( FNiagaraGpuComputeDispatchInterface* ComputeDispatchInterface
)

  
Public function void

SetDataToRender ( FNiagaraDataBuffer* InDataToRender
)

  
Public function void

SetDebugSimName ( const TCHAR* InDebugSimName
)

  
Public function void

SetMultiViewPreviousDataToRender ( FNiagaraDataBuffer* InMultiViewPreviousDataToRender
)

  
Public function void

SetTranslucentDataToRender ( FNiagaraDataBuffer* InTranslucentDataToRender
)

  
Public function bool

Tick ( FNiagaraSystemInstance* ParentSystemInstance
)

  

Constants

Name Description
TickCounter  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page