code: virtual void OnUpdateSubmix ( [USoundSubmix](API\Runtime\Engine\Sound\USoundSubmix) * Submix )


module: Niagara

code: [FNiagaraDataInterfaceProxySubmix](API\Plugins\Niagara\FNiagaraDataInterfaceProxySubmix) & operator= ( const [FNiagaraDataInterfaceProxySubmix](API\Plugins\Niagara\FNiagaraDataInterfaceProxySubmix) & Other )


code: virtual int32 PerInstanceDataPassedToRenderThreadSize() const


description: Copies the minimum of NumSamples or however many samples are available into OutBuffer. Returns the number of samples copied, or -1 if this output's corresponding input has been destroyed.

code: int32 PopAudio ( float * OutBuffer, int32 NumSamples, bool bUseLatestAudio )


code: FNiagaraDataInterfaceProxySubmix ( const [FNiagaraDataInterfaceProxySubmix](API\Plugins\Niagara\FNiagaraDataInterfaceProxySubmix) & Other )


description: InNumSamplesToBuffer - Number of audio sampels to buffer internally.

code: FNiagaraDataInterfaceProxySubmix ( int32 InNumSamplesToBuffer )


className: FNiagaraDataInterfaceProxySubmix

description: Niagara data interface proxy for audio submix listener.

code: struct FNiagaraDataInterfaceProxySubmix : public [FNiagaraDataInterfaceProxy](API\Plugins\Niagara\FNiagaraDataInterfaceProxy)


code: virtual void ConsumePerInstanceDataFromGameThread ( void * PerInstanceData, const [FNiagaraSystemInstanceID](API\Plugins\NiagaraCore\FNiagaraSystemInstanceID) & Instance )


className: FNiagaraDataInterfaceProxyVectorField

code: struct FNiagaraDataInterfaceProxyVectorField : public [FNiagaraDataInterfaceProxy](API\Plugins\Niagara\FNiagaraDataInterfaceProxy)

bTileX

type: bool

Dimensions

type: FVector

TextureRHI

type: FTextureRHIRef


className: Channels

code: static [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > Channels = { "r", "g", "b", "a" };


className: FAttributeInfo

code: struct FAttributeInfo

Name

type: FName

TypeDef

type: FNiagaraTypeDef...


description: Translates named attribute into actual attribute index.

code: [FString](API\Runtime\Core\Containers\FString) GetAttributeIndex ( const [FAttributeInfo](API\Plugins\Niagara\FNiagaraDataInterfaceRWAttribute-\FAttributeInfo) * AttributeInfo, int Channel ) const


code: const [FAttributeInfo](API\Plugins\Niagara\FNiagaraDataInterfaceRWAttribute-\FAttributeInfo) * FindAttributeInfo ( [FName](API\Runtime\Core\UObject\FName) AttributeName ) const


code: void GetChannelStrings ( const [FAttributeInfo](API\Plugins\Niagara\FNiagaraDataInterfaceRWAttribute-\FAttributeInfo) * AttributeInfo, [FString](API\Runtime\Core\Containers\FString) & NumChannelsString, [FString](API\Runtime\Core\Containers\FString) & AttrGridChannels ) const


code: void GetChannelStrings ( int AttributeIndex, int AttributeNumChannels, [FString](API\Runtime\Core\Containers\FString) & NumChannelsString, [FString](API\Runtime\Core\Containers\FString) & AttrGridChannels ) const


code: template<typename T> void Init ( [TArray](API\Runtime\Core\Containers\TArray)< [FText](API\Runtime\Core\Internationalization\FText) > * OutWarnings )


code: FNiagaraDataInterfaceRWAttributeHelper ( const [FNiagaraDataInterfaceGPUParamInfo](API\Plugins\NiagaraShader\FNiagaraDataInterfaceGPUParamInf-) & InParamInfo )


className: FNiagaraDataInterfaceRWAttributeHelper

AttributeInfos

type: TArray<FAttrib...

ParamInfo

type: constFNiagaraD...


code: const [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) & GetComputeDispatchInterface() const


code: const [FNiagaraComputeInstanceData](API\Plugins\Niagara\FNiagaraComputeInstanceData) & GetComputeInstanceData() const


description: Formats a string with the simulation & stage name


code: [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GetGraphBuilder() const


code: template<typename T> T * GetParameterIncludedStruct() const


code: uint8 * GetParameterIncludedStruct ( const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * StructMetadata ) const


code: template<typename T> [TArrayView](API\Runtime\Core\Containers\TArrayView)< T > GetParameterLooseArray ( int32 NumElements ) const


code: template<typename T> T * GetParameterNestedStruct() const


code: template<typename T> T & GetProxy() const


code: [FRDGExternalAccessQueue](API\Runtime\RenderCore\FRDGExternalAccessQueue) & GetRDGExternalAccessQueue() const


code: template<typename T> const T & GetShaderStorage() const


code: const [FNiagaraSimStageData](API\Plugins\Niagara\FNiagaraSimStageData) & GetSimStageData() const


code: FVector3f GetSystemLWCTile() const


code: const [FNiagaraGPUSystemTick](API\Plugins\Niagara\FNiagaraGPUSystemTick) & GetSystemTick() const


code: bool IsResourceBound ( const void * ResourceAddress ) const


code: bool IsParameterBound ( const void * ParameterAddress ) const


code: template<typename T> bool IsStructBound ( const T * StructAddress ) const


code: bool IsStructBound ( const uint8 * StructAddress, const [FShaderParametersMetadata](API\Runtime\RenderCore\FShaderParametersMetadata) * StructMetadata ) const


code: void SetDataInterface ( [FNiagaraDataInterfaceProxy](API\Plugins\Niagara\FNiagaraDataInterfaceProxy) * InDataInterfaceProxy, uint32 InParametersOffset, const [FNiagaraDataInterfaceParametersCS](API\Plugins\NiagaraCore\FNiagaraDataInterfaceParametersC-) * InShaderStorage )


code: FNiagaraDataInterfaceSetShaderParametersContext ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & InGraphBuilder, const [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) & InComputeDispatchInterface, const [FNiagaraGPUSystemTick](API\Plugins\Niagara\FNiagaraGPUSystemTick) & InSystemTick, const [FNiagaraComputeInstanceData](API\Plugins\Niagara\FNiagaraComputeInstanceData) & InComputeInstanceData, const [FNiagaraSimStageData](API\Plugins\Niagara\FNiagaraSimStageData) & InSimStageData, const [FNiagaraShaderRef](API\Plugins\NiagaraShader\FNiagaraShaderRef) & InShaderRef, const [FNiagaraShaderScriptParametersMetadata](API\Plugins\NiagaraShader\FNiagaraShaderScriptParametersMe-) & InShaderParametersMetadata, uint8 * InBaseParameters )


code: void BuildLUT ( const [FSplineCurves](API\Runtime\Engine\Components\FSplineCurves) & SplineCurves, int32 NumSteps )


code: void FindNeighborKeys ( float InDistance, int32 & PrevKey, int32 & NextKey, float & Alpha ) const


description: The same function call made be made multiple times across different scripts so you may see the same function multiple times The action should return True to continue iteration or False to stop

code: namespace FNiagaraDataInterfaceUtilities { void FNiagaraDataInterfaceUtilities::ForEachVMFunction ( [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * ResolvedRuntimeDataInterface, [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * NiagaraSystem, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) *, const [FVMExternalFunctionBindingInfo](API\Plugins\Niagara\FVMExternalFunctionBindingInfo) &)> Action ) }


className: FNiagaraDataInterfaceSplineLUT

InvSplineDistanceStep

type: float

Positions

type: TArray< FVector...

Rotations

type: TArray< FQuat >


code: namespace FNiagaraDataInterfaceUtilities { void FNiagaraDataInterfaceUtilities::ForEachVMFunction ( [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * ResolvedRuntimeDataInterface, [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * Component, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) *, const [FVMExternalFunctionBindingInfo](API\Plugins\Niagara\FVMExternalFunctionBindingInfo) &)> Action ) }


code: namespace FNiagaraDataInterfaceUtilities { void FNiagaraDataInterfaceUtilities::ForEachVMFunction ( [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * ResolvedRuntimeDataInterface, [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * SystemInstance, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) *, const [FVMExternalFunctionBindingInfo](API\Plugins\Niagara\FVMExternalFunctionBindingInfo) &)> Action ) }


code: namespace FNiagaraDataInterfaceUtilities { void FNiagaraDataInterfaceUtilities::ForEachGpuFunction ( [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * ResolvedRuntimeDataInterface, [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * NiagaraSystem, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) *, const [FNiagaraDataInterfaceGeneratedFunction](API\Plugins\NiagaraShader\FNiagaraDataInterfaceGeneratedFu-) &)> Action ) }


code: namespace FNiagaraDataInterfaceUtilities { void FNiagaraDataInterfaceUtilities::ForEachGpuFunction ( [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * ResolvedRuntimeDataInterface, [UNiagaraComponent](API\Plugins\Niagara\UNiagaraComponent) * Component, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) *, const [FNiagaraDataInterfaceGeneratedFunction](API\Plugins\NiagaraShader\FNiagaraDataInterfaceGeneratedFu-) &)> Action ) }


code: namespace FNiagaraDataInterfaceUtilities { void FNiagaraDataInterfaceUtilities::ForEachGpuFunction ( [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * ResolvedRuntimeDataInterface, [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * SystemInstance, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [UNiagaraScript](API\Plugins\Niagara\UNiagaraScript) *, const [FNiagaraDataInterfaceGeneratedFunction](API\Plugins\NiagaraShader\FNiagaraDataInterfaceGeneratedFu-) &)> Action ) }


description: Loops over all data interfaces inside the SystemInstance The action should return True to continue iteration or False to stop

code: namespace FNiagaraDataInterfaceUtilities { void FNiagaraDataInterfaceUtilities::ForEachDataInterface ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * SystemInstance, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) Variable, [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) *DataInterface)> Action, [FDataInterfaceSearchOptions](API\Plugins\Niagara\FDataInterfaceSearchOptions) SearchOptions ) }


code: namespace FNiagaraDataInterfaceUtilities { void FNiagaraDataInterfaceUtilities::ForEachDataInterface ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * SystemInstance, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [FDataInterfaceUsageContext](API\Plugins\Niagara\FDataInterfaceUsageContext) &)> Action, [FDataInterfaceSearchOptions](API\Plugins\Niagara\FDataInterfaceSearchOptions) SearchOptions ) }


description: Loops over all data interfaces inside the NiagaraSystem The action should return True to continue iteration or False to stop

code: namespace FNiagaraDataInterfaceUtilities { void FNiagaraDataInterfaceUtilities::ForEachDataInterface ( [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * NiagaraSystem, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const [FDataInterfaceUsageContext](API\Plugins\Niagara\FDataInterfaceUsageContext) &)> Action, [FDataInterfaceSearchOptions](API\Plugins\Niagara\FDataInterfaceSearchOptions) SearchOptions ) }


description: Allocates space for NumInstances in the current destination buffer.

code: void Allocate ( int32 NumInstances, bool bMaintainExisting )


