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

#include <NaniteShared.h>

+ Inheritance diagram for Nanite::FGlobalResources:

Classes

struct  PassBuffers
 

Public Member Functions

virtual void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual void ReleaseRHI () override
 
void Update (FRDGBuilder &GraphBuilder)
 
PassBuffersGetMainPassBuffers ()
 
PassBuffersGetPostPassBuffers ()
 
TRefCountPtr< FRDGPooledBuffer > & GetStatsBufferRef ()
 
TRefCountPtr< FRDGPooledBuffer > & GetShadingBinDataBufferRef ()
 
TRefCountPtr< IPooledRenderTarget > & GetFastClearTileVisRef ()
 
FFeedbackManagerGetFeedbackManager ()
 
- Public Member Functions inherited from FRenderResource
RENDERCORE_API FRenderResource ()
 
RENDERCORE_API FRenderResource (ERHIFeatureLevel::Type InFeatureLevel)
 
RENDERCORE_API FRenderResource (const FRenderResource &)
 
RENDERCORE_API FRenderResource (FRenderResource &&)
 
RENDERCORE_API FRenderResourceoperator= (const FRenderResource &Other)
 
RENDERCORE_API FRenderResourceoperator= (FRenderResource &&Other)
 
virtual RENDERCORE_API ~FRenderResource ()
 
virtual RENDERCORE_API void InitResource (FRHICommandListBase &RHICmdList)
 
virtual RENDERCORE_API void ReleaseResource ()
 
RENDERCORE_API void UpdateRHI (FRHICommandListBase &RHICmdList)
 
virtual FString GetFriendlyName () const
 
bool IsInitialized () const
 
int32 GetListIndex () const
 
EInitPhase GetInitPhase () const
 
void SetOwnerName (FName InOwnerName)
 
FName GetOwnerName () const
 
void SetResourceName (FName InResourceName)
 
FName GetResourceName () const
 

Static Public Member Functions

static uint32 GetMaxCandidateClusters ()
 
static uint32 GetMaxClusterBatches ()
 
static uint32 GetMaxVisibleClusters ()
 
static uint32 GetMaxNodes ()
 
static uint32 GetMaxCandidatePatches ()
 
static uint32 GetMaxVisiblePatches ()
 
static uint32 GetMaxVisibleAssemblyParts ()
 
static uint32 GetFixedFunctionBinMask ()
 
static bool UseExtendedClusterSize ()
 
static uint32 GetCandidateNodeSize (bool bPostPass)
 
static uint32 GetCandidateClusterSize ()
 
static uint32 GetMaxVisibleClusterSize ()
 
- Static Public Member Functions inherited from FRenderResource
static RENDERCORE_API void ReleaseRHIForAllResources ()
 
static RENDERCORE_API void InitPreRHIResources ()
 
static RENDERCORE_API void ChangeFeatureLevel (ERHIFeatureLevel::Type NewFeatureLevel)
 
static RENDERCORE_API FName SetScopeName (FName Name)
 

Public Attributes

uint32 StatsRenderFlags = 0
 
uint32 StatsDebugFlags = 0
 
const int32 MaxPickingBuffers = 4
 
int32 PickingBufferWriteIndex = 0
 
int32 PickingBufferNumPending = 0
 
TArray< TUniquePtr< FRHIGPUBufferReadback > > PickingBuffers
 
TRefCountPtr< FRDGPooledBufferCandidateNodesBuffer
 
TRefCountPtr< FRDGPooledBufferClusterBatchesBuffer
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 

Additional Inherited Members

- Public Types inherited from FRenderResource
enum class  EInitPhase : uint8 { Pre , Default , MAX }
 
- Protected Member Functions inherited from FRenderResource
void SetFeatureLevel (const FStaticFeatureLevel InFeatureLevel)
 
const FStaticFeatureLevel GetFeatureLevel () const
 
bool HasValidFeatureLevel () const
 
template<typename T >
FBufferRHIRef CreateRHIBuffer (FRHICommandListBase &RHICmdList, T &InOutResourceObject, uint32 ResourceCount, EBufferUsageFlags InBufferUsageFlags, const TCHAR *InDebugName)
 
void SetInitPhase (EInitPhase InInitPhase)
 
