FSimulationStageMetaData

Choose your operating system:

Windows

macOS

Linux

References

Module

NiagaraShader

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraShader/Public/NiagaraScriptBase.h

Include

#include "NiagaraScriptBase.h"

Syntax

USTRUCT()
struct FSimulationStageMetaData

Variables

Name Description

Public variable UProperty

uint32: 1

 

bPartialParticleUpdate

When enabled the simulation stage does not write all variables out, so we are reading / writing to the same buffer.

Public variable UProperty

uint32: 1

 

bParticleIterationStateEnabled

Public variable UProperty

uint32: 1

 

bWritesParticles

Do we write to particles this stage?

Public variable UProperty

FName

 

EnabledBinding

Public variable UProperty

ENiagaraSimStag...

 

ExecuteBehavior

Controls when the simulation stage will execute.

Public variable UProperty

FIntVector

 

GpuDispatchNumThreads

When in custom mode this is the num threads.

Public variable UProperty

ENiagaraGpuDisp...

 

GpuDispatchType

Dispatch type set for this stage.

Public variable UProperty

FName

 

IterationSource

The Data Interface that we iterate over for this stage. If None, then use particles.

Public variable UProperty

int32

 

NumIterations

The number of iterations for the stage.

Public variable UProperty

FName

 

NumIterationsBinding

Optional binding to gather num iterations from.

Public variable UProperty

TArray< FName >

 

OutputDestinations

DataInterfaces that we write to in this stage.

Public variable UProperty

FName

 

ParticleIterationStateBinding

When the value is not none this is the binding used for particle state iteration stages.

Public variable

int32

 

ParticleIterationStateComponentIndex

Cached component index for particle iteration stage.

Public variable UProperty

FIntPoint

 

ParticleIterationStateRange

Inclusive range to compare the particle state value with.

Public variable UProperty

FName

 

SimulationStageName

User simulation stage name.

Constructors

Name Description

Public function

FSimulationStageMetaData()

Functions

Name Description

Public function Const

bool

 

ShouldRunStage

(
    bool bResetData
)