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

#include <PrecomputedLightVolume.h>

Public Member Functions

ENGINE_API FPrecomputedLightVolumeData ()
 
 ~FPrecomputedLightVolumeData ()
 
ENGINE_API void Initialize (const FBox &NewBounds)
 
ENGINE_API void AddHighQualityLightingSample (const FVolumeLightingSample &NewHighQualitySample)
 
ENGINE_API void AddLowQualityLightingSample (const FVolumeLightingSample &NewLowQualitySample)
 
ENGINE_API void FinalizeSamples ()
 
ENGINE_API void InvalidateLightingCache ()
 
SIZE_T GetAllocatedBytes () const
 
bool IsInitialized () const
 
FBoxGetBounds ()
 

Friends

class FPrecomputedLightVolume
 
FArchiveoperator<< (FArchive &Ar, FPrecomputedLightVolumeData &Volume)
 
FArchiveoperator<< (FArchive &Ar, FPrecomputedLightVolumeData *&Volume)
 

Detailed Description

Set of volume lighting samples belonging to one streaming level, which can be queried about the lighting at a given position.

Constructor & Destructor Documentation

◆ FPrecomputedLightVolumeData()

FPrecomputedLightVolumeData::FPrecomputedLightVolumeData ( )

◆ ~FPrecomputedLightVolumeData()

FPrecomputedLightVolumeData::~FPrecomputedLightVolumeData ( )

Member Function Documentation

◆ AddHighQualityLightingSample()

void FPrecomputedLightVolumeData::AddHighQualityLightingSample ( const FVolumeLightingSample NewHighQualitySample)

Adds a high quality lighting sample.

Adds a lighting sample.

◆ AddLowQualityLightingSample()

void FPrecomputedLightVolumeData::AddLowQualityLightingSample ( const FVolumeLightingSample NewLowQualitySample)

Adds a low quality lighting sample.

◆ FinalizeSamples()

void FPrecomputedLightVolumeData::FinalizeSamples ( )

Shrinks the octree and updates memory stats.

◆ GetAllocatedBytes()

SIZE_T FPrecomputedLightVolumeData::GetAllocatedBytes ( ) const

◆ GetBounds()

FBox & FPrecomputedLightVolumeData::GetBounds ( )
inline

◆ Initialize()

void FPrecomputedLightVolumeData::Initialize ( const FBox NewBounds)

Frees any previous samples, prepares the volume to have new samples added.

◆ InvalidateLightingCache()

void FPrecomputedLightVolumeData::InvalidateLightingCache ( )

Invalidates anything produced by the last lighting build.

◆ IsInitialized()

bool FPrecomputedLightVolumeData::IsInitialized ( ) const
inline

Friends And Related Symbol Documentation

◆ FPrecomputedLightVolume

◆ operator<< [1/2]

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

◆ operator<< [2/2]

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

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