code: void AllocateGPUFreeIDs ( uint32 InNumInstances, [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel, const TCHAR * DebugSimName )


description: Begins a new simulation pass and grabs a destination buffer. Returns the new destination data buffer.

code: [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) & BeginSimulate ( bool bResetDestinationData )


code: void CopyFromGPUReadback ( const float * GPUReadBackFloat, const int * GPUReadBackInt, const [FFloat16](API\Runtime\Core\Math\FFloat16) * GPUReadBackHalf, int32 StartIdx, int32 NumInstances, uint32 FloatStride, uint32 IntStride, uint32 HalfStride )


code: void CopyTo ( [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & Other, int32 StartIdx, int32 NumInstances, bool bResetOther ) const


code: void Dump ( int32 StartIndex, int32 NumInstances, const [FString](API\Runtime\Core\Containers\FString) & Label, const [FName](API\Runtime\Core\UObject\FName) & SortParameterKey ) const


description: Ends a simulation pass and sets the current simulation state.

code: void EndSimulate ( bool SetCurrentData )


code: const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & GetCompiledData() const


code: [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * GetCurrentData() const


code: [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) & GetCurrentDataChecked() const


code: [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * GetDestinationData() const


code: [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) & GetDestinationDataChecked() const


code: [TArray](API\Runtime\Core\Containers\TArray)< int32 > & GetFreeIDTable()


code: const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & GetFreeIDTable() const


code: uint32 GetGPUNumAllocatedIDs() const


code: uint32 GetMaxAllocationCount() const


code: uint32 GetMaxInstanceCount() const


code: uint32 GetNumFloatComponents() const


code: uint32 GetNumHalfComponents() const


code: uint32 GetNumInt32Components() const


description: Returns size in bytes for all data buffers currently allocated by this dataset.

code: int64 GetSizeBytes() const


code: [TArray](API\Runtime\Core\Containers\TArray)< int32 > & GetSpawnedIDsTable()


code: const [TArray](API\Runtime\Core\Containers\TArray)< int32 > & GetSpawnedIDsTable() const


code: bool GetVariableComponentOffsets ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & Var, int32 & FloatStart, int32 & IntStart, int32 & HalfStart ) const


code: const [FNiagaraVariableLayoutInfo](API\Plugins\Niagara\FNiagaraVariableLayoutInfo) * GetVariableLayout ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & Var ) const


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariableLayoutInfo](API\Plugins\Niagara\FNiagaraVariableLayoutInfo) > & GetVariableLayouts() const


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) > & GetVariables() const


code: bool HasVariable ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & Var ) const


code: bool HasVariable ( const [FName](API\Runtime\Core\UObject\FName) & Name ) const


description: Initialize the data set with the compiled data

code: void Init ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * InDataSetCompiledData )


code: [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & operator= ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & )


code: bool RequiresPersistentIDs() const


description: Resets current data but leaves variable/layout information etc intact.

code: void ResetBuffers()


description: Set current data directly, you can not call this while inside a BeginSimulate block

code: void SetCurrentData ( [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * CurrentData )


code: void SetIDAcquireTag ( int32 InTag )


code: void SetMaxAllocationCount ( uint32 InMaxAllocationCount )


code: void SetMaxInstanceCount ( uint32 InMaxInstanceCount )


className: FNiagaraDataSet

description: General storage class for all per instance simulation data in Niagara.

code: class FNiagaraDataSet

NumSpawnedIDs

type: int


code: FNiagaraDataSetAccessor ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: FNiagaraDataSetAccessor ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


className: FNiagaraDataSetAccessor

code: template<typename TType> struct FNiagaraDataSetAccessor : public FNiagaraDataSetAccessorTypeInfo< TType >::TAccessorBaseClass


code: static [FNiagaraDataSetReaderFloat](API\Plugins\Niagara\FNiagaraDataSetReaderFloat)< TType > CreateReader ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: [FNiagaraDataSetReaderFloat](API\Plugins\Niagara\FNiagaraDataSetReaderFloat)< TType > GetReader ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet ) const


code: void Init ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: void Init ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: void Init ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: FNiagaraDataSetAccessorFloat ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: FNiagaraDataSetAccessorFloat ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: FNiagaraDataSetAccessorFloat ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


className: FNiagaraDataSetAccessorFloat

description: Templatestruct FNiagaraDataSetWriterFloat

code: template<typename TType> struct FNiagaraDataSetAccessorFloat


code: static [FNiagaraDataSetReaderInt32](API\Plugins\Niagara\FNiagaraDataSetReaderInt32)< TType > CreateReader ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: static [FNiagaraDataSetWriterInt32](API\Plugins\Niagara\FNiagaraDataSetWriterInt32)< TType > CreateWriter ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: [FNiagaraDataSetReaderInt32](API\Plugins\Niagara\FNiagaraDataSetReaderInt32)< TType > GetReader ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet ) const


code: [FNiagaraDataSetWriterInt32](API\Plugins\Niagara\FNiagaraDataSetWriterInt32)< TType > GetWriter ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet ) const


code: FNiagaraDataSetAccessorInt32 ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: FNiagaraDataSetAccessorInt32 ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: FNiagaraDataSetAccessorInt32 ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: static [FNiagaraDataSetReaderStruct](API\Plugins\Niagara\FNiagaraDataSetReaderStruct)< TType > CreateReader ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, const [FName](API\Runtime\Core\UObject\FName) VariableName )


description: Templatestruct FNiagaraDataSetWriterInt

code: template<typename TType> struct FNiagaraDataSetAccessorInt32


code: [FNiagaraDataSetReaderStruct](API\Plugins\Niagara\FNiagaraDataSetReaderStruct)< TType > GetReader ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet ) const


code: [FNiagaraDataSetReaderStruct](API\Plugins\Niagara\FNiagaraDataSetReaderStruct)< TType > GetReader ( const [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer ) const


code: void Init ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: void Init ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: void Init ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: FNiagaraDataSetAccessorStruct ( const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & DataSet, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: FNiagaraDataSetAccessorStruct ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


code: FNiagaraDataSetAccessorStruct ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) * DataSetCompiledData, const [FName](API\Runtime\Core\UObject\FName) VariableName )


className: FNiagaraDataSetAccessorStruct

code: template<typename TType> struct FNiagaraDataSetAccessorStruct


className: FNiagaraDataSetAccessorTypeInfo

code: template<typename TType> struct FNiagaraDataSetAccessorTypeInfo


className: NumElements

code: static NumElements = 1;


className: TAccessorBaseClass

code: typedef FNiagaraDataSetAccessorInt32< ENiagaraExecutionState > TAccessorBaseClass


code: template<> struct FNiagaraDataSetAccessorTypeInfo< ENiagaraExecutionState >


className: bSupportsAlternateType

code: static bSupportsAlternateType = false;


className: bSupportsHalf

code: static bSupportsHalf = true;


code: static const FNiagaraTypeDefinition & GetAlternateType&40;&41;


code: static const FNiagaraTypeDefinition & GetFloatType&40;&41;


code: static const FNiagaraTypeDefinition & GetHalfType&40;&41;


code: static NumElements = 4;


code: template<> struct FNiagaraDataSetAccessorTypeInfo< FLinearColor >


code: typedef FNiagaraDataSetAccessorFloat< FLinearColor > TAccessorBaseClass


code: typedef FNiagaraDataSetAccessorFloat< FVector4f > TAccessorBaseClass


code: template<> struct FNiagaraDataSetAccessorTypeInfo< FVector4f >


code: static const FNiagaraTypeDefinition & GetIntType&40;&41;


code: typedef FNiagaraDataSetAccessorInt32< int32 > TAccessorBaseClass


code: template<> struct FNiagaraDataSetAccessorTypeInfo< int32 >


code: typedef FNiagaraDataSetAccessorFloat< float > TAccessorBaseClass


code: template<> struct FNiagaraDataSetAccessorTypeInfo< float >


code: typedef FNiagaraDataSetAccessorInt32< FNiagaraBool > TAccessorBaseClass


code: static NumElements = 1;


code: template<> struct FNiagaraDataSetAccessorTypeInfo< FNiagaraBool >


className: NumFloatComponents

code: static NumFloatComponents = 0;


code: static FNiagaraID ReadStruct &40; int32 InstanceIndex, const float &42;const &42; FloatComponents, const int32 &42;const &42; Int32Components &41;


code: typedef FNiagaraDataSetAccessorStruct< FNiagaraID > TAccessorBaseClass


code: template<> struct FNiagaraDataSetAccessorTypeInfo< FNiagaraID >


code: static bSupportsAlternateType = true;


code: static bSupportsHalf = true;


code: static const FNiagaraTypeDefinition & GetAlternateType&40;&41;


code: static const FNiagaraTypeDefinition & GetFloatType&40;&41;


code: static const FNiagaraTypeDefinition & GetHalfType&40;&41;


code: typedef FNiagaraDataSetAccessorFloat< FNiagaraPosition > TAccessorBaseClass


code: static NumElements = 3;


code: template<> struct FNiagaraDataSetAccessorTypeInfo< FNiagaraPosition >


code: static NumFloatComponents = 2;


code: typedef FNiagaraDataSetAccessorStruct< FNiagaraSpawnInfo > TAccessorBaseClass


code: template<> struct FNiagaraDataSetAccessorTypeInfo< FNiagaraSpawnInfo >


code: static bSupportsAlternateType = false;


code: static bSupportsHalf = false;


code: static NumElements = 4;


code: typedef FNiagaraDataSetAccessorFloat< FQuat4f > TAccessorBaseClass


code: static FNiagaraSpawnInfo ReadStruct &40; int32 InstanceIndex, const float &42;const &42; FloatComponents, const int32 &42;const &42; Int32Components &41;


code: template<> struct FNiagaraDataSetAccessorTypeInfo< FQuat4f >


code: static NumElements = 2;


code: typedef FNiagaraDataSetAccessorFloat< FVector2f > TAccessorBaseClass


code: template<> struct FNiagaraDataSetAccessorTypeInfo< FVector2f >


code: static bSupportsHalf = true;


code: static const FNiagaraTypeDefinition & GetAlternateType&40;&41;


code: static const FNiagaraTypeDefinition & GetFloatType&40;&41;


code: static const FNiagaraTypeDefinition & GetHalfType&40;&41;


code: static NumElements = 3;


code: typedef FNiagaraDataSetAccessorFloat< FVector3f > TAccessorBaseClass


code: template<> struct FNiagaraDataSetAccessorTypeInfo< FVector3f >


code: bool CheckHashConflict ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & Other ) const


code: const [FNiagaraVariableLayoutInfo](API\Plugins\Niagara\FNiagaraVariableLayoutInfo) * FindVariableLayoutInfo ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & VariableDef ) const


className: FNiagaraDataSetCompiledData

bRequiresPersistentIDs

type: uint32:  1

description: Whether or not this dataset require persistent IDs.

ID

type: FNiagaraDataSet...

description: Unique ID for this DataSet. Used to allow referencing from other emitters and Systems.

SimTarget

type: ENiagaraSimTarg...

description: Sim target this DataSet is targeting (CPU/GPU).

TotalFloatComponents

description: Total number of components of each type in the data set.

VariableLayouts

type: TArray<FNiagar...

description: Data describing the layout of variable data.

Variables

description: Variables in the data set.


code: bool Init ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & CompiledData, [FName](API\Runtime\Core\UObject\FName) InVariableName )


