UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FDynamicReadBuffer Struct Reference

#include <RHIUtilities.h>

+ Inheritance diagram for FDynamicReadBuffer:

Public Member Functions

 FDynamicReadBuffer ()
 
virtual ~FDynamicReadBuffer ()
 
void Initialize (FRHICommandListBase &RHICmdList, const TCHAR *DebugName, uint32 BytesPerElement, uint32 NumElements, EPixelFormat Format, EBufferUsageFlags AdditionalUsage=BUF_None)
 
void Lock (FRHICommandListBase &RHICmdList)
 
void Unlock (FRHICommandListBase &RHICmdList)
 
- Public Member Functions inherited from FReadBuffer
 FReadBuffer ()
 
void Initialize (FRHICommandListBase &RHICmdList, const TCHAR *InDebugName, uint32 BytesPerElement, uint32 NumElements, EPixelFormat Format, EBufferUsageFlags AdditionalUsage=BUF_None, FResourceArrayUploadInterface *InResourceArray=nullptr)
 
template<typename LAMBDA >
void InitializeWithData (FRHICommandListBase &RHICmdList, const TCHAR *InDebugName, uint32 BytesPerElement, uint32 NumElements, EPixelFormat Format, EBufferUsageFlags AdditionalUsage, LAMBDA &&InitializerFunction)
 
void Release ()
 

Public Attributes

uint8 * MappedBuffer
 
- Public Attributes inherited from FReadBuffer
FBufferRHIRef Buffer
 
FShaderResourceViewRHIRef SRV
 
uint32 NumBytes
 

Constructor & Destructor Documentation

◆ FDynamicReadBuffer()

FDynamicReadBuffer::FDynamicReadBuffer ( )
inline

Default constructor.

◆ ~FDynamicReadBuffer()

virtual FDynamicReadBuffer::~FDynamicReadBuffer ( )
inlinevirtual

Member Function Documentation

◆ Initialize()

void FDynamicReadBuffer::Initialize ( FRHICommandListBase &  RHICmdList,
const TCHAR *  DebugName,
uint32  BytesPerElement,
uint32  NumElements,
EPixelFormat  Format,
EBufferUsageFlags  AdditionalUsage = BUF_None 
)
inline

◆ Lock()

void FDynamicReadBuffer::Lock ( FRHICommandListBase &  RHICmdList)
inline

Locks the vertex buffer so it may be written to.

◆ Unlock()

void FDynamicReadBuffer::Unlock ( FRHICommandListBase &  RHICmdList)
inline

Unocks the buffer so the GPU may read from it.

Member Data Documentation

◆ MappedBuffer

uint8* FDynamicReadBuffer::MappedBuffer

Pointer to the vertex buffer mapped in main memory.

The documentation for this struct was generated from the following file: