UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
GlobalDistanceField.h File Reference
#include "Math/IntVector.h"

Go to the source code of this file.

Namespaces

namespace  GlobalDistanceField
 

Enumerations

enum  FGlobalDFCacheType { GDF_MostlyStatic , GDF_Full , GDF_Num }
 

Functions

bool UseGlobalDistanceField ()
 
bool UseGlobalDistanceField (const FDistanceFieldAOParameters &Parameters)
 
int32 GlobalDistanceField::GetClipmapResolution (bool bLumenEnabled)
 
int32 GlobalDistanceField::GetMipFactor ()
 
int32 GlobalDistanceField::GetClipmapMipResolution (bool bLumenEnabled)
 
float GlobalDistanceField::GetClipmapExtent (int32 ClipmapIndex, const FScene *Scene, bool bLumenEnabled)
 
int32 GlobalDistanceField::GetNumGlobalDistanceFieldClipmaps (bool bLumenEnabled, float LumenSceneViewDistance)
 
FIntVector GlobalDistanceField::GetPageAtlasSizeInPages (bool bLumenEnabled, float LumenSceneViewDistance)
 
FIntVector GlobalDistanceField::GetPageAtlasSize (bool bLumenEnabled, float LumenSceneViewDistance)
 
FIntVector GlobalDistanceField::GetCoverageAtlasSize (bool bLumenEnabled, float LumenSceneViewDistance)
 
uint32 GlobalDistanceField::GetPageTableClipmapResolution (bool bLumenEnabled)
 
FIntVector GlobalDistanceField::GetPageTableTextureResolution (bool bLumenEnabled, float LumenSceneViewDistance)
 
int32 GlobalDistanceField::GetMaxPageNum (bool bLumenEnabled, float LumenSceneViewDistance)
 
void UpdateGlobalDistanceFieldVolume (FRDGBuilder &GraphBuilder, FRDGExternalAccessQueue &ExternalAccessQueue, FViewInfo &View, FScene *Scene, float MaxOcclusionDistance, bool bLumenEnabled, FGlobalDistanceFieldInfo &Info)
 

Variables

int32 GAOGlobalDistanceField
 

Enumeration Type Documentation

◆ FGlobalDFCacheType

Enumerator
GDF_MostlyStatic 
GDF_Full 
GDF_Num 

Function Documentation

◆ UpdateGlobalDistanceFieldVolume()

void UpdateGlobalDistanceFieldVolume ( FRDGBuilder GraphBuilder,
FRDGExternalAccessQueue ExternalAccessQueue,
FViewInfo View,
FScene Scene,
float  MaxOcclusionDistance,
bool  bLumenEnabled,
FGlobalDistanceFieldInfo GlobalDistanceFieldInfo 
)
extern

Updates the global distance field for a view.
Typically issues updates for just the newly exposed regions of the volume due to camera movement. In the worst case of a camera cut or large distance field scene changes, a full update of the global distance field will be done.

◆ UseGlobalDistanceField() [1/2]

bool UseGlobalDistanceField ( )

◆ UseGlobalDistanceField() [2/2]

bool UseGlobalDistanceField ( const FDistanceFieldAOParameters Parameters)

Variable Documentation

◆ GAOGlobalDistanceField

int32 GAOGlobalDistanceField
extern