1. Epic GamesDeveloper
  3. FSimulationStageMetaData

FSimulationStageMetaData

API > API/Plugins > API/Plugins/NiagaraShader

   
Name FSimulationStageMetaData
Type struct
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraShader/Public/NiagaraScriptBase.h
Include Path #include "NiagaraScriptBase.h"

Syntax

USTRUCT ()  
struct FSimulationStageMetaData

Constructors

Name Remarks Include Path Unreal Specifiers

FSimulationStageMetaData()

   NiagaraScriptBase.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bGpuIndirectDispatch uint32   NiagaraScriptBase.h  
bPartialParticleUpdate uint32 When enabled the simulation stage does not write all variables out, so we are reading / writing to the same buffer. NiagaraScriptBase.h  
bParticleIterationStateEnabled uint32   NiagaraScriptBase.h  
bWritesParticles uint32 Do we write to particles this stage? NiagaraScriptBase.h  
ElementCount FIntVector Optional binding to manually specify the element count. NiagaraScriptBase.h  
ElementCountXBinding FName Optional binding to manually specify the element count. NiagaraScriptBase.h  
ElementCountYBinding FName Optional binding to manually specify the element count. NiagaraScriptBase.h  
ElementCountZBinding FName Optional binding to manually specify the element count. NiagaraScriptBase.h  
EnabledBinding FName   NiagaraScriptBase.h  
ExecuteBehavior ENiagaraSimStageExecuteBehavior Controls when the simulation stage will execute. NiagaraScriptBase.h  
GpuDirectDispatchElementType ENiagaraDirectDispatchElementType   NiagaraScriptBase.h  
GpuDispatchNumThreads FIntVector When in custom mode this is the num threads. NiagaraScriptBase.h  
GpuDispatchType ENiagaraGpuDispatchType Dispatch type set for this stage. NiagaraScriptBase.h  
InputDataInterfaces TArray< FName > DataInterfaces that we read from in this stage. NiagaraScriptBase.h  
IterationDataInterface FName When IterationSource is ENiagaraIterationSource::DataInterface this is the data interface name. NiagaraScriptBase.h  
IterationDirectBinding FName When IterationSource is ENiagaraIterationSource::IterationDirectBinding this is the variable we are bound to. NiagaraScriptBase.h  
IterationSourceType ENiagaraIterationSource The source we are iteration over. NiagaraScriptBase.h  
NumIterations int32 The number of iterations for the stage. NiagaraScriptBase.h  
NumIterationsBinding FName Optional binding to gather num iterations from. NiagaraScriptBase.h  
OutputDestinations TArray< FName > DataInterfaces that we write to in this stage. NiagaraScriptBase.h  
ParticleIterationStateBinding FName When the value is not none this is the binding used for particle state iteration stages. NiagaraScriptBase.h  
ParticleIterationStateComponentIndex int32 Cached component index for particle iteration stage. NiagaraScriptBase.h  
ParticleIterationStateRange FIntPoint Inclusive range to compare the particle state value with. NiagaraScriptBase.h  
SimulationStageName FName User simulation stage name. NiagaraScriptBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool ShouldRunStage ( bool bResetData
) const

   NiagaraScriptBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page