UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRHIBuffer Class Reference

#include <RHIResources.h>

+ Inheritance diagram for FRHIBuffer:

Public Member Functions

const FRHIBufferDescGetDesc () const
 
uint32 GetSize () const
 
uint32 GetStride () const
 
EBufferUsageFlags GetUsage () const
 
void SetName (FName InName)
 
- Public Member Functions inherited from FRHIViewableResource
ERHIAccess GetTrackedAccess_Unsafe () const
 
FName GetName () const
 
- 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)
 

Protected Member Functions

 FRHIBuffer ()=delete
 
RHI_API FRHIBuffer (const FRHIBufferCreateDesc &CreateDesc)
 
void TakeOwnership (FRHIBuffer &Other)
 
void ReleaseOwnership ()
 
- Protected Member Functions inherited from FRHIViewableResource
 FRHIViewableResource (ERHIResourceType InResourceType, ERHIAccess InAccess, const TCHAR *InName, FName InOwnerName)
 
virtual void SetTrackedAccessFromContext (FRHITrackedAccess InTrackedAccess)
 
void TakeOwnership (FRHIViewableResource &Other)
 
void ReleaseOwnership ()
 
- Protected Member Functions inherited from FRHIResource
virtual RHI_API ~FRHIResource ()
 

Additional Inherited Members

- Protected Attributes inherited from FRHIViewableResource
FName Name
 

Constructor & Destructor Documentation

◆ FRHIBuffer() [1/2]

FRHIBuffer::FRHIBuffer ( )
protecteddelete

◆ FRHIBuffer() [2/2]

FRHIBuffer::FRHIBuffer ( const FRHIBufferCreateDesc CreateDesc)
protected

Initialization constructor. Should only be called by platform RHI implementations.

Member Function Documentation

◆ GetDesc()

const FRHIBufferDesc & FRHIBuffer::GetDesc ( ) const
inline

◆ GetSize()

uint32 FRHIBuffer::GetSize ( ) const
inline
Returns
The number of bytes in the buffer.

◆ GetStride()

uint32 FRHIBuffer::GetStride ( ) const
inline
Returns
The stride in bytes of the buffer.

◆ GetUsage()

EBufferUsageFlags FRHIBuffer::GetUsage ( ) const
inline
Returns
The usage flags used to create the buffer.

◆ ReleaseOwnership()

void FRHIBuffer::ReleaseOwnership ( )
inlineprotected

◆ SetName()

void FRHIBuffer::SetName ( FName  InName)
inline

◆ TakeOwnership()

void FRHIBuffer::TakeOwnership ( FRHIBuffer Other)
inlineprotected

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