FScatterUploadBuffer

Choose your operating system:

Windows

macOS

Linux

References

Module

RenderCore

Header

/Engine/Source/Runtime/RenderCore/Public/UnifiedBuffer.h

Include

#include "UnifiedBuffer.h"

Syntax

class FScatterUploadBuffer

Variables

Name Description

Public variable

bool

 

bFloat4Buffer

Public variable

bool

 

bUploadViaCreate

Public variable

uint32

 

MaxScatters

Public variable

uint32

 

NumBytesPerElement

Public variable

uint32

 

NumScatters

Public variable

FByteAddressBuf...

 

ScatterBuffer

Public variable

uint32 *

 

ScatterData

Public variable

uint32

 

ScatterDataSize

Public variable

FByteAddressBuf...

 

UploadBuffer

Public variable

uint8 *

 

UploadData

Public variable

uint32

 

UploadDataSize

Destructors

Name Description

Public function

~FScatterUploadBuffer()

Functions

Name Description

Public function

void

 

Add

(
    uint32 Index,
    const void* Data,
    uint32 Num
)

Public function

void *

 

Add_GetRef

(
    uint32 Index,
    uint32 Num
)

Public function Const

uint32

 

GetNumBytes()

Public function

void *

 

GetRef

(
    uint32 ElementIndex
)

Get pointer to an element data area, given the index of the element (not the destination scatter offset).

Public function

void

 

Init

(
    uint32 NumElements,
    uint32 InNumBytesPerElement,
    bool bInFloat4Buffer,
    const TCHAR* DebugName
)

Public function

void

 

Init

(
    TArrayView< const uint32 > ElementS...,
    uint32 InNumBytesPerElement,
    bool bInFloat4Buffer,
    const TCHAR* DebugName
)

Init with pre-existing destination index data, performs a bulk-copy.

Public function

void

 

InitPreSized

(
    uint32 NumElements,
    uint32 InNumBytesPerElement,
    bool bInFloat4Buffer,
    const TCHAR* DebugName
)

Init with presized num scatters, expecting each to be set at a later point.

Public function

void

 

Release()

Public function

void

 

ResourceUploadTo

(
    FRHICommandList& RHICmdList,
    const ResourceType& DstBuffer,
    bool bFlush
)

Public function

void *

 

Set_GetRef

(
    uint32 ElementIndex,
    uint32 ElementScatterOffset,
    uint32 Num
)

Public function

void

 

SetUploadViaCreate

(
    bool bInUploadViaCreate
)

Constants

Name

Description

PrimitiveDataStrideInFloat4s