code: float ReadFloat ( const [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer, uint32 Instance, uint32 Component ) const


code: float ReadHalf ( const [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer, uint32 Instance, uint32 Component ) const


code: int32 ReadInt ( const [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer, uint32 Instance, uint32 Component ) const


code: template<typename TString> void StringAppend ( TString & StringType, const [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer, uint32 Instance ) const


code: static bool ValidateDataBuffer ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & CompiledData, const [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) &, uint32, int32)> ErrorCallback )


code: static bool ValidateDataBuffer ( const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & CompiledData, const [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer, uint32 iInstance, [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) &, int32)> ErrorCallback )


code: [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * GetOutput() const


className: FNiagaraDataSetDebugAccessor

code: struct FNiagaraDataSetDebugAccessor


code: void Init ( [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) * InDataSet, [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * InInput, int32 InStartInstance, bool bInUpdateInstanceCount )


code: bool operator== ( const [FNiagaraDataSetID](API\Plugins\Niagara\FNiagaraDataSetID) & Other ) const


className: FNiagaraDataSetExecutionInfo

code: struct FNiagaraDataSetExecutionInfo

Input

type: FNiagaraDataBuf...


code: bool operator!= ( const [FNiagaraDataSetID](API\Plugins\Niagara\FNiagaraDataSetID) & Other ) const


code: FNiagaraDataSetID ( [FName](API\Runtime\Core\UObject\FName) InName, [ENiagaraDataSetType](API\Plugins\Niagara\ENiagaraDataSetType) InType )


className: FNiagaraDataSetID

Type

type: ENiagaraDataSet...


className: FNiagaraDataSetProperties


code: void EnqueueReadback ( [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * EmitterInstance )


className: FOnReadbackReady

code: typedef TBaseDelegate_OneParam< void, const [FNiagaraDataSetReadback](API\Plugins\Niagara\FNiagaraDataSetReadback) & > FOnReadbackReady


description: ENiagaraScriptUsage GetSourceScriptUsage() const { return SourceScriptUsage; }.

code: const [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & GetDataSet() const


code: const [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore) & GetParameterStore() const


code: void ImmediateReadback ( [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * EmitterInstance )


code: void SetReadbackRead ( [FOnReadbackReady](API\Plugins\Niagara\FNiagaraDataSetReadback\FOnReadbackReady) InOnReadbackReady )


className: FNiagaraDataSetReadback

code: class FNiagaraDataSetReadback : public [TSharedFromThis< FNiagaraDataSetReadback, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)


code: static constexpr bool bSupportsHalf = FNiagaraDataSetAccessorTypeInfo<TType>::bSupportsHalf;


code: float GetMaxElement ( int32 ElementIndex ) const


code: void GetMinMax ( TType & Min, TType & Max ) const


code: void GetMinMaxElement ( int32 ElementIndex, float & MinValueOut, float & MaxValueOut ) const


code: TType GetSafe ( int Index, const TType & Default ) const


code: TType operator[] ( int32 Index ) const


code: FNiagaraDataSetReaderFloat ( [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer, bool bInIsFloat, int32 ComponentIndex )


className: FNiagaraDataSetReaderFloat

code: template<typename TType> struct FNiagaraDataSetReaderFloat


code: FNiagaraDataSetReaderInt32 ( [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer, int32 ComponentIndex )


code: template<typename TType> struct FNiagaraDataSetReaderInt32


code: FNiagaraDataSetReaderStruct ( const [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer, int32 FloatComponentIndex, int32 Int32ComponentIndex )


className: FNiagaraDataSetReaderStruct

code: template<typename TType> struct FNiagaraDataSetReaderStruct


code: void Set ( int Index, const TType & Value )


code: void SetSafe ( int Index, const TType & Value )


code: FNiagaraDataSetWriterInt32 ( [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * DataBuffer, int32 ComponentIndex )


code: const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetVariables() const


code: FNiagaraDataVariableIterator ( const [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * InData, uint32 StartIdx )


code: template<typename TType> struct FNiagaraDataSetWriterInt32


className: FNiagaraDataVariableIterator

description: Iterator that will pull or push data between a NiagaraDataBuffer and some FNiagaraVariables it contains. Super slow. Don't use at runtime.

code: struct FNiagaraDataVariableIterator


code: FNiagaraDebuggerAcceptConnection()


code: FNiagaraDebuggerAcceptConnection ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InSessionId, const [FGuid](API\Runtime\Core\Misc\FGuid) & InInstanceId )


className: FNiagaraDebuggerAcceptConnection

description: Response message from the a debugger client accepting a connection requested by aFNiagaraDebuggerRequestConnectionmessage.

InstanceId

type: FGuid


code: FNiagaraDebuggerConnectionClosed()


code: FNiagaraDebuggerConnectionClosed ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InSessionId, const [FGuid](API\Runtime\Core\Misc\FGuid) & InInstanceId )


className: FNiagaraDebuggerConnectionClosed

description: Empty message informing a debugger client that the debugger is closing the connection.


code: FNiagaraDebuggerExecuteConsoleCommand ( [FString](API\Runtime\Core\Containers\FString) InCommand, bool bInRequiresWorld )


code: FNiagaraDebuggerExecuteConsoleCommand()


className: FNiagaraDebuggerExecuteConsoleCommand

description: Command that will execute a console command on the debugger client.

bRequiresWorld

type: bool

Command

type: FString


className: FNiagaraDebuggerOutlinerUpdate

description: Message containing updated outliner information sent from the client to the debugger.

OutlinerData

type: FNiagaraOutline...


code: FNiagaraDebuggerRequestConnection()


code: FNiagaraDebuggerRequestConnection ( const [FGuid](API\Runtime\Core\Misc\FGuid) & InSessionId, const [FGuid](API\Runtime\Core\Misc\FGuid) & InInstanceId )


className: FNiagaraDebuggerRequestConnection

description: Messaged broadcast from debugger to request a connection to a particular session. If any matching client is found and it accepts, it will return aFNiagaraDebuggerAcceptConnectionmessage to the sender.


className: FNiagaraDebugHUDSettingsData

description: Settings for Niagara debug HUD. Contained in it's own struct so that we can pass it whole in a message to the debugger client.

ActorFilter

description: Wildcard filter which is compared against the Components Actor name to narrow down the detailed information.

bEnableGpuParticleReadback

description: When enabled GPU particle data will be copied from the GPU to the CPU.

bEnableSmoothing

description: True if perf graphs should be smoothed.

bHudEnabled

description: Primary control for all HUD features.

bHudRenderingEnabled

description: Primary control for HUD rendering.

bIncludeCascade

description: When enabled the overview display will include cascade FX.

bOverviewEnabled

description: When enabled the overview display will be enabled.

bOverviewShowFilteredSystemOnly

description: When enabled the overview will only show the filter system information.

bShowParticleIndex

description: When enabled the particle index will be displayed along with any attributes.

bShowParticlesVariablesWithSystem

description: When enabled particle attributes will display with the system information rather than in world at the particle location.

bShowParticleVariables

description: When enabled will show particle attributes from the list.

bShowRegisteredComponents

description: Overview display font to use.

bShowSystemVariables

description: Should we display the system attributes.

bSystemShowActiveOnlyInWorld

description: When disabled in world rendering will show systems deactivated by scalability.

bSystemShowBounds

description: When enabled will show the system bounds for all filtered systems.

bUseParticleDisplayCenterRadius

description: When enabled we use a radius from the display center to avoid showing too many particle attributes.

bUseParticleDisplayClip

description: When enabled we use the clip planes to narrow down which particles to display

bValidateParticleDataBuffers

description: When enabled all Niagara systems that pass the filter will have the particle data buffers validation.

bValidateSystemSimulationDataBuffers

description: When enabled all Niagara systems that pass the filter will have the simulation data buffers validation.

bValidationLogErrors

description: When enabled all validation errors will be sent to the log as warnings.

ComponentFilter

description: Wildcard filter for the components to show more detailed information about.

DataInterfaceVerbosity

type: ENiagaraDebugHu...

description: When enabled allows data interfaces to include additional debugging information.

DefaultBackgroundColor

type: FLinearColor

description: Default background color used generally for panels.

EmitterFilter

description: Wildcard filter used to match emitters when generating particle attribute view.

InWorldErrorTextColor

description: In world text if an error is detected.

InWorldTextColor

description: In world text color.

MaxParticlesToDisplay

description: When enabled, the maximum number of particles to show information about.

MessageErrorTextColor

description: Message display error text color.

MessageInfoTextColor

description: Message display text color.

MessageWarningTextColor

description: Message display warning text color.

OverviewDetailColor

description: Overview detail text color.

OverviewDetailHighlightColor

description: Overview detail highlight text color.

OverviewFont

description: Overview display font to use.

OverviewHeadingColor

description: Overview heading text color.

OverviewLocation

description: Overview display location.

OverviewMode

type: ENiagaraDebugHU...

ParticleDisplayCenterRadius

description: Radius from screen center where 0 is center to 1.0 is edge to avoid display too many particle attributes.

ParticleDisplayClip

description: Clipping planes used to display particle attributes.

ParticlesVariables

description: List of attributes to show per particle, each entry uses wildcard matching.

ParticleTextOptions

type: FNiagaraDebugHu...

description: Sets display text options for particle information.

PerfGraphMode

description: Time range of the Y Axis of the perf graph

PerfGraphSize

description: Pixel size of the perf graph.

PerfHistoryFrames

description: How many frames of history to display in the perf graphs.

PerfReportFrames

description: How many frames to capture in between updates to the max and average perf report values.

PlaybackMode

type: ENiagaraDebugPl...

SmoothingWidth

description: Number of samples to use either size of a value when smoothing perf graphs.

SystemColorHSVMax

type: FVector

description: Maximum HSV values for the random colors generated for each System.

SystemColorHSVMin

description: Minimum HSV values for the random colors generated for each System.

SystemColorSeed

description: Additional seed value for random system colors.

SystemColorTableOpacity

description: Opacity of the system color background tile in overview table rows.

SystemDebugVerbosity

description: When enabled system debug information will be displayed in world.

SystemEmitterVerbosity

description: When enabled we show information about emitter / particle counts.

SystemFilter

description: Wildcard filter for the systems to show more detailed information about.

SystemTextOptions

description: Sets display text options for system information.

SystemVariables

description: List of attributes to show about the system, each entry uses wildcard matching.


className: FNiagaraDebugHudTextOptions


code: static [FString](API\Runtime\Core\Containers\FString) BuildVariableString ( const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraDebugHUDVariable](API\Plugins\Niagara\FNiagaraDebugHUDVariable) > & Variables )


code: static void InitFromString ( const [FString](API\Runtime\Core\Containers\FString) & VariablesString, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraDebugHUDVariable](API\Plugins\Niagara\FNiagaraDebugHUDVariable) > & OutVariables )


className: FNiagaraDebugHUDVariable

Name

description: Name of attributes to match, uses wildcard matching.


code: FNiagaraDebugMessage ( [ENiagaraDebugMessageType](API\Plugins\Niagara\ENiagaraDebugMessageType) InType, const [FString](API\Runtime\Core\Containers\FString) & InMessage, float InLifetime )


code: void Enqueue ( const [FMethod](API\Plugins\Niagara\FNiagaraDeferredMethodQueue\FMethod) & Func )


className: FNiagaraDebugMessage

code: struct FNiagaraDebugMessage

Lifetime

type: float

Type

type: ENiagaraDebugMe...


code: void Enqueue ( [FMethod](API\Plugins\Niagara\FNiagaraDeferredMethodQueue\FMethod) && Func )


className: FMethod

code: typedef TBaseDelegate_NoParams< void > FMethod


className: FNiagaraDeferredMethodQueue

description: This class is used to defer the execution of object methods that would otherwise be executing at an unsafe point, due to concurrent processing.

code: class FNiagaraDeferredMethodQueue


code: FNiagaraDetailsLevelScaleOverrides()


className: FNiagaraDetailsLevelScaleOverrides

description: Legacy struct for spawn count scale overrides. This is now done inFNiagaraEmitterScalabilityOverrides


code: [ENiagaraPlatformSelectionState](API\Plugins\Niagara\ENiagaraPlatformSelectionState) GetState ( int32 QualityLevel ) const


code: bool operator== ( const [FNiagaraDeviceProfileStateEntry](API\Plugins\Niagara\FNiagaraDeviceProfileStateEntry) & Other ) const


code: void SetState ( int32 QualityLevel, [ENiagaraPlatformSelectionState](API\Plugins\Niagara\ENiagaraPlatformSelectionState) State )


code: FNiagaraDeviceProfileStateEntry()


className: FNiagaraDeviceProfileStateEntry

ProfileName

type: FName

QualityLevelMask

description: The state of each set quality level.

SetQualityLevelMask

description: Which Effects Qualities are set.


className: CollisionTagName

description: TArrayCollisionTraceHandles;.

code: static const [FName](API\Runtime\Core\UObject\FName) CollisionTagName = FName("Niagara");


code: bool GetQueryResult ( uint32 TraceID, [FNiagaraDICollsionQueryResult](API\Plugins\Niagara\FNiagaraDICollsionQueryResult) & Result )


code: void Init ( [FNiagaraSystemInstanceID](API\Plugins\NiagaraCore\FNiagaraSystemInstanceID) InBatchID, [UWorld](API\Runtime\Engine\Engine\UWorld) * InCollisionWorld, [TStatId](API\Runtime\Core\Stats\TStatId) InStatId )


code: bool PerformQuery ( FVector StartPos, FVector EndPos, [FNiagaraDICollsionQueryResult](API\Plugins\Niagara\FNiagaraDICollsionQueryResult) & Result, ECollisionChannel TraceChannel )


code: int32 SubmitQuery ( FVector StartPos, FVector EndPos, ECollisionChannel TraceChannel )


className: TraceTagName

code: static const [FName](API\Runtime\Core\UObject\FName) TraceTagName = FName("NiagaraCollision");


className: FNiagaraDICollisionQueryBatch

code: class FNiagaraDICollisionQueryBatch


className: FNiagaraDICollsionQueryResult

code: struct FNiagaraDICollsionQueryResult


className: FNiagaraDISkeletalMeshPassedDataToRT

ConnectivityBuffer

type: const FSkeletal...

DynamicBuffer

type: FSkeletalMeshGp...

MeshSkinWeightBuffer

type: constFSkinWeig...

UvMappingBuffer

type: const FMeshUvMa...


className: FNiagaraDouble

description: Only used for LWC conversions, not supported by Niagara yet

Value

type: double


code: virtual void ApplyMaterialOverride ( int32 MaterialIndex, [UMaterialInterface](API\Runtime\Engine\Materials\UMaterialInterface) * MaterialOverride )


code: [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * GetParticleDataToRender ( bool bIsLowLatencyTranslucent ) const


code: [FNiagaraDynamicDataBase](API\Plugins\Niagara\FNiagaraDynamicDataBase) & operator= ( const [FNiagaraDynamicDataBase](API\Plugins\Niagara\FNiagaraDynamicDataBase) & Other )


code: void SetMaterialRelevance ( [FMaterialRelevance](API\Runtime\Engine\Materials\FMaterialRelevance) NewRelevance )


code: FNiagaraDynamicDataBase ( const [FNiagaraEmitterInstance](API\Plugins\Niagara\FNiagaraEmitterInstance) * InEmitter )


code: FNiagaraDynamicDataBase ( [FNiagaraDynamicDataBase](API\Plugins\Niagara\FNiagaraDynamicDataBase) & Other )


code: virtual ~FNiagaraDynamicDataBase()


className: FNiagaraDynamicDataBase

description: Struct used to pass dynamic data from game thread to render thread

code: struct FNiagaraDynamicDataBase

CPUParticleData

type: FNiagaraDataBuf...

GPUExecContext

type: FNiagaraCompute...

MaterialRelevance

type: FMaterialReleva...

SimTarget

type: ENiagaraSimTarg...

SystemInstanceID

type: FNiagaraSystemI...


code: const [FNiagaraDataSetCompiledData](API\Plugins\Niagara\FNiagaraDataSetCompiledData) & GetGPUCaptureDataSetCompiledData() const


className: FNiagaraEmitterCompiledData

DataSetCompiledData

type: FNiagaraDataSet...

description: Per-Emitter DataSet Data.

EmitterAgeVar

type: FNiagaraVariabl...

EmitterSpawnIntervalVar

description: Explicit list of Niagara Variables to bind to Emitter instances.

GPUCaptureDataSetCompiledData

description: Debug only data for caputuring from GPU sims, laziliy initialized when needed viaGetGPUCaptureDataSetCompiledData().

SpawnAttributes

type: TArray<FName>

description: Attribute names in the data set that are driving each emitter's spawning.


className: FNiagaraEmitterExecutionIndex

code: struct FNiagaraEmitterExecutionIndex

bStartNewOverlapGroup

type: uint32:  1

description: Flag to denote if the batcher should start a new overlap group, i.e. when we have a dependency ensure we don't overlap with the emitter we depend on.

EmitterIndex

description: Emitter index to use


description: Calls conditional post load on all sub-objects this handle references.

code: void ConditionalPostLoad ( int32 NiagaraCustomVersion )


code: [FVersionedNiagaraEmitterData](API\Plugins\Niagara\FVersionedNiagaraEmitterData) * GetEmitterData() const


description: Gets the unique id for this handle.


description: HACK! Data sets used to use the emitter name, but this isn't guaranteed to be unique. This is a temporary hack to allow the data sets to continue work with using names, but that code needs to be refactored to use the id defined here.


description: Gets the copied instance of the emitter this handle references.


description: Gets the display name for this emitter in the System.


description: Gets whether or not this emitter is enabled within the System. Disabled emitters aren't simulated.

code: bool GetIsEnabled() const


description: Gets a unique name for this emitter instance for use in scripts and parameter stores etc.


description: Whether or not this is a valid emitter handle.

code: bool IsValid() const


description: Determine whether or not the Instance script is in synch with its graph.

code: bool NeedsRecompile() const


code: void SetDebugShowBounds ( bool bShowBounds )


description: Sets whether or not this emitter is enabled within the System. Disabled emitters aren't simulated. Returns whether or not the enabled state changed.

code: bool SetIsEnabled ( bool bInIsEnabled, [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) & InOwnerSystem, bool bRecompileIfChanged )


code: void SetIsolated ( bool bInIsolated )


className: InvalidHandle

description: A static const invalid handle.

code: static const [FNiagaraEmitterHandle](API\Plugins\Niagara\FNiagaraEmitterHandle) InvalidHandle;


description: Sets the display name for this emitter in the System. The system is needed here in order to ensure uniqueness of the name.

code: void SetName ( [FName](API\Runtime\Core\UObject\FName) InName, [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) & InOwnerSystem )


description: Whether or not this handle uses the supplied emitter.

code: bool UsesEmitter ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter ) const


description: Creates a new invalid emitter handle.

code: FNiagaraEmitterHandle()


description: Creates a new emitter handle from an emitter.

code: FNiagaraEmitterHandle ( const [FVersionedNiagaraEmitter](API\Plugins\Niagara\FVersionedNiagaraEmitter) & InEmitter )


code: FNiagaraEmitterHandle ( [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) & InEmitter, const [FGuid](API\Runtime\Core\Misc\FGuid) & Version )


code: bool UsesEmitter ( const [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) & InEmitter ) const


className: FNiagaraEmitterHandle

description: Stores emitter information within the context of a System.


description: Replaces the binding for a single parameter collection instance. If for example the component begins to override the global instance.

code: void BindParameters ( bool bExternalOnly )


description: Calculate total number of spawned particles from events; these all come from event handler script with the SpawnedParticles execution mode We get the counts ahead of event processing time so we only have to allocate new particles once TODO: augment for multiple spawning event scripts

code: uint32 CalculateEventSpawnCount ( const [FNiagaraEventScriptProperties](API\Plugins\Niagara\FNiagaraEventScriptProperties) & EventHandlerProps, [TArray](API\Runtime\Core\Containers\TArray)< int32, TInlineAllocator< 16 >> & EventSpawnCounts, [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) * EventSet )


description: Potentially reads back data from the GPU which will introduce a stall and should only be used for debug purposes.

code: void CalculateFixedBounds ( const FTransform & ToWorldSpace )


code: [UObject](API\Runtime\CoreUObject\UObject\UObject) * FindBinding ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & InVariable ) const


code: [UNiagaraDataInterface](API\Plugins\Niagara\UNiagaraDataInterface) * FindDataInterface ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) & InVariable ) const


code: bool GetBoundRendererValue_GT ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & InBaseVar, const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & InSubVar, void * OutValueData ) const


code: [FVersionedNiagaraEmitterData](API\Plugins\Niagara\FVersionedNiagaraEmitterData) * GetCachedEmitterData() const


code: [FNiagaraDataSet](API\Plugins\Niagara\FNiagaraDataSet) & GetData() const


code: const [FNiagaraEmitterHandle](API\Plugins\Niagara\FNiagaraEmitterHandle) & GetEmitterHandle() const


code: [FNiagaraComputeExecutionContext](API\Plugins\Niagara\FNiagaraComputeExecutionContext) * GetGPUContext() const


code: [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * GetParentSystemInstance() const


code: const [FNiagaraParameterStore](API\Plugins\Niagara\FNiagaraParameterStore) & GetRendererBoundVariables() const


code: const [FNiagaraEmitterScalabilitySettings](API\Plugins\Niagara\FNiagaraEmitterScalabilitySettin-) & GetScalabilitySettings() const


code: [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraSpawnInfo](API\Plugins\Niagara\FNiagaraSpawnInfo) > & GetSpawnInfo()


code: int32 GetTotalSpawnedParticles() const


code: bool HandleCompletion ( bool bForce )


code: void Init ( int32 InEmitterIdx, [FNiagaraSystemInstanceID](API\Plugins\NiagaraCore\FNiagaraSystemInstanceID) SystemInstanceID )


code: bool IsParticleComponentActive ( [FObjectKey](API\Runtime\CoreUObject\UObject\FObjectKey) ComponentKey, int32 ParticleID ) const


description: Do any post work such as calculating dynamic bounds.

code: void PostTick()


description: PreTick - handles killing dead particles, emitter death, and buffer swaps

code: void PreTick()


code: bool RequiresPersistentIDs() const


code: void ResetSimulation ( bool bKillExisting )


code: void SetExecutionState ( [ENiagaraExecutionState](API\Plugins\Niagara\ENiagaraExecutionState) InState )


code: void SetFixedBounds ( const FBox & InLocalBounds )


code: void SetParticleComponentActive ( [FObjectKey](API\Runtime\CoreUObject\UObject\FObjectKey) ComponentKey, int32 ParticleID ) const


code: void SetSystemFixedBoundsOverride ( FBox SystemFixedBounds )


code: void Tick ( float DeltaSeconds )


code: void TickRapidIterationParameters()


code: void UnbindParameters ( bool bExternalOnly )


code: FNiagaraEmitterInstance ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * InParentSystemInstance )


code: virtual ~FNiagaraEmitterInstance()


className: FNiagaraEmitterInstance

description: A Niagara particle simulation.

code: class FNiagaraEmitterInstance


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetVariables()


className: FNiagaraEmitterParameters

description: Any change to this structure, or it's GetVariables implementation will require a bump in the CustomNiagaraVersion so that we properly rebuild the scripts You must pad this struct and the results ofGetVariables()to a 16 byte boundary.

code: struct FNiagaraEmitterParameters

description: Todo - what else should be inserted here? we could put an array of spawninfos/interp spawn values

EmitterAge

type: float


code: FNiagaraEmitterScalabilityOverride()


className: FNiagaraEmitterScalabilityOverride

bOverrideSpawnCountScale

description: Controls whether spawn count scale should be overridden.


className: FNiagaraEmitterScalabilityOverrides

description: Container struct for an array of emitter scalability overrides. Enables details customization and data validation.

Overrides

type: TArray<FNiagar...


code: FNiagaraEmitterScalabilitySettings()


className: FNiagaraEmitterScalabilitySettings

description: Scalability settings for Niagara Emitters on a particular platform set.

bScaleSpawnCount

description: Enable spawn count scaling

Platforms

type: FNiagaraPlatfor...

description: The platforms on which these settings are active (unless overridden).

SpawnCountScale

description: Scale factor applied to spawn counts for this emitter.


className: FNiagaraEmitterScalabilitySettingsArray

description: Container struct for an array of emitter scalability settings. Enables details customization and data validation.


code: bool DataSetAccessSynchronized() const


code: FNiagaraEmitterScriptProperties()


className: FNiagaraEmitterScriptProperties

Script

type: TObjectPtr<UNi...


code: [FNiagaraEmptyRDGUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyRDGUAVPoolScopedAcc-) & operator= ( const [FNiagaraEmptyRDGUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyRDGUAVPoolScopedAcc-) & )


code: [FNiagaraEmptyRDGUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyRDGUAVPoolScopedAcc-) & operator= ( [FNiagaraEmptyRDGUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyRDGUAVPoolScopedAcc-) && )


code: FNiagaraEmptyRDGUAVPoolScopedAccess ( [FNiagaraEmptyRDGUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyRDGUAVPoolScopedAcc-) && )


code: FNiagaraEmptyRDGUAVPoolScopedAccess ( const [FNiagaraEmptyRDGUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyRDGUAVPoolScopedAcc-) & )


code: FNiagaraEmptyRDGUAVPoolScopedAccess ( class [FNiagaraEmptyUAVPool](API\Plugins\Niagara\FNiagaraEmptyUAVPool) * EmptyUAVPool )


code: ~FNiagaraEmptyRDGUAVPoolScopedAccess()


className: FNiagaraEmptyRDGUAVPoolScopedAccess

description: Scoped access for RDG UAVs this is not required when running inside the main dispatch loop but is required for external usage that is outside, i.e. if you are doing some custom dispatch setup


className: FBufferRDGUAVPool

code: struct FBufferRDGUAVPool

UAVs

type: TArray< FRDGBuf...


className: FEmptyUAV

code: struct FEmptyUAV

Buffer

type: FBufferRHIRef

Texture

type: FTextureRHIRef

UAV

type: FUnorderedAcces...


className: FEmptyUAVPool

code: struct FEmptyUAVPool

UAVs

type: TArray<FEmptyU...


className: FTextureRDGUAVPool

code: struct FTextureRDGUAVPool

type: TArray< FRDGTex...


description: Grab a temporary empty RDG Buffer UAV from the pool. Note: When doing this outside of Niagara you must be within a FNiagaraUAVPoolAccessScope.

code: FRDGBufferUAVRef GetEmptyRDGUAVFromPool ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, EPixelFormat Format )


description: Grab a temporary empty RDG Texture UAV from the pool. Note: When doing this outside of Niagara you must be within a FNiagaraUAVPoolAccessScope.

code: FRDGTextureUAVRef GetEmptyRDGUAVFromPool ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, EPixelFormat Format, ETextureDimension TextureDimension )


description: Grab a temporary empty RW buffer from the pool. Note: When doing this outside of Niagara you must be within a FNiagaraUAVPoolAccessScope.

code: [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * GetEmptyUAVFromPool ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, EPixelFormat Format, [ENiagaraEmptyUAVType](API\Plugins\Niagara\ENiagaraEmptyUAVType) Type )


description: Returns all the RDG UAVs back to the pool.

code: void ResetEmptyRDGUAVPools()


description: Returns all used UAVs back to the pool.

code: void ResetEmptyUAVPools()


description: Must be called before we start to use the UAV pool for a given scene render.

code: void Tick()


className: FNiagaraEmptyUAVPool

description: Empty UAV pool used for ensuring we bind a buffer when one does not exist.

code: class FNiagaraEmptyUAVPool

BufferRDGUAVPool

type: FBufferRDGUAVPo...

type: FTextureRDGUAVP...

UAVPools

type: TMap< EPixelFor...


code: [FNiagaraEmptyUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyUAVPoolScopedAccess) & operator= ( const [FNiagaraEmptyUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyUAVPoolScopedAccess) & )


code: [FNiagaraEmptyUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyUAVPoolScopedAccess) & operator= ( [FNiagaraEmptyUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyUAVPoolScopedAccess) && )


code: FNiagaraEmptyUAVPoolScopedAccess ( [FNiagaraEmptyUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyUAVPoolScopedAccess) && )


code: FNiagaraEmptyUAVPoolScopedAccess ( const [FNiagaraEmptyUAVPoolScopedAccess](API\Plugins\Niagara\FNiagaraEmptyUAVPoolScopedAccess) & )


code: FNiagaraEmptyUAVPoolScopedAccess ( class [FNiagaraEmptyUAVPool](API\Plugins\Niagara\FNiagaraEmptyUAVPool) * EmptyUAVPool )


code: ~FNiagaraEmptyUAVPoolScopedAccess()


className: FNiagaraEmptyUAVPoolScopedAccess

description: Scoped access for UAVs this is not required when running inside the main dispatch loop but is required for external usage that is outside, i.e. if you are doing some custom dispatch setup

code: struct FNiagaraEmptyUAVPoolScopedAccess


className: FNiagaraEnumParameterMetaData

description: Defines override data for enum parameters displayed in the UI.

bUseColorOverride

type: bool

ColorOverride

type: FLinearColor

IconOverride

type: TObjectPtr<UTe...

description: If specified, this icon will be used for the given enum entry.

OverrideName

type: FName

description: If specified, this name will be used for the given enum entry. Useful for shortening names.


code: FNiagaraEventGeneratorProperties()


code: FNiagaraEventGeneratorProperties ( [FNiagaraDataSetProperties](API\Plugins\Niagara\FNiagaraDataSetProperties) & Props, [FName](API\Runtime\Core\UObject\FName) InEventGenerator )


className: FNiagaraEventGeneratorProperties

DataSetCompiledData

type: FNiagaraDataSet...

MaxEventsPerFrame

description: Max Number of Events that can be generated per frame.


code: void SetEventData ( [FNiagaraDataBuffer](API\Plugins\Niagara\FNiagaraDataBuffer) * InEventData )


className: FNiagaraEventHandlingInfo

description: Container for data needed to process event data.

code: struct FNiagaraEventHandlingInfo

EventData

type: FNiagaraDataBuf...

SourceEmitterGuid

type: FGuid

SpawnCounts

type: TArray< int32, ...


code: FNiagaraEventReceiverProperties()


code: FNiagaraEventReceiverProperties ( [FName](API\Runtime\Core\UObject\FName) InName, [FName](API\Runtime\Core\UObject\FName) InEventGenerator, [FName](API\Runtime\Core\UObject\FName) InSourceEmitter )


className: FNiagaraEventReceiverProperties

description: TODO: Event action that spawns other whole Systems? One that calls a BP exposed delegate?

Name

description: The name of this receiver.

SourceEmitter

description: The name of the emitter from which the Event Generator is taken.

SourceEventGenerator

description: The name of the EventGenerator to bind to.


className: FNiagaraEventScriptProperties

code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)() struct FNiagaraEventScriptProperties : public [FNiagaraEmitterScriptProperties](API\Plugins\Niagara\FNiagaraEmitterScriptProperties)

bRandomSpawnNumber

description: Whether using a random spawn number.

ExecutionMode

type: EScriptExecutio...

description: Controls which particles have the event script run on them.

MaxEventsPerFrame

description: Controls how many events are consumed by this event handler.

MinSpawnNumber

description: The minimum spawn number when random spawn is used. Spawn Number is used as the maximum range.

SourceEmitterID

description: Id of the Emitter Handle that generated the event.

SourceEventName

description: The name of the event generated.

SpawnNumber

description: Controls whether or not particles are spawned as a result of handling the event.

UpdateAttributeInitialValues

description: Should Event Spawn Scripts modify the Initial values for particle attributes they modify.


className: FNiagaraExternalUObjectInfo

Variable

type: FNiagaraVariabl...


code: void AddInput ( [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) InputVar, [FText](API\Runtime\Core\Internationalization\FText) Tooltip )


code: void AddOutput ( [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) OutputVar, const [FText](API\Runtime\Core\Internationalization\FText) & Tooltip )


code: bool EqualsIgnoringSpecifiers ( const [FNiagaraFunctionSignature](API\Plugins\Niagara\FNiagaraFunctionSignature) & Other ) const


code: void GetVariadicInputs ( [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) > & OutVariadicInputs, bool bStripNonExecution ) const


code: void GetVariadicOutputs ( [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) > & OutVariadicOutputs, bool bStripNonExecution ) const


code: bool operator== ( const [FNiagaraFunctionSignature](API\Plugins\Niagara\FNiagaraFunctionSignature) & Other ) const


code: bool operator!= ( const [FNiagaraFunctionSignature](API\Plugins\Niagara\FNiagaraFunctionSignature) & Other ) const


code: void SetDescription ( const [FText](API\Runtime\Core\Internationalization\FText) & Desc )


code: void SetFunctionVersion ( uint32 Version )


code: void SetInputDescription ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & Variable, const [FText](API\Runtime\Core\Internationalization\FText) & Desc )


