UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TDynamicBuffer< BufferType > Class Template Referencefinal
+ Inheritance diagram for TDynamicBuffer< BufferType >:

Public Types

enum  { ALIGNMENT = (1 << 16) }
 

Public Member Functions

 TDynamicBuffer (uint32 InMinBufferSize, uint32 InStride)
 
void Lock (FRHICommandListBase &RHICmdList)
 
void Unlock (FRHICommandListBase &RHICmdList)
 
virtual void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual void ReleaseRHI () override
 

Public Attributes

uint8MappedBuffer
 
uint32 BufferSize
 
uint32 AllocatedByteCount
 
uint32 Stride
 
uint64 LastUsedFrame = 0
 

Detailed Description

template<typename BufferType>
class TDynamicBuffer< BufferType >

An individual dynamic vertex buffer.

Member Enumeration Documentation

◆ anonymous enum

template<typename BufferType >
anonymous enum

The aligned size of all dynamic vertex buffers.

Enumerator
ALIGNMENT 

Constructor & Destructor Documentation

◆ TDynamicBuffer()

template<typename BufferType >
TDynamicBuffer< BufferType >::TDynamicBuffer ( uint32  InMinBufferSize,
uint32  InStride 
)
inlineexplicit

Default constructor.

Member Function Documentation

◆ InitRHI()

template<typename BufferType >
virtual void TDynamicBuffer< BufferType >::InitRHI ( FRHICommandListBase RHICmdList)
inlineoverridevirtual

◆ Lock()

template<typename BufferType >
void TDynamicBuffer< BufferType >::Lock ( FRHICommandListBase RHICmdList)
inline

Locks the vertex buffer so it may be written to.

◆ ReleaseRHI()

template<typename BufferType >
virtual void TDynamicBuffer< BufferType >::ReleaseRHI ( )
inlineoverridevirtual

◆ Unlock()

template<typename BufferType >
void TDynamicBuffer< BufferType >::Unlock ( FRHICommandListBase RHICmdList)
inline

Unocks the buffer so the GPU may read from it.

Member Data Documentation

◆ AllocatedByteCount

template<typename BufferType >
uint32 TDynamicBuffer< BufferType >::AllocatedByteCount

Number of bytes currently allocated from the buffer.

◆ BufferSize

template<typename BufferType >
uint32 TDynamicBuffer< BufferType >::BufferSize

Size of the vertex buffer in bytes.

◆ LastUsedFrame

template<typename BufferType >
uint64 TDynamicBuffer< BufferType >::LastUsedFrame = 0

Last render thread frame this resource was used in.

◆ MappedBuffer

template<typename BufferType >
uint8* TDynamicBuffer< BufferType >::MappedBuffer

Pointer to the vertex buffer mapped in main memory.

◆ Stride

template<typename BufferType >
uint32 TDynamicBuffer< BufferType >::Stride

Stride of the buffer in bytes.


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