UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRWBuffer Struct Reference

#include <RHIUtilities.h>

Public Member Functions

 FRWBuffer ()
 
 FRWBuffer (FRWBuffer &&Other)
 
 FRWBuffer (const FRWBuffer &Other)
 
FRWBufferoperator= (FRWBuffer &&Other)
 
FRWBufferoperator= (const FRWBuffer &Other)
 
 ~FRWBuffer ()
 
void Initialize (FRHICommandListBase &RHICmdList, const TCHAR *InDebugName, uint32 BytesPerElement, uint32 NumElements, EPixelFormat Format, ERHIAccess InResourceState, EBufferUsageFlags AdditionalUsage=BUF_None, FResourceArrayUploadInterface *InResourceArray=nullptr)
 
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, ERHIAccess InResourceState, EBufferUsageFlags AdditionalUsage, LAMBDA &&InitializerFunction)
 
void Release ()
 

Public Attributes

FBufferRHIRef Buffer
 
FUnorderedAccessViewRHIRef UAV
 
FShaderResourceViewRHIRef SRV
 
uint32 NumBytes
 
FName ClassName = NAME_None
 
FName OwnerName = NAME_None
 

Detailed Description

Encapsulates a GPU read/write buffer with its UAV and SRV.

Constructor & Destructor Documentation

◆ FRWBuffer() [1/3]

FRWBuffer::FRWBuffer ( )
inline

◆ FRWBuffer() [2/3]

FRWBuffer::FRWBuffer ( FRWBuffer &&  Other)
inline

◆ FRWBuffer() [3/3]

FRWBuffer::FRWBuffer ( const FRWBuffer Other)
inline

◆ ~FRWBuffer()

FRWBuffer::~FRWBuffer ( )
inline

Member Function Documentation

◆ Initialize() [1/2]

void FRWBuffer::Initialize ( FRHICommandListBase RHICmdList,
const TCHAR InDebugName,
uint32  BytesPerElement,
uint32  NumElements,
EPixelFormat  Format,
EBufferUsageFlags  AdditionalUsage = BUF_None,
FResourceArrayUploadInterface InResourceArray = nullptr 
)
inline

◆ Initialize() [2/2]

void FRWBuffer::Initialize ( FRHICommandListBase RHICmdList,
const TCHAR InDebugName,
uint32  BytesPerElement,
uint32  NumElements,
EPixelFormat  Format,
ERHIAccess  InResourceState,
EBufferUsageFlags  AdditionalUsage = BUF_None,
FResourceArrayUploadInterface InResourceArray = nullptr 
)
inline

◆ InitializeWithData()

template<typename LAMBDA >
void FRWBuffer::InitializeWithData ( FRHICommandListBase RHICmdList,
const TCHAR InDebugName,
uint32  BytesPerElement,
uint32  NumElements,
EPixelFormat  Format,
ERHIAccess  InResourceState,
EBufferUsageFlags  AdditionalUsage,
LAMBDA &&  InitializerFunction 
)
inline

◆ operator=() [1/2]

FRWBuffer & FRWBuffer::operator= ( const FRWBuffer Other)
inline

◆ operator=() [2/2]

FRWBuffer & FRWBuffer::operator= ( FRWBuffer &&  Other)
inline

◆ Release()

void FRWBuffer::Release ( )
inline

Member Data Documentation

◆ Buffer

FBufferRHIRef FRWBuffer::Buffer

◆ ClassName

FName FRWBuffer::ClassName = NAME_None

◆ NumBytes

uint32 FRWBuffer::NumBytes

◆ OwnerName

FName FRWBuffer::OwnerName = NAME_None

◆ SRV

FShaderResourceViewRHIRef FRWBuffer::SRV

◆ UAV


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