1. Epic GamesDeveloper
  3. FNiagaraVMExecutableData

FNiagaraVMExecutableData

Struct containing all of the data needed to run a Niagara VM executable script.

API > API/Plugins > API/Plugins/Niagara

References

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

Syntax

USTRUCT ()  
struct FNiagaraVMExecutableData

Remarks

Struct containing all of the data needed to run a Niagara VM executable script.

Variables

  Type Name Description
Public variable UProperty TArray< FNiagaraFunctionSignature > AdditionalExternalFunctions  
Public variable UProperty TArray< FNiagaraVariableBase > Attributes Attributes used by this script.
Public variable UProperty TArray< FNiagaraVariableBase > AttributesWritten List of all attributes explicitly written by this VM script graph.
Public variable UProperty TArray< FNiagaraVariable > BakedRapidIterationParameters The default set of rapid iteration parameters defined by the script that this data represents.
Public variable UProperty uint32: 1 bNeedsGPUContextInit  
Public variable UProperty bool bReadsAttributeData  
Public variable UProperty uint32: 1 bReadsSignificanceIndex  
Public variable UProperty FNiagaraVMExecutableByteCode ByteCode Byte code to execute for this system.
Public variable TArray< FVMExternalFunction > CalledVMExternalFunctionBindings  
Public variable UProperty TArray< FVMExternalFunctionBindingInfo > CalledVMExternalFunctions Array of ordered vm external functions to place in the function table.
Public variable UProperty TArray< FNiagaraCompilerTag > CompileTags  
Public variable UProperty TArray< FNiagaraCompilerTag > CompileTagsEditorOnly  
Public variable UProperty TArray< FNiagaraScriptDataInterfaceCompileInfo > DataInterfaceInfo Information about all data interfaces used by this script.
Public variable UProperty TMap< FName, FNiagaraParameters > DataSetToParameters  
Public variable UProperty FNiagaraScriptDataUsageInfo DataUsage Contains various usage information for this script.
Public variable UProperty FString ErrorMsg  
Public variable UProperty TArray< uint8 > ExperimentalContextData  
Public variable UProperty TArray< FNiagaraCompileDependency > ExternalDependencies List of all external dependencies of this script. If not met, linking should result in an error.
Public variable UProperty FNiagaraParameters InternalParameters All the data for using external constants in the script, laid out in the order they are expected in the uniform table.
Public variable UProperty Transient FString LastAssemblyTranslation  
Public variable UProperty TArray< FNiagaraCompileEvent > LastCompileEvents Array of all compile events generated last time the script was compiled.
Public variable UProperty ENiagaraScriptCompileStatus LastCompileStatus Last known compile status. Lets us determine the latest state of the script byte buffer.
Public variable UProperty FString LastExperimentalAssemblyScript  
Public variable UProperty Transient FString LastHlslTranslation  
Public variable UProperty FString LastHlslTranslationGPU Note that this is currently needed to be non-transient because of how we kick off compilation of GPUComputeScripts.
Public variable UProperty Transient uint32 LastOpCount  
Public variable UProperty int32 NumTempRegisters Number of temp registers used by this script.
Public variable UProperty int32 NumUserPtrs Number of user pointers we must pass to the VM.
Public variable FNiagaraVMExecutableData::FOptimizationTask OptimizationTask  
Public variable UProperty Transient FNiagaraVMExecutableByteCode OptimizedByteCode Optimized version of the byte code to execute for this system
Public variable UProperty TArray< FString > ParameterCollectionPaths The parameter collections used by this script.
Public variable UProperty FNiagaraParameters Parameters All the data for using external constants in the script, laid out in the order they are expected in the uniform table.
Public variable UProperty TArray< FNiagaraDataSetID > ReadDataSets  
Public variable UProperty TArray< uint8 > ScriptLiterals  
Public variable UProperty FNiagaraShaderScriptParametersMetadata ShaderScriptParametersMetadata  
Public variable UProperty TArray< FSimulationStageMetaData > SimulationStageMetaData  
Public variable UProperty TArray< FNiagaraVariable > StaticVariablesWritten List of all attributes explicitly written by this VM script graph.
Public variable UProperty TArray< FNiagaraStatScope > StatScopes Scopes we'll track with stats.
Public variable UProperty TArray< FNiagaraScriptUObjectCompileInfo > UObjectInfos Information about all the UObjects used by this script.
Public variable UProperty TArray< FNiagaraDataSetProperties > WriteDataSets  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Const void

BakeScriptLiterals ( TArray< uint8 >& OutLiterals
)

  
Public function Const bool  
Public function Const bool

IsValid ()

  
Public function void

PostSerialize ( const FArchive& Ar
)

  
Public function void

Reset ()

  
Public function void

SerializeData ( FArchive& Ar,
bool bDDCData
)

  

Classes

  Type Name Description
Public struct FOptimizationTask Container for the optimization task that doesn't copy the task over when the executable data is copied.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page