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

#include <RenderGraphResources.h>

+ Inheritance diagram for FRDGBuffer:

Public Member Functions

FRHIBufferGetRHI () const
 The following methods may only be called during pass execution.
 
FRHIBufferGetIndirectRHICallBuffer () const
 
FRDGBufferHandle GetHandle () const
 
uint32 GetSize () const
 
uint32 GetStride () const
 
bool IsCulled () const
 
- Public Member Functions inherited from FRDGViewableResource
bool IsExternal () const
 
bool IsExtracted () const
 
bool HasBeenProduced () const
 
void SetOwnerName (const FName &InOwnerName)
 
bool IsDebugNameHeapAllocated () const
 
- Public Member Functions inherited from FRDGResource
 FRDGResource (const FRDGResource &)=delete
 
virtual ~FRDGResource ()=default
 
virtual RENDERCORE_API void MarkResourceAsUsed ()
 The following methods may only be called during pass execution.
 
FRHIResourceGetRHI () const
 

Public Attributes

FRDGBufferDesc Desc
 
const ERDGBufferFlags Flags
 
- Public Attributes inherited from FRDGViewableResource
const ERDGViewableResourceType Type
 
- Public Attributes inherited from FRDGResource
const TCHAR *const Name = nullptr
 

Static Public Attributes

static const ERDGViewableResourceType StaticType = ERDGViewableResourceType::Buffer
 

Additional Inherited Members

- Protected Types inherited from FRDGViewableResource
enum class  ETransientExtractionHint : uint8 { None , Disable , Enable }
 
enum class  EAccessMode : uint8 { Internal , External }
 
- Protected Member Functions inherited from FRDGViewableResource
RENDERCORE_API FRDGViewableResource (const TCHAR *InName, ERDGViewableResourceType InType, bool bSkipTracking, bool bImmediateFirstBarrier)
 
bool IsCullRoot () const
 
- Protected Member Functions inherited from FRDGResource
 FRDGResource (const TCHAR *InName)
 
FRHIResourceGetRHIUnchecked () const
 
bool HasRHI () const
 
RENDERCORE_API void ValidateRHIAccess () const
 
- Protected Attributes inherited from FRDGViewableResource
uint8 bExternal: 1
 
uint8 bExtracted: 1
 
uint8 bProduced: 1
 
uint8 bTransient: 1
 
uint8 bForceNonTransient: 1
 
uint8 bSkipLastTransition: 1
 
uint8 bSplitFirstTransition: 1
 
uint8 bQueuedForUpload: 1
 
uint8 bCollectForAllocate: 1
 
uint8 bClobbered: 1
 
ETransientExtractionHint TransientExtractionHint
 
struct FRDGViewableResource::FAccessModeState AccessModeState
 
FRDGPassHandle AcquirePass
 
FRDGPassHandle DiscardPass
 
FRDGPassHandle FirstPass
 
FRDGPassHandlesByPipeline LastPasses
 
uint32 ReferenceCount
 
uint32 PassStateIndex = 0
 
TArrayView< const FRHITransientAliasingOverlapAliasingOverlaps
 
ERHIAccess EpilogueAccess = DefaultEpilogueAccess
 
- Protected Attributes inherited from FRDGResource
FRHIResourceResourceRHI = nullptr
 
- Static Protected Attributes inherited from FRDGViewableResource
static const ERHIAccess DefaultEpilogueAccess = ERHIAccess::SRVMask
 

Detailed Description

A render graph tracked buffer.

Member Function Documentation

◆ GetHandle()

FRDGBufferHandle FRDGBuffer::GetHandle ( ) const
inline

◆ GetIndirectRHICallBuffer()

FRHIBuffer * FRDGBuffer::GetIndirectRHICallBuffer ( ) const
inline

Returns the buffer to use for indirect RHI calls.

◆ GetRHI()

FRHIBuffer * FRDGBuffer::GetRHI ( ) const
inline

The following methods may only be called during pass execution.

Returns the underlying RHI buffer resource

◆ GetSize()

uint32 FRDGBuffer::GetSize ( ) const
inline

◆ GetStride()

uint32 FRDGBuffer::GetStride ( ) const
inline

◆ IsCulled()

bool FRDGBuffer::IsCulled ( ) const
inline

Member Data Documentation

◆ Desc

FRDGBufferDesc FRDGBuffer::Desc

◆ Flags

const ERDGBufferFlags FRDGBuffer::Flags

◆ StaticType

const ERDGViewableResourceType FRDGBuffer::StaticType = ERDGViewableResourceType::Buffer
static

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