code: void SetOutputDescription ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & Variable, const [FText](API\Runtime\Core\Internationalization\FText) & Desc )


code: FNiagaraFunctionSignature ( [FName](API\Runtime\Core\UObject\FName) InName, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & InInputs, [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & InOutputs, [FName](API\Runtime\Core\UObject\FName) InSource, bool bInRequiresContext, bool bInMemberFunction )


className: FNiagaraFunctionSignature

bExperimental

type: uint32:  1

description: Is this function experimental?

bHidden

description: Hidden functions can not be placed but may be bound and used.

bIsCompileTagGenerator

description: Whether or not this function should be treated as a compile tag.

bMemberFunction

description: True if this is the signature for a "member" function of a data interface.

bReadFunction

description: Reads data owned by the data interface. Any stage using it will be marked as an Input stage.

bRequiresExecPin

description: Does this function need an exec pin for control flow because it has internal side effects that be seen by the script VM and could therefore be optimized out? If so, set to true.

bSoftDeprecatedFunction

description: Whether or not this function should show up in normal usage.

bSupportsCPU

description: Support running on the CPU.

bSupportsGPU

description: Support running on the GPU.

bWriteFunction

description: Writes data owned by the data interface. Any stage using it will be marked as an Output stage.

ContextStageIndex

description: When using simulation stages and bRequiresContext is true this will be the index of the stage that is associated with the function.

Description

type: FText

description: Localized description of this node.

ExperimentalMessage

description: The message to display when a function is marked experimental.

FunctionSpecifiers

type: TMap<FName,FN...

description: Function specifiers verified at bind time.

FunctionVersion

description: Per function version, it is up to the discretion of the function as to what the version means.

InputDescriptions

type: TMap<FNiagaraV...

Inputs

type: TArray<FNiagar...

description: Input parameters to this function.

MiscUsageBitMask

description: Bit mask for misc usage.

ModuleUsageBitmask

description: Bitmask for which scripts are supported for this function.

Name

description: Name of the function.

Outputs

description: Input parameters of this function.

OwnerName

description: Id of the owner is this is a member function.

RequiredInputs

description: Number of required inputs.

RequiredOutputs

description: Number of required outputs.


className: FNiagaraGlobalBudgetScaling

bCullByGlobalBudget

description: Controls whether global budget based culling is enabled.

bScaleMaxDistanceByGlobalBudgetUse

description: Controls whether we scale down the MaxDistance based on the global budget use.

bScaleMaxInstanceCountByGlobalBudgetUse

description: Controls whether we scale down the system instance counts by global budget usage.

description: Controls whether we scale down the effect type instance counts by global budget usage.

MaxDistanceScaleByGlobalBudgetUse

type: FNiagaraLinearR...

description: When enabled, MaxDistance is scaled down by the global budget use based on this curve.

MaxGlobalBudgetUsage

type: float

description: Effects will be culled if the global budget usage exceeds this fraction.

MaxInstanceCountScaleByGlobalBudgetUse

description: When enabled, Max Effect Type Instances is scaled down by the global budget use based on this curve.

description: When enabled, Max System Instances is scaled down by the global budget use based on this curve.


code: static const [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & GetVariables()


className: FNiagaraGlobalParameters

description: Any change to this structure, or it's GetVariables implementation will require a bump in the CustomNiagaraVersion so that we properly rebuild the scripts You must pad this struct and the results ofGetVariables()to a 16 byte boundry.

code: struct FNiagaraGlobalParameters


code: [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) * GetOwnerInterface() const


code: FNiagaraGpuComputeDataManager &40; FNiagaraGpuComputeDataManager && &41;


code: FNiagaraGpuComputeDataManager &40; const FNiagaraGpuComputeDataManager & &41;


code: FNiagaraGpuComputeDataManager ( [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) * InOwnerInterface )


className: FNiagaraGpuComputeDataManager

description: The manager will be destroyed when the dispatch interface is also destroyed

code: class FNiagaraGpuComputeDataManager


description: Add a texture to visualize that contains a number of attributes and select which attributes to push into RGBA where -1 means ignore that channel The first -1 in the attribute indices list will also limit the number of attributes we attempt to read. NumTextureAttributes in this version is meant for a 2D atlas

code: void AddAttributeTexture ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FNiagaraSystemInstanceID](API\Plugins\NiagaraCore\FNiagaraSystemInstanceID) SystemInstanceID, [FName](API\Runtime\Core\UObject\FName) SourceName, FRDGTextureRef Texture, FIntPoint NumTextureAttributes, FIntVector4 AttributeIndices, FVector2D PreviewDisplayRange )