- Static Protected Member Functions inherited from FRenderResource
static RENDERCORE_API FRHICommandListBaseGetImmediateCommandList ()
 

Member Function Documentation

◆ GetCandidateClusterSize()

uint32 Nanite::FGlobalResources::GetCandidateClusterSize ( )
static

◆ GetCandidateNodeSize()

uint32 Nanite::FGlobalResources::GetCandidateNodeSize ( bool  bPostPass)
static

◆ GetFastClearTileVisRef()

TRefCountPtr< IPooledRenderTarget > & Nanite::FGlobalResources::GetFastClearTileVisRef ( )
inline

◆ GetFeedbackManager()

FFeedbackManager * Nanite::FGlobalResources::GetFeedbackManager ( )
inline

◆ GetFixedFunctionBinMask()

uint32 Nanite::FGlobalResources::GetFixedFunctionBinMask ( )
static

◆ GetMainPassBuffers()

PassBuffers & Nanite::FGlobalResources::GetMainPassBuffers ( )
inline

◆ GetMaxCandidateClusters()

uint32 Nanite::FGlobalResources::GetMaxCandidateClusters ( )
static

◆ GetMaxCandidatePatches()

uint32 Nanite::FGlobalResources::GetMaxCandidatePatches ( )
static

◆ GetMaxClusterBatches()

uint32 Nanite::FGlobalResources::GetMaxClusterBatches ( )
static

◆ GetMaxNodes()

uint32 Nanite::FGlobalResources::GetMaxNodes ( )
static

◆ GetMaxVisibleAssemblyParts()

uint32 Nanite::FGlobalResources::GetMaxVisibleAssemblyParts ( )
static

◆ GetMaxVisibleClusters()

uint32 Nanite::FGlobalResources::GetMaxVisibleClusters ( )
static

◆ GetMaxVisibleClusterSize()

uint32 Nanite::FGlobalResources::GetMaxVisibleClusterSize ( )
static

◆ GetMaxVisiblePatches()

uint32 Nanite::FGlobalResources::GetMaxVisiblePatches ( )
static

◆ GetPostPassBuffers()

PassBuffers & Nanite::FGlobalResources::GetPostPassBuffers ( )
inline

◆ GetShadingBinDataBufferRef()

TRefCountPtr< FRDGPooledBuffer > & Nanite::FGlobalResources::GetShadingBinDataBufferRef ( )
inline

◆ GetStatsBufferRef()

TRefCountPtr< FRDGPooledBuffer > & Nanite::FGlobalResources::GetStatsBufferRef ( )
inline

◆ InitRHI()

void Nanite::FGlobalResources::InitRHI ( FRHICommandListBase RHICmdList)
overridevirtual

Initializes the RHI resources used by this resource. Called when entering the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FRenderResource.

◆ ReleaseRHI()

void Nanite::FGlobalResources::ReleaseRHI ( )
overridevirtual

Releases the RHI resources used by this resource. Called when leaving the state where both the resource and the RHI have been initialized. This is only called by the rendering thread.

Reimplemented from FRenderResource.

◆ Update()

void Nanite::FGlobalResources::Update ( FRDGBuilder GraphBuilder)

◆ UseExtendedClusterSize()

bool Nanite::FGlobalResources::UseExtendedClusterSize ( )
static

Member Data Documentation

◆ CandidateNodesBuffer

TRefCountPtr<FRDGPooledBuffer> Nanite::FGlobalResources::CandidateNodesBuffer

◆ ClusterBatchesBuffer

TRefCountPtr<FRDGPooledBuffer> Nanite::FGlobalResources::ClusterBatchesBuffer

◆ MaxPickingBuffers

const int32 Nanite::FGlobalResources::MaxPickingBuffers = 4

◆ PickingBufferNumPending

int32 Nanite::FGlobalResources::PickingBufferNumPending = 0

◆ PickingBuffers

TArray<TUniquePtr<FRHIGPUBufferReadback> > Nanite::FGlobalResources::PickingBuffers

◆ PickingBufferWriteIndex

int32 Nanite::FGlobalResources::PickingBufferWriteIndex = 0

◆ StatsDebugFlags

uint32 Nanite::FGlobalResources::StatsDebugFlags = 0

◆ StatsRenderFlags

uint32 Nanite::FGlobalResources::StatsRenderFlags = 0

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