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

#include <PrecomputedVolumetricLightmap.h>

+ Inheritance diagram for FPrecomputedVolumetricLightmapData:

Public Member Functions

ENGINE_API FPrecomputedVolumetricLightmapData ()
 
virtual ENGINE_API ~FPrecomputedVolumetricLightmapData ()
 
ENGINE_API void InitializeOnImport (const FBox &NewBounds, int32 InBrickSize)
 
ENGINE_API void FinalizeImport ()
 
virtual ENGINE_API void InitRHI (FRHICommandListBase &RHICmdList) override
 
virtual ENGINE_API void ReleaseRHI () override
 
ENGINE_API void InitRHIForSubLevelResources (FRHICommandListBase &RHICmdList)
 
ENGINE_API void InitRHIForSubLevelResources ()
 
ENGINE_API void ReleaseRHIForSubLevelResources ()
 
ENGINE_API void HandleDataMovementInAtlas (int32 OldOffset, int32 NewOffset)
 
ENGINE_API void AddToSceneData (FPrecomputedVolumetricLightmapData *SceneData)
 
ENGINE_API void RemoveFromSceneData (FPrecomputedVolumetricLightmapData *SceneData, int32 PersistentLevelBrickDataBaseOffset)
 
SIZE_T GetAllocatedBytes () const
 
const FBox & GetBounds () 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 FRenderResource & operator= (const FRenderResource &Other)
 