description: Add a texture to visualize that contains a number of attributes and select which attributes to push into RGBA where -1 means ignore that channel The first -1 in the attribute indices list will also limit the number of attributes we attempt to read NumTextureAttributes in this version is meant for a 3D atlas

code: void AddAttributeTexture ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FNiagaraSystemInstanceID](API\Plugins\NiagaraCore\FNiagaraSystemInstanceID) SystemInstanceID, [FName](API\Runtime\Core\UObject\FName) SourceName, FRDGTextureRef Texture, FIntVector4 NumTextureAttributes, FIntVector4 AttributeIndices, FVector2D PreviewDisplayRange )


description: Add a texture to visualize.

code: void AddTexture ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FNiagaraSystemInstanceID](API\Plugins\NiagaraCore\FNiagaraSystemInstanceID) SystemInstanceID, [FName](API\Runtime\Core\UObject\FName) SourceName, FRDGTextureRef Texture, FVector2D PreviewDisplayRange )


className: FNiagaraGpuComputeDebugInterface

description: No constructors are accessible with public or protected access.

code: class FNiagaraGpuComputeDebugInterface


description: Debug only function to readback data.

code: void AddDebugReadback ( [FNiagaraSystemInstanceID](API\Plugins\NiagaraCore\FNiagaraSystemInstanceID) InstanceID, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FNiagaraScriptDebuggerInfo](API\Plugins\Niagara\FNiagaraScriptDebuggerInfo), ESPMode::ThreadSafe > DebugInfo, [FNiagaraComputeExecutionContext](API\Plugins\Niagara\FNiagaraComputeExecutionContext) * Context )


description: Add system instance proxy to the batcher for tracking.

code: void AddGpuComputeProxy ( [FNiagaraSystemGpuComputeProxy](API\Plugins\Niagara\FNiagaraSystemGpuComputeProxy) * ComputeProxy )


description: Return true if the work was registered, or false it GPU sorting is not available or impossible.

code: bool AddSortedGPUSimulation ( struct [FNiagaraGPUSortInfo](API\Plugins\Niagara\FNiagaraGPUSortInfo) & SortInfo )


description: This will flush all pending ticks & readbacks from the dispatcher. Note: This is a GameThread blocking call and will impact performance

code: void FlushAndWait_GameThread()


description: Call this to force all pending ticks to be flushed from the batcher. Doing so will execute them outside of a view context which may result in undesirable results.

code: void FlushPendingTicks_GameThread()


code: static [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) * Get ( class [UWorld](API\Runtime\Engine\Engine\UWorld) * World )


code: static [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) * Get ( class [FSceneInterface](API\Runtime\Engine\FSceneInterface) * Scene )


code: static [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) * Get ( class [FFXSystemInterface](API\Runtime\Engine\FFXSystemInterface) * FXSceneInterface )


code: FNiagaraAsyncGpuTraceHelper & GetAsyncGpuTraceHelper() const


description: Helper function to return an RDG Texture where the texture contains 0 for all channels.

code: FRDGTextureRef GetBlackTexture ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, ETextureDimension TextureDimension ) const


description: Helper function to return a Buffer SRV which will contain 1 element of 0 value, i.e. to use as a dummy binding.

code: FRDGBufferSRVRef GetEmptyBufferSRV ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, EPixelFormat Format ) const


description: Helper function to return a RDG Texture SRV where the texture contains 0 for all channels.

code: FRDGTextureSRVRef GetBlackTextureSRV ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, ETextureDimension TextureDimension ) const


description: Helper function to return a Buffer UAV you don't care about the contents of or the results, i.e. to use as a dummy binding.

code: FRDGBufferUAVRef GetEmptyBufferUAV ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, EPixelFormat Format ) const


description: Helper function to return a RDG Texture UAV you don't care about the contents of or the results, i.e. to use as a dummy binding.

code: FRDGTextureUAVRef GetEmptyTextureUAV ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, EPixelFormat Format, ETextureDimension TextureDimension ) const


description: Convenience wrapper to get a UAV from the pool.

code: [FRHIUnorderedAccessView](API\Runtime\RHI\FRHIUnorderedAccessView) * GetEmptyUAVFromPool ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, EPixelFormat Format, [ENiagaraEmptyUAVType](API\Plugins\Niagara\ENiagaraEmptyUAVType) Type ) const


description: Get access to Niagara's GpuReadbackManager.

code: [FNiagaraEmptyUAVPool](API\Plugins\Niagara\FNiagaraEmptyUAVPool) * GetEmptyUAVPool() const


description: Get FeatureLevel the batcher is bound to


description: Get access to the global distance field data This will return nullptr if you attempt to access at an invalid point (i.e. before GDF is prepared or the GDF is not available)

code: const [FGlobalDistanceFieldParameterData](API\Runtime\Renderer\FGlobalDistanceFieldParameterDat-) * GetGlobalDistanceFieldData() const


description: Public interface to Niagara compute debugging.


description: Get access to Niagara's GpuComputeDebug this is for internal use

code: FNiagaraGpuComputeDebug * GetGpuComputeDebugPrivate() const


description: Get access to the instance count manager.


code: const [FNiagaraGPUInstanceCountManager](API\Plugins\Niagara\FNiagaraGPUInstanceCountManager) & GetGPUInstanceCounterManager() const


description: Access to Niagara's GPU Profiler

code: [FNiagaraGPUProfilerInterface](API\Plugins\Niagara\FNiagaraGPUProfilerInterface) * GetGPUProfiler() const


code: [FNiagaraGpuReadbackManager](API\Plugins\Niagara\FNiagaraGpuReadbackManager) * GetGpuReadbackManager() const


description: Get or create the a data manager, must be done on the rendering thread only.

code: template<typename TManager> TManager & GetOrCreateDataManager()


description: Get ShaderPlatform the batcher is bound to


description: Get access to the Views the simulation is being rendered with. List is only valid during graph building (i.e. during ExecuteTicks) and for simulations in PostInitViews / PostRenderOpaque.

code: TConstStridedView< [FSceneView](API\Runtime\Engine\FSceneView) > GetSimulationSceneViews() const


code: bool IsOutsideSceneRenderer() const


code: void MultiGPUResourceModified ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * Buffer, bool bRequiredForSimulation, bool bRequiredForRendering ) const


code: void MultiGPUResourceModified ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, bool bRequiredForSimulation, bool bRequiredForRendering ) const


description: Deprecated* ImmediateMode is deprecated for Niagara please migrate to using aFRDGBuilder

code: void MultiGPUResourceModified ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * Buffer, bool bRequiredForSimulation, bool bRequiredForRendering ) const


code: void MultiGPUResourceModified ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [FRHITexture](API\Runtime\RHI\FRHITexture) * Texture, bool bRequiredForSimulation, bool bRequiredForRendering ) const


description: Processes all pending debug readbacks

code: void ProcessDebugReadbacks ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, bool bWaitCompletion )


description: Remove system instance proxy from the batcher.

code: void RemoveGpuComputeProxy ( [FNiagaraSystemGpuComputeProxy](API\Plugins\Niagara\FNiagaraSystemGpuComputeProxy) * ComputeProxy )


code: FNiagaraGpuComputeDispatchInterface ( EShaderPlatform InShaderPlatform, [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) InFeatureLevel )


className: FNiagaraGpuComputeDispatchInterface

description: Public API for Niagara's Compute Dispatcher This is generally used with DataInterfaces or Custom Renderers

code: class FNiagaraGpuComputeDispatchInterface : public [FFXSystemInterface](API\Runtime\Engine\FFXSystemInterface)

bIsFirstViewFamily

type: bool

EmptyUAVPoolPtr

type: TUniquePtr<FNi...

FeatureLevel

type: ERHIFeatureLeve...

GpuComputeDebugPtr

type: TUniquePtr< FNi...

GpuDataManagers

type: TArray< TPair< ...

GPUInstanceCounterManager

type: FNiagaraGPUInst...

description: GPU emitter instance count buffer. Contains the actual particle / instance count generate in the GPU tick.

ShaderPlatform

type: EShaderPlatform

SimulationSceneViews

type: TConstStridedVi...


className: FDispatchResults

code: struct FDispatchResults

OwnerComponent

