Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > FNiagaraDataSet

Light Theme

Dark Theme

FNiagaraDataSet

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

Windows

MacOS

Linux

References

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

Syntax

class FNiagaraDataSet

Remarks

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

Constructors

	Name	Description
	FNiagaraDataSet()

Destructors

	Name	Description
	~FNiagaraDataSet()

Functions

	Name	Description
void	Allocate ( int32 NumInstances, bool bMaintainExisting )	Allocates space for NumInstances in the current destination buffer.
void	AllocateGPUFreeIDs ( uint32 InNumInstances, FRHICommandList& RHICmdList, ERHIFeatureLevel::Type FeatureLevel, const TCHAR* DebugSimName )
FNiagaraData...	BeginSimulate ( bool bResetDestinationData )	Begins a new simulation pass and grabs a destination buffer.
void	CheckForNaNs()
void	CopyFromGPUReadback ( float* GPUReadBackFloat, int* GPUReadBackInt, int32 StartIdx, int32 NumInstances, uint32 FloatStride, uint32 IntStride )
void	CopyTo ( FNiagaraDataSet& Other, int32 StartIdx, int32 NumInstances, bool bResetOther )
void	Dump ( int32 StartIndex, int32 NumInstances, const FString& Label )
void	EndSimulate ( bool SetCurrentData )	Ends a simulation pass and sets the current simulation state.
FNiagaraData...	GetCurrentData()
FNiagaraData...	GetCurrentDataChecked()
FNiagaraData...	GetDestinationData()
FNiagaraData...	GetDestinationDataChecked()
TArray< int3...	GetFreeIDTable()
FRWBuffer &	GetGPUFreeIDs()
uint32	GetGPUNumAllocatedIDs()
FNiagaraData...	GetID()
int32 &	GetIDAcquireTag()
uint32	GetMaxInstanceCount()
int32 &	GetMaxUsedID()
uint32	GetNumFloatComponents()
int32 &	GetNumFreeIDs()
uint32	GetNumInt32Components()
uint32	GetNumVariables()
ENiagaraSimT...	GetSimTarget()
uint32	GetSizeBytes()	Returns size in bytes for all data buffers currently allocated by this dataset.
TArray< int3...	GetSpawnedIDsTable()
bool	GetVariableComponentOffsets ( const FNiagaraVariable& Var, int32& FloatStart, int32& IntStart )
const FNiaga...	GetVariableLayout ( const FNiagaraVariable& Var )
const TArray...	GetVariableLayouts()
const TArray...	GetVariables()
bool	HasVariable ( const FNiagaraVariable& Var )
void	Init ( const FNiagaraDataSetCompiledData&... )
bool	IsCurrentDataValid()
bool	IsInitialized()
void	ReleaseGPUInstanceCounts ( FNiagaraGPUInstanceCountManager& G... )	Release the GPU instance counts so that they can be reused
bool	RequiresPersistentIDs()
void	ResetBuffers()	Resets current data but leaves variable/layout information etc intact.
void	SetIDAcquireTag ( int32 InTag )
void	SetMaxInstanceCount ( uint32 InInstanceCount )

Operators

		Name	Description
	FNiagaraData...	operator= ( const FNiagaraDataSet& )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss