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

#include <LightMap.h>

+ Inheritance diagram for FLightmapResourceCluster:

Public Member Functions

 FLightmapResourceCluster ()
 
virtual ENGINE_API ~FLightmapResourceCluster ()
 
virtual ENGINE_API void InitRHI (FRHICommandListBase &RHICmdList)
 
virtual ENGINE_API void ReleaseRHI ()
 
ENGINE_API void SetFeatureLevelAndInitialize (const FStaticFeatureLevel InFeatureLevel)
 
ENGINE_API void TryInitializeUniformBuffer ()
 
ENGINE_API void UpdateUniformBuffer ()
 
ENGINE_API const IAllocatedVirtualTextureGetAllocatedVT () const
 
ENGINE_API void ConditionalCreateAllocatedVT ()
 
ENGINE_API void ReleaseAllocatedVT ()
 
ENGINE_API bool GetUseVirtualTexturing () const
 
- 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
 

Public Attributes

FLightmapClusterResourceInput Input
 
IAllocatedVirtualTextureAllocatedVT
 
FUniformBufferRHIRef UniformBuffer
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 

Additional Inherited Members

- Public Types inherited from FRenderResource
enum class  EInitPhase : uint8 { Pre , Default , MAX }
 
- 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)
 
- 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 ()
 

Detailed Description

A bundle of lightmap resources which are referenced by multiple components.

Constructor & Destructor Documentation

◆ FLightmapResourceCluster()

FLightmapResourceCluster::FLightmapResourceCluster ( )
inline

◆ ~FLightmapResourceCluster()

FLightmapResourceCluster::~FLightmapResourceCluster ( )
virtual

Member Function Documentation

◆ ConditionalCreateAllocatedVT()

void FLightmapResourceCluster::ConditionalCreateAllocatedVT ( )

◆ GetAllocatedVT()

const IAllocatedVirtualTexture * FLightmapResourceCluster::GetAllocatedVT ( ) const

Allocates virtual texture on demand and returns it, may return nullptr if not using virtual texture 'const' method setting 'mutable' member is not amazing, but this is required to work around ordering of render commands submitted from main thread, it's possible for commands that want to access AllocatedVT from here execute before this has a chance to run InitRHI()

◆ GetUseVirtualTexturing()

bool FLightmapResourceCluster::GetUseVirtualTexturing ( ) const

◆ InitRHI()

void FLightmapResourceCluster::InitRHI ( FRHICommandListBase RHICmdList)
virtual

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.

◆ ReleaseAllocatedVT()

void FLightmapResourceCluster::ReleaseAllocatedVT ( )

◆ ReleaseRHI()

void FLightmapResourceCluster::ReleaseRHI ( )
virtual

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.

◆ SetFeatureLevelAndInitialize()

void FLightmapResourceCluster::SetFeatureLevelAndInitialize ( const FStaticFeatureLevel  InFeatureLevel)

◆ TryInitializeUniformBuffer()

void FLightmapResourceCluster::TryInitializeUniformBuffer ( )

◆ UpdateUniformBuffer()

void FLightmapResourceCluster::UpdateUniformBuffer ( )

Member Data Documentation

◆ AllocatedVT

IAllocatedVirtualTexture* FLightmapResourceCluster::AllocatedVT
mutable

◆ Input

FLightmapClusterResourceInput FLightmapResourceCluster::Input

◆ UniformBuffer

FUniformBufferRHIRef FLightmapResourceCluster::UniformBuffer

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