type: TWeakObjectPtr<...

OwnerEmitter

type: FVersionedNiaga...

StageName

type: FName


className: FNiagaraGpuFrameResults

description: Results generated when the frame is ready and sent to that game thread

code: struct FNiagaraGpuFrameResults : public [TSharedFromThis< FNiagaraGpuFrameResults, ESPMode::ThreadSafe >](API\Runtime\Core\Templates\TSharedFromThis)

DispatchResults

type: TArray<FDispat...


className: FNiagaraGpuFrameResultsPtr

code: typedef [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FNiagaraGpuFrameResults](API\Plugins\Niagara\FNiagaraGpuFrameResults), ESPMode::ThreadSafe > FNiagaraGpuFrameResultsPtr


code: [FRWBuffer](API\Runtime\RHI\FRWBuffer) * AcquireCulledCountsBuffer ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList )


description: Acquire an entry from the free list, assumes this comes from being presized.

code: uint32 AcquireEntry()


description: Acquire an entry, this will either come from the free list or reallocate the buffer.

code: uint32 AcquireOrAllocateEntry ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList )


code: bool CanAcquireCulledEntry() const


description: Add a draw indirect task to generate the draw indirect args. Returns the draw indirect arg buffer offset.

code: [FIndirectArgSlot](API\Plugins\Niagara\FNiagaraGPUInstanceCountManager\FIndirectArgSlot) AddDrawIndirect ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList, uint32 InstanceCountBufferOffset, uint32 NumIndicesPerInstance, uint32 StartIndexLocation, bool bIsInstancedStereoEnabled, bool bCulled, [ENiagaraGpuComputeTickStage::Type](API\Plugins\Niagara\ENiagaraGpuComputeTickStage__Typ-) ReadyTickStage )


code: void CopyToMultiViewCountBuffer ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList )


code: void EnqueueGPUReadback ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList )


code: FIndirectArgSlot &40; FBufferRHIRef InBuffer, FShaderResourceViewRHIRef InSRV, uint32 InOffset &41;


className: FIndirectArgSlot

code: struct FIndirectArgSlot

Buffer

type: FBufferRHIRef

SRV

type: FShaderResource...


className: FIndirectArgsPoolEntry

code: struct FIndirectArgsPoolEntry

Buffer

type: FRWBuffer


code: void FlushIndirectArgsPool ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList )


className: FNiagaraDrawIndirectArgGenSlotInfo

description: Set to allow de-duplication ofFNiagaraDrawIndirectArgGenTaskInfo.


description: Free the entry and reset it to INDEX_NONE if valid.

code: void FreeEntry ( uint32 & BufferOffset )


description: Free and array of entries, you are expected to reset or change to INDEX_NONE.

code: void FreeEntryArray ( TConstArrayView< uint32 > EntryArray )


code: const [FRWBuffer](API\Runtime\RHI\FRWBuffer) & GetInstanceCountBuffer() const


code: bool HasEntriesPendingFree() const


code: bool HasPendingGPUReadback() const


description: Init resource for the first time.

code: void InitRHI ( [FRHICommandListBase](API\Runtime\RHI\FRHICommandListBase) & RHICmdList )


className: kCountBufferDefaultState

code: static const ERHIAccess kCountBufferDefaultState = ERHIAccess::SRVMask | ERHIAccess::CopySrc;


className: kIndirectArgsDefaultState

code: static const ERHIAccess kIndirectArgsDefaultState = ERHIAccess::IndirectArgs | ERHIAccess::SRVMask;


description: Free resources.

code: void ReleaseRHI()


description: Resize instance count and draw indirect buffers to ensure it is big enough to hold all draw indirect args.

code: void ResizeBuffers ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList, int32 ReservedInstanceCounts )


description: Generate the draw indirect buffers, and reset all release counts.

code: void UpdateDrawIndirectBuffers ( [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) * ComputeDispatchInterface, [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [ENiagaraGPUCountUpdatePhase::Type](API\Plugins\Niagara\ENiagaraGPUCountUpdatePhase__Typ-) CountPhase )


code: ~FNiagaraGPUInstanceCountManager()


className: FNiagaraGPUInstanceCountManager

description: A manager that handles the buffer containing the GPU particle count. Also provides related functionalities like the generation of the draw indirect buffer.

code: class FNiagaraGPUInstanceCountManager

AllocatedCulledCounts

description: The allocated instance counts in the culled count buffer

AllocatedInstanceCounts

description: The allocated instance counts in CountBuffer

bAcquiredCulledCounts

description: Whether or not the culled counts were acquired this frame

CountBuffer

description: A buffer holding the each emitter particle count after a simulation tick.

CountReadback

type: FRHIGPUMemoryRe...

CulledCountsRHIAccess

type: ERHIAccess

description: Used to track RHI access for the culled counts buffer.

DrawIndirectArgGenTasks

type: TArray<FNiagar...

description: The list of all draw indirected tasks that are to be run inUpdateDrawIndirectBuffers()

DrawIndirectArgMap

type: TMap<FNiagaraD...

DrawIndirectPool

type: TArray<FIndire...

description: Buffers holding drawindirect data to render GPU emitter renderers.

FreeEntries

type: TArray< uint32 ...

InstanceCountClearTasks

description: The list of all instance count clear tasks that are to be run inUpdateDrawIndirectBuffers()

MultiViewAllocatedInstanceCounts

description: Mirrored copy of CountBuffer for multi-view rendering.

RequiredCulledCounts

description: The number of culled instance counts needed from view culling

UsedInstanceCounts

description: The current used instance counts allocated fromFNiagaraDataBuffer::AllocateGPU()


code: FNiagaraGpuProfileEvent ( const [FNiagaraComputeInstanceData](API\Plugins\Niagara\FNiagaraComputeInstanceData) & InstanceData, [FName](API\Runtime\Core\UObject\FName) CustomStageName )


code: FNiagaraGpuProfileEvent ( const [FNiagaraComputeInstanceData](API\Plugins\Niagara\FNiagaraComputeInstanceData) & InstanceData, const [FNiagaraSimStageData](API\Plugins\Niagara\FNiagaraSimStageData) & SimStageData, const bool bFirstInstanceData )


code: FNiagaraGPUInstanceCountManager ( [ERHIFeatureLevel::Type](API\Runtime\RHI\ERHIFeatureLevel__Type) FeatureLevel )


className: FNiagaraGpuProfileEvent

description: Public API for tracking GPU time when the profiler is enabled.

code: struct FNiagaraGpuProfileEvent


className: FOnFrameResults

code: typedef TMulticastDelegate_OneParam< void, const [FNiagaraGpuFrameResultsPtr](API\Plugins\Niagara\FNiagaraGpuFrameResultsPtr) & > FOnFrameResults


code: static FOnFrameResults & GetOnFrameResults_GameThread()


code: static FOnFrameResults & GetOnFrameResults_RenderThread()


className: NumReaders

code: static std::atomic< int > NumReaders;


code: void PostResults ( const [FNiagaraGpuFrameResultsPtr](API\Plugins\Niagara\FNiagaraGpuFrameResultsPtr) & FrameResults )


className: FNiagaraGPUProfilerInterface

description: Public API to Niagara GPU Profiling.

code: class FNiagaraGPUProfilerInterface


code: void SetEnabled ( bool bEnabled )


code: void SetHandler ( [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(const [FNiagaraGpuFrameResultsPtr](API\Plugins\Niagara\FNiagaraGpuFrameResultsPtr) &)> Function )


className: FNiagaraGpuProfilerListener

description: Allows various systems to listen to profiler results.

code: struct FNiagaraGpuProfilerListener


className: FNiagaraGpuProfileScope

code: struct FNiagaraGpuProfileScope


description: Enqueue a readback of a single buffer.

code: void EnqueueReadback ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGBufferRef Buffer, [FCompletionCallback](API\Plugins\Niagara\FNiagaraGpuReadbackManager\FCompletionCallback) Callback )


description: Deprecated* Support for legacy shaders bindings will be removed in a future release, please upgrade your data interface.

code: void EnqueueReadback ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * Buffer, [FCompletionCallback](API\Plugins\Niagara\FNiagaraGpuReadbackManager\FCompletionCallback) Callback )


description: Enqueue a readback of a single buffer.

code: void EnqueueReadback ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, FRDGBufferRef Buffer, uint32 Offset, uint32 NumBytes, [FCompletionCallback](API\Plugins\Niagara\FNiagaraGpuReadbackManager\FCompletionCallback) Callback )


code: void EnqueueReadback ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * Buffer, uint32 Offset, uint32 NumBytes, [FCompletionCallback](API\Plugins\Niagara\FNiagaraGpuReadbackManager\FCompletionCallback) Callback )


description: Enqueue a readback of multiple buffers.

code: void EnqueueReadbacks ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, TConstArrayView< FRDGBufferRef > Buffers, [FCompletionCallback](API\Plugins\Niagara\FNiagaraGpuReadbackManager\FCompletionCallback) Callback )


description: Enqueue a readback of multiple buffers.

code: void EnqueueReadbacks ( [FRDGBuilder](API\Runtime\RenderCore\FRDGBuilder) & GraphBuilder, TConstArrayView< [FRDGBufferRequest](API\Plugins\Niagara\FNiagaraGpuReadbackManager\FRDGBufferRequest) > BufferRequest, [FCompletionCallback](API\Plugins\Niagara\FNiagaraGpuReadbackManager\FCompletionCallback) Callback )


code: void EnqueueReadbacks ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, TConstArrayView< [FRHIBuffer](API\Runtime\RHI\FRHIBuffer) * > Buffers, [FCompletionCallback](API\Plugins\Niagara\FNiagaraGpuReadbackManager\FCompletionCallback) Callback )


code: void EnqueueReadbacks ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, TConstArrayView< [FBufferRequest](API\Plugins\Niagara\FNiagaraGpuReadbackManager\FBufferRequest) > BufferRequest, [FCompletionCallback](API\Plugins\Niagara\FNiagaraGpuReadbackManager\FCompletionCallback) Callback )


code: FBufferRequest &40; FRHIBuffer &42; InBuffer, uint32 InOffset, uint32 InSize &41;


className: FBufferRequest

code: struct FBufferRequest

Buffer

type: FRHIBuffer*...


className: FCompletionCallback

