UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMetalRHIStagingBuffer Class Referencefinal

#include <MetalRHIStagingBuffer.h>

+ Inheritance diagram for FMetalRHIStagingBuffer:

Public Member Functions

 FMetalRHIStagingBuffer (FMetalDevice &Device)
 
virtual ~FMetalRHIStagingBuffer () final override
 
virtual voidLock (uint32 Offset, uint32 NumBytes) final override
 
virtual void Unlock () final override
 
uint64 GetGPUSizeBytes () const override
 
- Public Member Functions inherited from FRHIStagingBuffer
 FRHIStagingBuffer ()
 
virtual ~FRHIStagingBuffer ()
 
- Public Member Functions inherited from FRHIResource
RHI_API FRHIResource (ERHIResourceType InResourceType)
 
uint32 AddRef () const
 
uint32 Release () const
 
uint32 GetRefCount () const
 
bool IsValid () const
 
void DisableLifetimeExtension ()
 
ERHIResourceType GetType () const
 
FName GetOwnerName () const
 
void SetOwnerName (FName InOwnerName)
 

Friends

class FMetalRHICommandContext
 

Additional Inherited Members

- Protected Member Functions inherited from FRHIResource
virtual RHI_API ~FRHIResource ()
 
- Protected Attributes inherited from FRHIStagingBuffer
bool bIsLocked
 

Constructor & Destructor Documentation

◆ FMetalRHIStagingBuffer()

FMetalRHIStagingBuffer::FMetalRHIStagingBuffer ( FMetalDevice Device)

◆ ~FMetalRHIStagingBuffer()

FMetalRHIStagingBuffer::~FMetalRHIStagingBuffer ( )
finaloverridevirtual

Member Function Documentation

◆ GetGPUSizeBytes()

uint64 FMetalRHIStagingBuffer::GetGPUSizeBytes ( ) const
overridevirtual

Reimplemented from FRHIStagingBuffer.

◆ Lock()

void * FMetalRHIStagingBuffer::Lock ( uint32  Offset,
uint32  NumBytes 
)
finaloverridevirtual

Returns the pointer to read the buffer.

There is no actual locking, the buffer is always shared. If this is not fenced correctly, it will not have the expected data.

Implements FRHIStagingBuffer.

◆ Unlock()

void FMetalRHIStagingBuffer::Unlock ( )
finaloverridevirtual

Implements FRHIStagingBuffer.

Friends And Related Symbol Documentation

◆ FMetalRHICommandContext


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