FNiagaraDataBuffer

Buffer containing one frame of Niagara simulation data.

Windows
MacOS
Linux

Inheritance Hierarchy

FNiagaraSharedObject

FNiagaraDataBuffer

References

Module

Niagara

Header

/Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataSet.h

Include

#include "NiagaraDataSet.h"

Syntax

class FNiagaraDataBuffer : public FNiagaraSharedObject

Remarks

Buffer containing one frame of Niagara simulation data.

Constructors

Name Description

Public function

FNiagaraDataBuffer

(
    FNiagaraDataSet* InOwner
)

Destructors

Name Description

Protected function Virtual

~FNiagaraDataBuffer()

Functions

Name Description

Public function

void

 

Allocate

(
    uint32 NumInstances,
    bool bMaintainExisting
)

Public function

void

 

AllocateGPU

(
    FRHICommandList& RHICmdList,
    uint32 InNumInstances,
    ERHIFeatureLevel::Type FeatureLevel,
    const TCHAR* DebugSimName
)

Public function

void

 

BuildRegisterTable()

Public function Const

bool

 

CheckForNaNs()

Public function

void

 

ClearGPUInstanceCount()

Public function Const

void

 

CopyTo

(
    FNiagaraDataBuffer& DestBuffer,
    int32 SrcStartIdx,
    int32 DestStartIdx,
    int32 NumInstances
)

Public function Const

void

 

Dump

(
    int32 StartIndex,
    int32 NumInstances,
    const FString& Label
)

Public function Const

uint8 *

 

GetComponentPtrFloat

(
    float* BasePtr,
    uint32 ComponentIdx
)

Public function

uint8 *

 

GetComponentPtrFloat

(
    uint32 ComponentIdx
)

Public function Const

const uint8 ...

 

GetComponentPtrFloat

(
    uint32 ComponentIdx
)

Public function Const

uint8 *

 

GetComponentPtrHalf

(
    FFloat16* BasePtr,
    uint32 ComponentIdx
)

Public function

uint8 *

 

GetComponentPtrHalf

(
    uint32 ComponentIdx
)

Public function Const

const uint8 ...

 

GetComponentPtrHalf

(
    uint32 ComponentIdx
)

Public function Const

uint8 *

 

GetComponentPtrInt32

(
    int* BasePtr,
    uint32 ComponentIdx
)

Public function Const

const uint8 ...

 

GetComponentPtrInt32

(
    uint32 ComponentIdx
)

Public function

uint8 *

 

GetComponentPtrInt32

(
    uint32 ComponentIdx
)

Public function Const

const TArray...

 

GetFloatBuffer()

Public function Const

uint32

 

GetFloatStride()

Public function

FRWBuffer &

 

GetGPUBufferFloat()

Public function

FRWBuffer &

 

GetGPUBufferHalf()

Public function

FRWBuffer &

 

GetGPUBufferInt()

Public function

FRWBuffer &

 

GetGPUIDToIndexTable()

Public function Const

uint32

 

GetGPUInstanceCountBufferOffset()

Public function Const

const TArray...

 

GetHalfBuffer()

Public function Const

uint32

 

GetHalfStride()

Public function Const

uint32

 

GetIDAcquireTag()

Public function

TArray< int3...

 

GetIDTable()

Public function Const

const TArray...

 

GetIDTable()

Public function

float *

 

GetInstancePtrFloat

(
    uint32 ComponentIdx,
    uint32 InstanceIdx
)

Public function Const

const float ...

 

GetInstancePtrFloat

(
    uint32 ComponentIdx,
    uint32 InstanceIdx
)

Public function Const

float *

 

GetInstancePtrFloat

(
    float* BasePtr,
    uint32 ComponentIdx,
    uint32 InstanceIdx
)

Public function

FFloat16 ...

 

GetInstancePtrHalf

(
    uint32 ComponentIdx,
    uint32 InstanceIdx
)

Public function Const

FFloat16 ...

 

GetInstancePtrHalf

(
    FFloat16* BasePtr,
    uint32 ComponentIdx,
    uint32 InstanceIdx
)

Public function Const

const FFloat...

 

GetInstancePtrHalf

(
    uint32 ComponentIdx,
    uint32 InstanceIdx
)

Public function Const

int32 *

 

GetInstancePtrInt32

(
    int* BasePtr,
    uint32 ComponentIdx,
    uint32 InstanceIdx
)

Public function

int32 *

 

GetInstancePtrInt32

(
    uint32 ComponentIdx,
    uint32 InstanceIdx
)

Public function Const

const int32 ...

 

GetInstancePtrInt32

(
    uint32 ComponentIdx,
    uint32 InstanceIdx
)

Public function Const

const TArray...

 

GetInt32Buffer()

Public function Const

uint32

 

GetInt32Stride()

Public function Const

uint32

 

GetNumInstances()

Public function Const

uint32

 

GetNumInstancesAllocated()

Public function Const

uint32

 

GetNumSpawnedInstances()

Public function Const

FNiagaraData...

 

GetOwner()

Public function Const

TArrayView< ...

 

GetRegisterTable()

Public function

const Regist...

 

GetRegisterTypeOffsets()

Public function Const

int32

 

GetSafeComponentBufferSize()

Public function

void

 

GPUCopyFrom

(
    const float* GPUReadBackFloat,
    const int* GPUReadBackInt,
    const FFloat16* GPUReadBackHal...,
    int32 StartIdx,
    int32 NumInstances,
    uint32 InSrcFloatStride,
    uint32 InSrcIntStride,
    uint32 InSrcHalfStride
)

Public function

void

 

KillInstance

(
    uint32 InstanceIdx
)

Public function

void

 

ReleaseGPU()

Public function

void

 

SetIDAcquireTag

(
    uint32 InTag
)

Public function Static

void

 

SetInputShaderParams

(
    FRHICommandList& RHICmdList,
    FNiagaraShader* Shader,
    FNiagaraDataBuffer* Buffer
)

Public function

void

 

SetNumInstances

(
    uint32 InNumInstances
)

Public function

void

 

SetNumSpawnedInstances

(
    uint32 InNumSpawnedInstances
)

Public function Static

void

 

SetOutputShaderParams

(
    FRHICommandList& RHICmdList,
    FNiagaraShader* Shader,
    FNiagaraDataBuffer* Buffer
)

Public function

void

 

SwapGPU

(
    FNiagaraDataBuffer* BufferToAl...
)

Public function

void

 

SwapInstances

(
    uint32 OldIndex,
    uint32 NewIndex
)

Public function

int32

 

TransferInstance

(
    FNiagaraDataBuffer& SourceBuffer,
    int32 InstanceIndex,
    bool bRemoveFromSource
)

Public function Static

void

 

UnsetShaderParams

(
    FRHICommandList& RHICmdList,
    FNiagaraShader* Shader
)

Typedefs

Name

Description

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