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

#include <DynamicBufferAllocator.h>

+ Inheritance diagram for FDynamicAllocReadBuffer:

Public Member Functions

void Lock ()
 
void Unlock ()
 
void Lock (FRHICommandListBase &RHICmdList)
 
void Unlock (FRHICommandListBase &RHICmdList)
 
- Public Member Functions inherited from FDynamicReadBuffer
 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

int32 AllocatedByteCount = 0
 
int32 NumFramesUnused = 0
 
TArray< FShaderResourceViewRHIRef > SubAllocations
 
- Public Attributes inherited from FDynamicReadBuffer
uint8 * MappedBuffer
 
- Public Attributes inherited from FReadBuffer
FBufferRHIRef Buffer
 
FShaderResourceViewRHIRef SRV
 
uint32 NumBytes
 

Member Function Documentation

◆ Lock() [1/2]

void FDynamicAllocReadBuffer::Lock ( )
inline

◆ Lock() [2/2]

void FDynamicAllocReadBuffer::Lock ( FRHICommandListBase &  RHICmdList)
inline

◆ Unlock() [1/2]

void FDynamicAllocReadBuffer::Unlock ( )
inline

◆ Unlock() [2/2]

void FDynamicAllocReadBuffer::Unlock ( FRHICommandListBase &  RHICmdList)
inline

Unocks the buffer so the GPU may read from it.

Member Data Documentation

◆ AllocatedByteCount

int32 FDynamicAllocReadBuffer::AllocatedByteCount = 0

◆ NumFramesUnused

int32 FDynamicAllocReadBuffer::NumFramesUnused = 0

Number of successive frames for which AllocatedByteCount == 0. Used as a metric to decide when to free the allocation.

◆ SubAllocations

TArray<FShaderResourceViewRHIRef> FDynamicAllocReadBuffer::SubAllocations
The documentation for this struct was generated from the following file: