1. Epic GamesDeveloper
  3. FNiagaraDataBuffer

FNiagaraDataBuffer

Buffer containing one frame of Niagara simulation data.

API > API/Plugins > API/Plugins/Niagara

Buffer containing one frame of Niagara simulation data.

   
Name FNiagaraDataBuffer
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataSet.h
Include Path #include "NiagaraDataSet.h"

Syntax

class FNiagaraDataBuffer : public FNiagaraSharedObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraDataBuffer ( FNiagaraDataSet* InOwner
)

   NiagaraDataSet.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FNiagaraDataBuffer()

   NiagaraDataSet.h  

Typedefs

Name Type Remarks Include Path
RegisterTypeOffsetType uint32   NiagaraDataSet.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AllocationSizeBytes int32   NiagaraDataSet.h  
FloatData TArray< uint8 > CPU Data. NiagaraDataSet.h  
FloatStride uint32 Stride between components in the float buffer. NiagaraDataSet.h  
GPUBufferFloat FRWBuffer GPU Buffer containing floating point values for GPU simulations. NiagaraDataSet.h  
GPUBufferHalf FRWBuffer GPU Buffer containing half values for GPU simulations. NiagaraDataSet.h  
GPUBufferInt FRWBuffer GPU Buffer containing integer values for GPU simulations. NiagaraDataSet.h  
GPUDataReadyStage ENiagaraGpuComputeTickStage::Type GPU Data. NiagaraDataSet.h  
GPUIDToIndexTable FRWBuffer GPU table which maps particle ID to index. NiagaraDataSet.h  
GPUInstanceCountBufferOffset uint32 The buffer offset where the instance count is accumulated. NiagaraDataSet.h  
HalfData TArray< uint8 > Half components of simulation data. NiagaraDataSet.h  
HalfStride uint32 Stride between components in the half buffer. NiagaraDataSet.h  
IDAcquireTag uint32 ID acquire tag used in the last tick. NiagaraDataSet.h  
IDToIndexTable TArray< int32 > Table of IDs to real buffer indices. NiagaraDataSet.h  
Int32Data TArray< uint8 > Int32 components of simulation data. NiagaraDataSet.h  
Int32Stride uint32 Stride between components in the int32 buffer. NiagaraDataSet.h  
NumInstances uint32 Number of instances in data. NiagaraDataSet.h  
NumInstancesAllocated uint32 Number of instances the buffer has been allocated for. NiagaraDataSet.h  
NumSpawnedInstances uint32 Number of instances spawned in the last tick. NiagaraDataSet.h  
Owner FNiagaraDataSet * Back ptr to our owning data set. Used to access layout info for the buffer. NiagaraDataSet.h  
RegisterTable TArray< uint8 * > Table containing current base locations for all registers in this dataset. NiagaraDataSet.h  
RegisterTypeOffsets RegisterTypeOffsetType   NiagaraDataSet.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Allocate ( uint32 NumInstances,
bool bMaintainExisting
)

   NiagaraDataSet.h  

void AllocateGPU ( FRHICommandListBase& RHICmdList,
uint32 InNumInstances,
ERHIFeatureLevel::Type FeatureLevel,
const TCHAR* DebugSimName
)

   NiagaraDataSet.h  

void BuildRegisterTable()

   NiagaraDataSet.h  

bool CheckForNaNs()

   NiagaraDataSet.h  

void ClearGPUInstanceCount()

   NiagaraDataSet.h  

void CopyTo ( FNiagaraDataBuffer& DestBuffer,
int32 SrcStartIdx,
int32 DestStartIdx,
int32 NumInstances
) const

   NiagaraDataSet.h  

void CopyToUnrelated ( FNiagaraDataBuffer& DestBuffer,
int32 SrcStartIdx,
int32 DestStartIdx,
int32 NumInstances
) const

   NiagaraDataSet.h  

void Dump ( int32 StartIndex,
int32 NumInstances,
const FString& Label,
const FName& SortParameterKey
) const

   NiagaraDataSet.h  

TArrayView< uint8 *__restrict const > EditRegisterTable()

   NiagaraDataSet.h  

int32 GetAllocationSizeBytes()

   NiagaraDataSet.h  

const uint8 * GetComponentPtrFloat ( uint32 ComponentIdx
) const

   NiagaraDataSet.h  

uint8 * GetComponentPtrFloat ( uint32 ComponentIdx
)

   NiagaraDataSet.h  

uint8 * GetComponentPtrFloat ( float* BasePtr,
uint32 ComponentIdx
) const

   NiagaraDataSet.h  

uint8 * GetComponentPtrHalf ( FFloat16* BasePtr,
uint32 ComponentIdx
) const

   NiagaraDataSet.h  

uint8 * GetComponentPtrHalf ( uint32 ComponentIdx
)

   NiagaraDataSet.h  

const uint8 * GetComponentPtrHalf ( uint32 ComponentIdx
) const

   NiagaraDataSet.h  

uint8 * GetComponentPtrInt32 ( int* BasePtr,
uint32 ComponentIdx
) const

   NiagaraDataSet.h  

uint8 * GetComponentPtrInt32 ( uint32 ComponentIdx
)

   NiagaraDataSet.h  

const uint8 * GetComponentPtrInt32 ( uint32 ComponentIdx
) const

   NiagaraDataSet.h  

const TArray< uint8 > & GetFloatBuffer()

   NiagaraDataSet.h  

uint32 GetFloatStride()

   NiagaraDataSet.h  

FRWBuffer & GetGPUBufferFloat()

   NiagaraDataSet.h  

FRWBuffer & GetGPUBufferHalf()

   NiagaraDataSet.h  

FRWBuffer & GetGPUBufferInt()

   NiagaraDataSet.h  

ENiagaraGpuComputeTickStage::Type GetGPUDataReadyStage()

   NiagaraDataSet.h  

FRWBuffer & GetGPUIDToIndexTable()

   NiagaraDataSet.h  

uint32 GetGPUInstanceCountBufferOffset()

   NiagaraDataSet.h  

const TArray< uint8 > & GetHalfBuffer()

   NiagaraDataSet.h  

uint32 GetHalfStride()

   NiagaraDataSet.h  

uint32 GetIDAcquireTag()

   NiagaraDataSet.h  

TArray< int32 > & GetIDTable ()

   NiagaraDataSet.h  

const TArray< int32 > & GetIDTable ()

   NiagaraDataSet.h  

float * GetInstancePtrFloat ( uint32 ComponentIdx,
uint32 InstanceIdx
)

   NiagaraDataSet.h  

float * GetInstancePtrFloat ( float* BasePtr,
uint32 ComponentIdx,
uint32 InstanceIdx
) const

   NiagaraDataSet.h  

const float * GetInstancePtrFloat ( uint32 ComponentIdx,
uint32 InstanceIdx
) const

   NiagaraDataSet.h  

FFloat16 * GetInstancePtrHalf ( FFloat16* BasePtr,
uint32 ComponentIdx,
uint32 InstanceIdx
) const

   NiagaraDataSet.h  

const FFloat16 * GetInstancePtrHalf ( uint32 ComponentIdx,
uint32 InstanceIdx
) const

   NiagaraDataSet.h  

FFloat16 * GetInstancePtrHalf ( uint32 ComponentIdx,
uint32 InstanceIdx
)

   NiagaraDataSet.h  

int32 * GetInstancePtrInt32 ( uint32 ComponentIdx,
uint32 InstanceIdx
)

   NiagaraDataSet.h  

int32 * GetInstancePtrInt32 ( int* BasePtr,
uint32 ComponentIdx,
uint32 InstanceIdx
) const

   NiagaraDataSet.h  

const int32 * GetInstancePtrInt32 ( uint32 ComponentIdx,
uint32 InstanceIdx
) const

   NiagaraDataSet.h  

const TArray< uint8 > & GetInt32Buffer()

   NiagaraDataSet.h  

uint32 GetInt32Stride()

   NiagaraDataSet.h  

uint32 GetNumInstances()

   NiagaraDataSet.h  

uint32 GetNumInstancesAllocated()

   NiagaraDataSet.h  

uint32 GetNumSpawnedInstances()

   NiagaraDataSet.h  

FNiagaraDataSet * GetOwner()

   NiagaraDataSet.h  

const RegisterTypeOffsetType & GetRegisterTypeOffsets()

   NiagaraDataSet.h  
  NiagaraDataSet.h  

void GPUCopyFrom ( const float* GPUReadBackFloat,
const int* GPUReadBackInt,
const FFloat16* GPUReadBackHalf,
int32 StartIdx,
int32 NumInstances,
uint32 InSrcFloatStride,
uint32 InSrcIntStride,
uint32 InSrcHalfStride
)

   NiagaraDataSet.h  

void KillInstance ( uint32 InstanceIdx
)

   NiagaraDataSet.h  

void PushCPUBuffersToGPU ( const TArray< FNiagaraDataBufferRef >& SourceBuffers,
bool bReleaseRef,
FRHICommandList& RHICmdList,
ERHIFeatureLevel::Type FeatureLevel,
const TCHAR* DebugSimName,
bool bAllocate
)

   NiagaraDataSet.h  

TArrayView< uint8 const *__restrict const > ReadRegisterTable()

   NiagaraDataSet.h  

void ReleaseCPU()

   NiagaraDataSet.h  

void ReleaseGPU()

   NiagaraDataSet.h  

void SetGPUDataReadyStage ( ENiagaraGpuComputeTickStage::Type InReadyStage
)

   NiagaraDataSet.h  

void SetGPUInstanceCountBufferOffset ( uint32 Offset
)

   NiagaraDataSet.h  

void SetIDAcquireTag ( uint32 InTag
)

   NiagaraDataSet.h  

void SetNumInstances ( uint32 InNumInstances
)

   NiagaraDataSet.h  

void SetNumSpawnedInstances ( uint32 InNumSpawnedInstances
)

   NiagaraDataSet.h  

void SwapGPU ( FNiagaraDataBuffer* BufferToSwap
)

   NiagaraDataSet.h  

void SwapInstances ( uint32 OldIndex,
uint32 NewIndex
)

   NiagaraDataSet.h  

void TransferGPUToCPUImmediate ( FRHICommandListImmediate& RHICmdList,
FNiagaraGpuComputeDispatchInterface* ComputeInterface,
FNiagaraDataBuffer* CPUBuffer
) const

   NiagaraDataSet.h  

int32 TransferInstance ( FNiagaraDataBuffer& SourceBuffer,
int32 InstanceIndex,
bool bRemoveFromSource
)

   NiagaraDataSet.h  

TRefCountPtr< FNiagaraDataBuffer > UnlockForRead()

   NiagaraDataSet.h  

void ZeroCPUBuffers()

   NiagaraDataSet.h  

Protected

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page