UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FRHITransientBuffer Class Referencefinal

#include <RHITransientResourceAllocator.h>

+ Inheritance diagram for FRHITransientBuffer:

Public Member Functions

 FRHITransientBuffer (const FResourceTask &InResourceTask, uint64 InHash, uint64 InSize, ERHITransientAllocationType InAllocationType, const FRHIBufferCreateInfo &InCreateInfo)
 
 FRHITransientBuffer (FRHIResource *InBuffer, uint64 InGpuVirtualAddress, uint64 InHash, uint64 InSize, ERHITransientAllocationType InAllocationType, const FRHIBufferCreateInfo &InCreateInfo)
 
virtual RHI_API ~FRHITransientBuffer ()
 
FRHIBuffer * GetRHI () const
 
const FRHIBufferCreateInfo & GetCreateInfo () const
 
FRHIUnorderedAccessView * GetOrCreateUAV (FRHICommandListBase &RHICmdList, const FRHIBufferUAVCreateInfo &InCreateInfo)
 
FRHIShaderResourceView * GetOrCreateSRV (FRHICommandListBase &RHICmdList, const FRHIBufferSRVCreateInfo &InCreateInfo)
 
- Public Member Functions inherited from FRHITransientResource
RHI_API FRHITransientResource (FRHIResource *InResource, uint64 InGpuVirtualAddress, uint64 InHash, uint64 InSize, ERHITransientAllocationType InAllocationType, ERHITransientResourceType InResourceType)
 
RHI_API FRHITransientResource (const FResourceTask &InResourceTask, uint64 InHash, uint64 InSize, ERHITransientAllocationType InAllocationType, ERHITransientResourceType InResourceType)
 
virtual RHI_API ~FRHITransientResource ()
 
void Acquire (const TCHAR *InName, uint32 InAcquirePassIndex, ERHIPipeline InAcquirePipeline, uint64 InAllocatorCycle)
 Internal Allocator API.
 
void Discard (const FRHITransientAllocationFences &Fences)
 
void AddAliasingOverlap (FRHITransientResource *InBeforeResource, uint32 InAcquirePassIndex)
 
void Finish (FRHICommandListBase &RHICmdList)
 
FRHITransientHeapAllocation & GetHeapAllocation ()
 
const FRHITransientHeapAllocation & GetHeapAllocation () const
 
FRHITransientPageAllocation & GetPageAllocation ()
 
const FRHITransientPageAllocation & GetPageAllocation () const
 
FRHIResource * GetRHI () const
 
uint64 GetGpuVirtualAddress () const
 
bool HasResourceTask () const
 
const TCHAR * GetName () const
 
uint64 GetHash () const
 
uint64 GetSize () const
 
uint64 GetAcquireCycle () const
 
uint32 GetAcquireCount () const
 
TConstArrayView< FRHITransientAliasingOverlap > GetAliasingOverlaps () const
 
uint32 GetAcquirePass () const
 
uint32 GetDiscardPass () const
 
bool IsAcquired () const
 
bool IsDiscarded () const
 
ERHITransientResourceType GetResourceType () const
 
bool IsTexture () const
 
bool IsBuffer () const
 
ERHITransientAllocationType GetAllocationType () const
 
bool IsHeapAllocated () const
 
bool IsPageAllocated () const
 

Public Attributes

const FRHIBufferCreateInfo CreateInfo
 
FRHIBufferViewCache ViewCache
 

Additional Inherited Members

- Public Types inherited from FRHITransientResource
using FResourceTask = UE::Tasks::TTask< FResourceTaskResult >
 
- Static Public Attributes inherited from FRHITransientResource
static const uint32 kInvalidPassIndex = TNumericLimits<uint32>::Max()
 

Constructor & Destructor Documentation

◆ FRHITransientBuffer() [1/2]

FRHITransientBuffer::FRHITransientBuffer ( const FResourceTask &  InResourceTask,
uint64  InHash,
uint64  InSize,
ERHITransientAllocationType  InAllocationType,
const FRHIBufferCreateInfo &  InCreateInfo 
)
inline

◆ FRHITransientBuffer() [2/2]

FRHITransientBuffer::FRHITransientBuffer ( FRHIResource *  InBuffer,
uint64  InGpuVirtualAddress,
uint64  InHash,
uint64  InSize,
ERHITransientAllocationType  InAllocationType,
const FRHIBufferCreateInfo &  InCreateInfo 
)
inline

◆ ~FRHITransientBuffer()

FRHITransientBuffer::~FRHITransientBuffer ( )
virtualdefault

Member Function Documentation

◆ GetCreateInfo()

const FRHIBufferCreateInfo & FRHITransientBuffer::GetCreateInfo ( ) const
inline

◆ GetOrCreateSRV()

FRHIShaderResourceView * FRHITransientBuffer::GetOrCreateSRV ( FRHICommandListBase &  RHICmdList,
const FRHIBufferSRVCreateInfo &  InCreateInfo 
)
inline

◆ GetOrCreateUAV()

FRHIUnorderedAccessView * FRHITransientBuffer::GetOrCreateUAV ( FRHICommandListBase &  RHICmdList,
const FRHIBufferUAVCreateInfo &  InCreateInfo 
)
inline

◆ GetRHI()

FRHIBuffer * FRHITransientBuffer::GetRHI ( ) const
inline

Member Data Documentation

◆ CreateInfo

const FRHIBufferCreateInfo FRHITransientBuffer::CreateInfo

◆ ViewCache

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