Navigation
API > API/Plugins > API/Plugins/Niagara
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
| int | NumSpawnedIDs |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Allocate
(
int32 NumInstances, |
Allocates space for NumInstances in the current destination buffer. | |
| void | AllocateGPUFreeIDs
(
uint32 InNumInstances, |
||
| FNiagaraDataBuffer & | BeginSimulate
(
bool bResetDestinationData |
Begins a new simulation pass and grabs a destination buffer. | |
| void | CheckForNaNs () |
||
| void | CopyFromGPUReadback
(
const float* GPUReadBackFloat, |
||
| void | CopyTo
(
FNiagaraDataSet& Other, |
||
| void | |||
| void | EndSimulate
(
bool SetCurrentData |
Ends a simulation pass and sets the current simulation state. | |
| const FNiagaraDataSetCompiledData & | |||
| FNiagaraDataBuffer * | |||
| FNiagaraDataBuffer & | |||
| FNiagaraDataBuffer * | |||
| FNiagaraDataBuffer & | |||
| const TArray< int32 > & | |||
| TArray< int32 > & | |||
| FRWBuffer & | |||
| uint32 | |||
| FNiagaraDataSetID | GetID () |
||
| int32 & | |||
| uint32 | |||
| uint32 | |||
| int32 & | GetMaxUsedID () |
||
| uint32 | |||
| int32 & | |||
| uint32 | |||
| uint32 | |||
| uint32 | |||
| ENiagaraSimTarget | GetSimTarget () |
||
| int64 | GetSizeBytes () |
Returns size in bytes for all data buffers currently allocated by this dataset. | |
| const TArray< int32 > & | |||
| TArray< int32 > & | |||
| bool | GetVariableComponentOffsets
(
const FNiagaraVariableBase& Var, |
||
| const FNiagaraVariableLayoutInfo * | GetVariableLayout
(
const FNiagaraVariableBase& Var |
||
| const TArray< FNiagaraVariableLayoutInfo > & | |||
| const TArray< FNiagaraVariableBase > & | GetVariables () |
||
| bool | HasVariable
(
const FNiagaraVariableBase& Var |
||
| bool | HasVariable
(
const FName& Name |
||
| void | Init
(
const FNiagaraDataSetCompiledData* InDataSetCompiledData |
Initialize the data set with the compiled data | |
| bool | |||
| bool | |||
| bool | |||
| void | ResetBuffers () |
Resets current data but leaves variable/layout information etc intact. | |
| void | SetCurrentData
(
FNiagaraDataBuffer* CurrentData |
Set current data directly, you can not call this while inside a BeginSimulate block | |
| void | SetIDAcquireTag
(
int32 InTag |
||
| void | SetMaxAllocationCount
(
uint32 InMaxAllocationCount |
||
| void | SetMaxInstanceCount
(
uint32 InMaxInstanceCount |
Operators
| Type | Name | Description | |
|---|---|---|---|
| FNiagaraDataSet & | operator=
(
const FNiagaraDataSet& |