UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
GlobalDistanceField Namespace Reference

Functions

int32 GetClipmapResolution (bool bLumenEnabled)
 
int32 GetMipFactor ()
 
int32 GetClipmapMipResolution (bool bLumenEnabled)
 
float GetClipmapExtent (int32 ClipmapIndex, const FScene *Scene, bool bLumenEnabled)
 
int32 GetNumGlobalDistanceFieldClipmaps (bool bLumenEnabled, float LumenSceneViewDistance)
 
FIntVector GetPageAtlasSizeInPages (bool bLumenEnabled, float LumenSceneViewDistance)
 
FIntVector GetPageAtlasSize (bool bLumenEnabled, float LumenSceneViewDistance)
 
FIntVector GetCoverageAtlasSize (bool bLumenEnabled, float LumenSceneViewDistance)
 
uint32 GetPageTableClipmapResolution (bool bLumenEnabled)
 
FIntVector GetPageTableTextureResolution (bool bLumenEnabled, float LumenSceneViewDistance)
 
int32 GetMaxPageNum (bool bLumenEnabled, float LumenSceneViewDistance)
 

Variables

const int32 CullGridFactor = 4
 
const int32 PageAtlasSizeInPagesX = 128
 
const int32 PageAtlasSizeInPagesY = 128
 
const int32 ObjectGridPageBufferStride = 4 * sizeof(uint32)
 
const int32 ObjectGridPageBufferNumElementsPerPage = 4 * 4 * 4
 
const int32 MaxClipmaps = 6
 

Function Documentation

◆ GetClipmapExtent()

float GlobalDistanceField::GetClipmapExtent ( int32  ClipmapIndex,
const FScene Scene,
bool  bLumenEnabled 
)

◆ GetClipmapMipResolution()

int32 GlobalDistanceField::GetClipmapMipResolution ( bool  bLumenEnabled)

◆ GetClipmapResolution()

int32 GlobalDistanceField::GetClipmapResolution ( bool  bLumenEnabled)

◆ GetCoverageAtlasSize()

FIntVector GlobalDistanceField::GetCoverageAtlasSize ( bool  bLumenEnabled,
float  LumenSceneViewDistance 
)

◆ GetMaxPageNum()

int32 GlobalDistanceField::GetMaxPageNum ( bool  bLumenEnabled,
float  LumenSceneViewDistance 
)

◆ GetMipFactor()

int32 GlobalDistanceField::GetMipFactor ( )

◆ GetNumGlobalDistanceFieldClipmaps()

int32 GlobalDistanceField::GetNumGlobalDistanceFieldClipmaps ( bool  bLumenEnabled,
float  LumenSceneViewDistance 
)

◆ GetPageAtlasSize()

FIntVector GlobalDistanceField::GetPageAtlasSize ( bool  bLumenEnabled,
float  LumenSceneViewDistance 
)

◆ GetPageAtlasSizeInPages()

FIntVector GlobalDistanceField::GetPageAtlasSizeInPages ( bool  bLumenEnabled,
float  LumenSceneViewDistance 
)

◆ GetPageTableClipmapResolution()

uint32 GlobalDistanceField::GetPageTableClipmapResolution ( bool  bLumenEnabled)

◆ GetPageTableTextureResolution()

FIntVector GlobalDistanceField::GetPageTableTextureResolution ( bool  bLumenEnabled,
float  LumenSceneViewDistance 
)

Variable Documentation

◆ CullGridFactor

const int32 GlobalDistanceField::CullGridFactor = 4

◆ MaxClipmaps

const int32 GlobalDistanceField::MaxClipmaps = 6
inline

Must match global distance field shaders.

◆ ObjectGridPageBufferNumElementsPerPage

const int32 GlobalDistanceField::ObjectGridPageBufferNumElementsPerPage = 4 * 4 * 4

◆ ObjectGridPageBufferStride

const int32 GlobalDistanceField::ObjectGridPageBufferStride = 4 * sizeof(uint32)

◆ PageAtlasSizeInPagesX

const int32 GlobalDistanceField::PageAtlasSizeInPagesX = 128

◆ PageAtlasSizeInPagesY

const int32 GlobalDistanceField::PageAtlasSizeInPagesY = 128