RENDERCORE_API FRenderResource & operator= (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

FBox Bounds
 
bool bTransient
 
FIntVector IndirectionTextureDimensions
 
FVolumetricLightmapDataLayer IndirectionTexture
 
int32 BrickSize
 
FIntVector BrickDataDimensions
 
FVolumetricLightmapBrickData BrickData
 
TResourceArray< FIntVector > SubLevelBrickPositions
 
TResourceArray< FColor > IndirectionTextureOriginalValues
 
FBufferRHIRef SubLevelBrickPositionsBuffer
 
FShaderResourceViewRHIRef SubLevelBrickPositionsSRV
 
FBufferRHIRef IndirectionTextureOriginalValuesBuffer
 
FShaderResourceViewRHIRef IndirectionTextureOriginalValuesSRV
 
int32 BrickDataBaseOffsetInAtlas
 
TArray< FPrecomputedVolumetricLightmapData * > SceneDataAdded
 
TArray< uint8 > CPUSubLevelIndirectionTable
 
TArray< FPrecomputedVolumetricLightmapData * > CPUSubLevelBrickDataList
 
- Public Attributes inherited from FRenderResource
ERenderResourceState ResourceState = ERenderResourceState::Default
 

Friends

class FPrecomputedVolumetricLightmap
 
FArchive & operator<< (FArchive &Ar, FPrecomputedVolumetricLightmapData &Volume)
 
FArchive & operator<< (FArchive &Ar, FPrecomputedVolumetricLightmapData *&Volume)
 

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 FRHICommandListBase & GetImmediateCommandList ()
 

Detailed Description

Data for a Volumetric Lightmap, built during import from Lightmass. Its lifetime is managed by UMapBuildDataRegistry.

Constructor & Destructor Documentation

◆ FPrecomputedVolumetricLightmapData()

FPrecomputedVolumetricLightmapData::FPrecomputedVolumetricLightmapData ( )

◆ ~FPrecomputedVolumetricLightmapData()

FPrecomputedVolumetricLightmapData::~FPrecomputedVolumetricLightmapData ( )
virtual

Member Function Documentation

◆ AddToSceneData()

ENGINE_API void FPrecomputedVolumetricLightmapData::AddToSceneData ( FPrecomputedVolumetricLightmapData *  SceneData)

◆ FinalizeImport()

void FPrecomputedVolumetricLightmapData::FinalizeImport ( )

◆ GetAllocatedBytes()

SIZE_T FPrecomputedVolumetricLightmapData::GetAllocatedBytes ( ) const

◆ GetBounds()

const FBox & FPrecomputedVolumetricLightmapData::GetBounds ( ) const
inline

◆ HandleDataMovementInAtlas()

ENGINE_API void FPrecomputedVolumetricLightmapData::HandleDataMovementInAtlas ( int32  OldOffset,
int32  NewOffset 
)

◆ InitializeOnImport()

void FPrecomputedVolumetricLightmapData::InitializeOnImport ( const FBox &  NewBounds,
int32  InBrickSize 
)

◆ InitRHI()

ENGINE_API void FPrecomputedVolumetricLightmapData::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.

◆ InitRHIForSubLevelResources() [1/2]

void FPrecomputedVolumetricLightmapData::InitRHIForSubLevelResources ( )

◆ InitRHIForSubLevelResources() [2/2]

void FPrecomputedVolumetricLightmapData::InitRHIForSubLevelResources ( FRHICommandListBase &  RHICmdList)

◆ ReleaseRHI()

ENGINE_API void FPrecomputedVolumetricLightmapData::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.

◆ ReleaseRHIForSubLevelResources()

ENGINE_API void FPrecomputedVolumetricLightmapData::ReleaseRHIForSubLevelResources ( )

◆ RemoveFromSceneData()

ENGINE_API void FPrecomputedVolumetricLightmapData::RemoveFromSceneData ( FPrecomputedVolumetricLightmapData *  SceneData,
int32  PersistentLevelBrickDataBaseOffset 
)

Friends And Related Symbol Documentation

◆ FPrecomputedVolumetricLightmap

friend class FPrecomputedVolumetricLightmap
friend

◆ operator<< [1/2]

FArchive & operator<< ( FArchive &  Ar,
FPrecomputedVolumetricLightmapData &  Volume 
)
friend

◆ operator<< [2/2]

FArchive & operator<< ( FArchive &  Ar,
FPrecomputedVolumetricLightmapData *&  Volume 
)
friend

Member Data Documentation

◆ Bounds

FBox FPrecomputedVolumetricLightmapData::Bounds

◆ BrickData

FVolumetricLightmapBrickData FPrecomputedVolumetricLightmapData::BrickData

◆ BrickDataBaseOffsetInAtlas

int32 FPrecomputedVolumetricLightmapData::BrickDataBaseOffsetInAtlas

◆ BrickDataDimensions

FIntVector FPrecomputedVolumetricLightmapData::BrickDataDimensions

◆ BrickSize

int32 FPrecomputedVolumetricLightmapData::BrickSize

◆ bTransient

bool FPrecomputedVolumetricLightmapData::bTransient

◆ CPUSubLevelBrickDataList

TArray<FPrecomputedVolumetricLightmapData*> FPrecomputedVolumetricLightmapData::CPUSubLevelBrickDataList

◆ CPUSubLevelIndirectionTable

TArray<uint8> FPrecomputedVolumetricLightmapData::CPUSubLevelIndirectionTable

◆ IndirectionTexture

FVolumetricLightmapDataLayer FPrecomputedVolumetricLightmapData::IndirectionTexture

◆ IndirectionTextureDimensions

FIntVector FPrecomputedVolumetricLightmapData::IndirectionTextureDimensions

◆ IndirectionTextureOriginalValues

TResourceArray<FColor> FPrecomputedVolumetricLightmapData::IndirectionTextureOriginalValues

◆ IndirectionTextureOriginalValuesBuffer

FBufferRHIRef FPrecomputedVolumetricLightmapData::IndirectionTextureOriginalValuesBuffer

◆ IndirectionTextureOriginalValuesSRV

FShaderResourceViewRHIRef FPrecomputedVolumetricLightmapData::IndirectionTextureOriginalValuesSRV

◆ SceneDataAdded

TArray<FPrecomputedVolumetricLightmapData*> FPrecomputedVolumetricLightmapData::SceneDataAdded

◆ SubLevelBrickPositions

TResourceArray<FIntVector> FPrecomputedVolumetricLightmapData::SubLevelBrickPositions

Position data for sub level streaming

◆ SubLevelBrickPositionsBuffer

FBufferRHIRef FPrecomputedVolumetricLightmapData::SubLevelBrickPositionsBuffer

Runtime data for sub level streaming

◆ SubLevelBrickPositionsSRV

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