UNiagaraSimulationStageGeneric

API > API/Plugins > API/Plugins/Niagara

   
Name UNiagaraSimulationStageGeneric
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraSimulationStageBase.h
Include Path #include "NiagaraSimulationStageBase.h"

Syntax

UCLASS (Meta=(DisplayName="Generic Simulation Stage"), MinimalAPI)  
class UNiagaraSimulationStageGeneric : public UNiagaraSimulationStageBase

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bDisablePartialParticleUpdate uint32 Disables the ability to read / write from the same particle buffer, i.e. only update position and no other attributes. NiagaraSimulationStageBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Simulation Stage"
bGpuDispatchForceLinear uint32 When enabled we force the dispatch to be linear (i.e. one dimension is used). NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
bOverrideGpuDispatchNumThreads uint32 When enabled we use a custom number of threads for the dispatch. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
  • Meta=(DisplayName="Override Gpu Thread Group Num Threads")
bParticleIterationStateEnabled uint32 When enabled we iterate over the subset of particles that satisfy the binding & range selected. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
DataInterface FNiagaraVariableDataInterfaceBinding Source data interface to use for the simulation stage. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
DirectDispatchElementType ENiagaraDirectDispatchElementType Customizes what the element count means for a direct dispatch. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
DirectDispatchType ENiagaraGpuDispatchType Dimensions to use for dispatch. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
ElementCountX FNiagaraParameterBindingWithValue Integer binding to override the number of elements the stage will execute along X. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
  • Meta=(DisplayName="ElementCount X")
ElementCountY FNiagaraParameterBindingWithValue Integer binding to override the number of elements the stage will execute along Y. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
  • Meta=(DisplayName="ElementCount Y", EditCondition="DirectDispatchType == ENiagaraGpuDispatchType::TwoD || DirectDispatchType == ENiagaraGpuDispatchType::ThreeD")
ElementCountZ FNiagaraParameterBindingWithValue Integer binding to override the number of elements the stage will execute along Z. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
  • Meta=(DisplayName="ElementCount Z", EditCondition="DirectDispatchType == ENiagaraGpuDispatchType::ThreeD")
EnabledBinding FNiagaraVariableAttributeBinding Optional bool binding allowing scripts to control if the simulation stage is enabled or not. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
ExecuteBehavior ENiagaraSimStageExecuteBehavior Controls when the simulation stage should execute, only valid for data interface iteration stages NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
IterationSource ENiagaraIterationSource Select what we should be iterating over, particles or data interfaces. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
NumIterations FNiagaraParameterBindingWithValue Number of times (or iterations) the simulation stage will execute in a row. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
OverrideGpuDispatchNumThreadsX FNiagaraParameterBindingWithValue Parameter binding / constant value for Num Threads X NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
  • Meta=(DisplayName="Gpu Thread Group Num Threads X")
OverrideGpuDispatchNumThreadsY FNiagaraParameterBindingWithValue Parameter binding / constant value for Num Threads Y NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
  • Meta=(DisplayName="Gpu Thread Group Num Threads Y", EditCondition="DirectDispatchType == ENiagaraGpuDispatchType::TwoD || DirectDispatchType == ENiagaraGpuDispatchType::ThreeD")
OverrideGpuDispatchNumThreadsZ FNiagaraParameterBindingWithValue Parameter binding / constant value for Num Threads Z NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
  • Meta=(DisplayName="Gpu Thread Group Num Threads Z", EditCondition="DirectDispatchType == ENiagaraGpuDispatchType::ThreeD")
ParticleIterationStateBinding FNiagaraVariableAttributeBinding Particle state attribute binding, when enabled we will only allow particles who pass the state range check to be processed. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"
ParticleIterationStateRange FIntPoint The inclusive range used to check particle state binding against when enabled. NiagaraSimulationStageBase.h
  • EditAnywhere
  • Category="Simulation Stage"

Functions

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bOverrideGpuDispatchType_DEPRECATED uint32   NiagaraSimulationStageBase.h  
bSpawnOnly_DEPRECATED uint32   NiagaraSimulationStageBase.h  
ElementCountBinding_DEPRECATED FNiagaraVariableAttributeBinding Deprecated Properties. NiagaraSimulationStageBase.h  
ElementCountXBinding_DEPRECATED FNiagaraVariableAttributeBinding   NiagaraSimulationStageBase.h  
ElementCountYBinding_DEPRECATED FNiagaraVariableAttributeBinding   NiagaraSimulationStageBase.h  
ElementCountZBinding_DEPRECATED FNiagaraVariableAttributeBinding   NiagaraSimulationStageBase.h  
Iterations_DEPRECATED int32   NiagaraSimulationStageBase.h  
NumIterationsBinding_DEPRECATED FNiagaraVariableAttributeBinding   NiagaraSimulationStageBase.h  
OverrideGpuDispatchNumThreads_DEPRECATED FIntVector   NiagaraSimulationStageBase.h  
OverrideGpuDispatchType_DEPRECATED ENiagaraGpuDispatchType   NiagaraSimulationStageBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page