code: typedef [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void(TConstArrayView< TPair< void *, uint32 >>)> FCompletionCallback


className: FenceName

code: static const [FName](API\Runtime\Core\UObject\FName) FenceName;


className: FPendingReadback

code: struct FPendingReadback

Callback

type: FCompletionCall...

Fence

type: FGPUFenceRHIRef

StagingBuffers

type: TArray< TPair< ...


code: FNiagaraGpuProfileScope ( [FRHICommandList](API\Runtime\RHI\FRHICommandList) & RHICmdList, const class [FNiagaraGpuComputeDispatchInterface](API\Plugins\Niagara\FNiagaraGpuComputeDispatchInterf-) * ComputeDispatchInterface, const [FNiagaraGpuProfileEvent](API\Plugins\Niagara\FNiagaraGpuProfileEvent) & Event )


code: FRDGBufferRequest &40; FRDGBufferRef InBuffer, uint32 InOffset, uint32 InSize &41;


className: FRDGBufferRequest

code: struct FRDGBufferRequest

Buffer

type: FRDGBufferRef


description: Tick call which polls for completed readbacks.

code: void Tick()


description: Wait for all pending readbacks to complete.

code: void WaitCompletion ( [FRHICommandListImmediate](API\Runtime\RHI\FRHICommandListImmediate) & RHICmdList )


className: FNiagaraGpuReadbackManager

code: class FNiagaraGpuReadbackManager


className: FNiagaraGPURendererCount

description: The number of GPU renderers registered in the instance count manager. Shared between the manager and the renderers.

code: class FNiagaraGPURendererCount : public [FRefCountedObject](API\Runtime\Core\Templates\FRefCountedObject)


className: MaxCullPlanes

code: static constexpr uint32 MaxCullPlanes = 12;


description: Set the SortFlags based on the emitter and material constraints.

code: void SetSortFlags ( bool bHighPrecisionKeys, [ENiagaraGpuComputeTickStage::Type](API\Plugins\Niagara\ENiagaraGpuComputeTickStage__Typ-) ReadyTickStage )


className: FNiagaraGPUSortInfo

code: struct FNiagaraGPUSortInfo

AllocationInfo

type: FGPUSortManager...

description: The GPUSortManager bindings for this sort task.

bEnableCulling

type: bool

description: Culling/Visibility data.

CullingWorldSpaceOffset

type: FVector

CullPlanes

type: TArray< FPlane,...

GPUParticleCountSRV

description: The actual GPU sim particle count. Needed to get an exact match on the index list.

LocalBSphere

type: FSphere

ParticleCount

description: The number of particles in the system.

ParticleDataFloatSRV

description: The data buffers that hold the particle attributes and their strides.

SortAttributeOffset

description: On which attribute to base the sorting.

SortFlags

type: EGPUSortFlags

description: The sort constraints for the task in GPUSortManager.

SortMode

type: ENiagaraSortMod...

description: How the particles should be sorted.

ViewDirection

description: Forward declaration of concrete types // Macro version - declares all three variants.

ViewOrigin

description: View data.


className: FNiagaraGpuSpawnInfo

code: struct FNiagaraGpuSpawnInfo

SpawnInfoParams

type: FNiagaraGpuSpaw...


className: FNiagaraGpuSpawnInfoParams

code: struct FNiagaraGpuSpawnInfoParams

InterpStartDt

type: float


code: void GetEmitterParameters ( const [FNiagaraComputeInstanceData](API\Plugins\Niagara\FNiagaraComputeInstanceData) & InstanceData, void * OutputParameters ) const


code: [FRHIUniformBuffer](API\Runtime\RHI\FRHIUniformBuffer) * GetExternalUniformBuffer ( const [FNiagaraComputeInstanceData](API\Plugins\Niagara\FNiagaraComputeInstanceData) & InstanceData, bool bPrevious ) const


code: void GetGlobalParameters ( const [FNiagaraComputeInstanceData](API\Plugins\Niagara\FNiagaraComputeInstanceData) & InstanceData, void * OutputParameters ) const


code: [TArrayView](API\Runtime\Core\Containers\TArrayView)< [FNiagaraComputeInstanceData](API\Plugins\Niagara\FNiagaraComputeInstanceData) > GetInstances() const


code: void GetOwnerParameters ( const [FNiagaraComputeInstanceData](API\Plugins\Niagara\FNiagaraComputeInstanceData) & InstanceData, void * OutputParameters ) const


code: void GetSystemParameters ( const [FNiagaraComputeInstanceData](API\Plugins\Niagara\FNiagaraComputeInstanceData) & InstanceData, void * OutputParameters ) const


code: void Init ( [FNiagaraSystemInstance](API\Plugins\Niagara\FNiagaraSystemInstance) * InSystemInstance )


className: FNiagaraGPUSystemTick

description: InstanceData_ParamData_Packed packsFNiagaraComputeInstanceDataand ParamData into one buffer. There is padding after the array ofFNiagaraComputeInstanceDataso we can upload ParamData directly into a UniformBuffer (it is 16 byte aligned).

code: class FNiagaraGPUSystemTick

DIInstanceData

type: FNiagaraCompute...

type: TArray< FUnifor...

description: Transient data used by the RT.

GlobalParamData

type: uint8 *

InstanceDataDebuggingOnly

type: TConstArrayView...

description: Debugging only.

SystemGpuComputeProxy

type: FNiagaraSystemG...

SystemInstanceID

type: FNiagaraSystemI...

description: Data assigned by GT


code: virtual void GetStaticVariables ( [TArray](API\Runtime\Core\Containers\TArray)< [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) > & OutVars )


code: virtual bool IsValidForEmitter ( const [FVersionedNiagaraEmitterData](API\Plugins\Niagara\FVersionedNiagaraEmitterData) * InEmitterData ) const


code: virtual bool IsValidForSystem ( const [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * InSystem ) const


code: virtual void SetSourceEmitter ( const [FVersionedNiagaraEmitterData](API\Plugins\Niagara\FVersionedNiagaraEmitterData) * InEmitterData )


code: virtual void SetSourceSystem ( const [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem) * InSystem )


code: virtual ~FNiagaraGraphCachedDataBase()


className: FNiagaraGraphCachedDataBase

code: struct FNiagaraGraphCachedDataBase


code: const FVector2D & GetLocation() const


code: FNiagaraGraphViewSettings ( const FVector2D & InLocation, float InZoom )


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)(Meta=(DisplayName="Half Vector2", NiagaraInternalType="true")) struct FNiagaraHalfVector2


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)(Meta=(DisplayName="Half Vector3", NiagaraInternalType="true")) struct FNiagaraHalfVector3


code: [USTRUCT](Programming/UnrealArchitecture/Reference/Structs)(Meta=(DisplayName="Half Vector4", NiagaraInternalType="true")) struct FNiagaraHalfVector4


code: bool operator== ( const [FNiagaraID](API\Plugins\Niagara\FNiagaraID) & Other ) const


code: bool operator< ( const [FNiagaraID](API\Plugins\Niagara\FNiagaraID) & Other ) const


code: bool operator!= ( const [FNiagaraID](API\Plugins\Niagara\FNiagaraID) & Other ) const


code: FNiagaraID ( int32 InIndex, int32 InAcquireTag )


className: FNiagaraID

AcquireTag

description: A unique tag for when this ID was acquired.

Index

description: Indexin the indirection table for this particle.


className: FNiagaraIndexGenerationInput

code: struct FNiagaraIndexGenerationInput


code: FNiagaraInlineDynamicInputFormatToken()


code: FNiagaraInlineDynamicInputFormatToken ( [ENiagaraInlineDynamicInputFormatTokenUsage](API\Plugins\Niagara\ENiagaraInlineDynamicInputFormat-) InUsage, const [FString](API\Runtime\Core\Containers\FString) & InValue )


className: FNiagaraInputConditionMetadata

description: Defines options for conditionally editing and showing script inputs in the UI.

InputName

type: FName

description: The name of the input to use for matching the target values.

TargetValues

type: TArray<FString...

description: The list of target values which will satisfy the input condition.


className: FNiagaraInputParameterCustomization

EnumStyleDropdownValues

type: TArray<FNiagar...

InputDropdownValues

type: TArray<FWidget...

MaxValue

description: Max ui value (float and int types only)

MinValue

description: Min ui value (float and int types only)

StepWidth

description: Step width used by the input when dragging

WidgetType

type: ENiagaraInputWi...

description: Changes the widget implementation used for the input.


code: FNiagaraKnownConstantInfo ( const [FNiagaraVariable](API\Plugins\Niagara\FNiagaraVariable) * InConstantVar, const [ENiagaraKnownConstantType](API\Plugins\Niagara\ENiagaraKnownConstantType) InConstantType )


className: FNiagaraKnownConstantInfo

code: struct FNiagaraKnownConstantInfo

ConstantType

type: constENiagaraK...

ConstantVar

type: constFNiagaraV...


code: FNiagaraLinearRamp ( float InStartX, float InStartY, float InEndX, float InEndY )


className: FNiagaraInlineDynamicInputFormatToken

description: Defines a single token in a format for displaying dynamic input trees inline in the UI. These tokens can represent the inputs to the dynamic input or additional text and layout options.

Usage

type: ENiagaraInlineD...

description: Defines how the value of this token should be used when formatting the dynamic input tree.

Value

type: FString

description: The value of this token which is used for formatting an inline dynamic input tree.


className: FNiagaraLinearRamp

description: Simple linear ramp to drive scaling values. TODO: Replace with Curve that can baked down for fast eval and has good inline UI widgets.


code: FVector ConvertSimulationPositionToWorld ( [FNiagaraPosition](API\Plugins\Niagara\FNiagaraPosition) SimulationPosition ) const


code: FMatrix ConvertSimulationToWorldMatrix ( const FMatrix & Matrix ) const


code: FVector ConvertSimulationVectorToWorld ( FVector3f SimulationPosition ) const


code: FMatrix ConvertWorldToSimulationMatrix ( const FMatrix & Matrix ) const


code: [FNiagaraPosition](API\Plugins\Niagara\FNiagaraPosition) ConvertWorldToSimulationPosition ( FVector WorldPosition ) const


code: FVector3f ConvertWorldToSimulationVector ( FVector WorldPosition ) const


code: void AddConversionStep ( int32 InSourceBytes, int32 InSourceOffset, int32 InSimulationBytes, int32 InSimulationOffset, [ENiagaraStructConversionType](API\Plugins\Niagara\ENiagaraStructConversionType) ConversionType )


className: FNiagaraLWCConverter

code: struct FNiagaraLWCConverter


code: FNiagaraLWCConverter ( FVector InSystemWorldPos )


code: void ConvertDataFromSimulation ( uint8 * DestinationData, const uint8 * SourceData, int32 Count ) const


code: void ConvertDataToSimulation ( uint8 * DestinationData, const uint8 * SourceData, int32 Count ) const


className: FNiagaraLwcStructConverter

description: Can convert struct data from custom structs containing LWC data such as FVector3d into struct data suitable for Niagara simulations and vice versa.


code: const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & GetParamMapBindableVariable() const


code: void CacheValues ( const [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) * InEmitter )


code: bool Matches ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & OldVariable, const [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) * InEmitter, [ENiagaraRendererSourceDataMode](API\Plugins\Niagara\ENiagaraRendererSourceDataMode) InSourceMode )


code: bool RenameVariableIfMatching ( const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & OldVariable, const [FNiagaraVariableBase](API\Plugins\Niagara\FNiagaraVariableBase) & NewVariable, const [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) * InEmitter, [ENiagaraRendererSourceDataMode](API\Plugins\Niagara\ENiagaraRendererSourceDataMode) InSourceMode )


className: FNiagaraMaterialAttributeBinding

NiagaraChildVariable

type: FNiagaraVariabl...


code: bool operator== ( const [FNiagaraMeshMaterialOverride](API\Plugins\Niagara\FNiagaraMeshMaterialOverride) & Other ) const


description: Used to upgrade a serializedFNiagaraParameterStoreproperty to our own struct

code: bool SerializeFromMismatchedTag ( const struct [FPropertyTag](API\Runtime\CoreUObject\UObject\FPropertyTag) & Tag, [FStructuredArchive::FSlot](API\Runtime\Core\Serialization\FStructuredArchive\FSlot) Slot )


className: FNiagaraMeshMaterialOverride

ExplicitMat

type: TObjectPtr<UMa...

description: Use thisUMaterialInterfaceif set to a valid value.

UserParamBinding

type: FNiagaraUserPar...

description: Use theUMaterialInterfacebound to this user variable if it is set to a valid value.