UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
LumenSurfaceCache.cpp File Reference

Classes

struct  FLumenSurfaceLayerConfig
 
class  FLumenCardCopyPS
 
class  FGenerateDilationTileDataCS
 
class  FCopyCapturedCardPageCS
 
class  FClearCompressedAtlasCS
 

Enumerations

enum class  ELumenSurfaceCacheLayer : uint8 {
  Depth , Albedo , Opacity , Normal ,
  Emissive , MAX
}
 

Functions

FAutoConsoleVariableRef CVarLumenSurfaceCacheCompress (TEXT("r.LumenScene.SurfaceCache.Compress"), GLumenSurfaceCacheCompress, TEXT("2 - Compress using CopyTexture (may be very slow on some RHIs)\n"), ECVF_Scalability|ECVF_RenderThreadSafe)
 
ESurfaceCacheCompression GetSurfaceCacheCompression ()
 
const FLumenSurfaceLayerConfigGetSurfaceLayerConfig (ELumenSurfaceCacheLayer Layer)
 
 IMPLEMENT_GLOBAL_SHADER (FLumenCardCopyPS, "/Engine/Private/Lumen/SurfaceCache/LumenSurfaceCache.usf", "LumenCardCopyPS", SF_Pixel)
 
FRDGTextureRef CreateCardAtlas (FRDGBuilder &GraphBuilder, const FIntPoint PageAtlasSize, ESurfaceCacheCompression PhysicalAtlasCompression, ELumenSurfaceCacheLayer LayerId, const TCHAR *Name)
 
 IMPLEMENT_GLOBAL_SHADER (FGenerateDilationTileDataCS, "/Engine/Private/Lumen/SurfaceCache/LumenSurfaceCache.usf", "GenerateDilationTileDataCS", SF_Compute)
 
 IMPLEMENT_GLOBAL_SHADER (FCopyCapturedCardPageCS, "/Engine/Private/Lumen/SurfaceCache/LumenSurfaceCache.usf", "CopyCapturedCardPageCS", SF_Compute)
 
 IMPLEMENT_GLOBAL_SHADER (FClearCompressedAtlasCS, "/Engine/Private/Lumen/SurfaceCache/LumenSurfaceCache.usf", "ClearCompressedAtlasCS", SF_Compute)
 

Variables

int32 GLumenSurfaceCacheCompress = 1
 

Enumeration Type Documentation

◆ ELumenSurfaceCacheLayer

Enumerator
Depth 
Albedo 
Opacity 
Normal 
Emissive 
MAX 

Function Documentation

◆ CreateCardAtlas()

FRDGTextureRef CreateCardAtlas ( FRDGBuilder GraphBuilder,
const FIntPoint  PageAtlasSize,
ESurfaceCacheCompression  PhysicalAtlasCompression,
ELumenSurfaceCacheLayer  LayerId,
const TCHAR Name 
)

◆ CVarLumenSurfaceCacheCompress()

FAutoConsoleVariableRef CVarLumenSurfaceCacheCompress ( TEXT("r.LumenScene.SurfaceCache.Compress")  ,
GLumenSurfaceCacheCompress  ,
TEXT("2 - Compress using CopyTexture (may be very slow on some RHIs)\n" ,
ECVF_Scalability ECVF_RenderThreadSafe 
)

◆ GetSurfaceCacheCompression()

ESurfaceCacheCompression GetSurfaceCacheCompression ( )

◆ GetSurfaceLayerConfig()

const FLumenSurfaceLayerConfig & GetSurfaceLayerConfig ( ELumenSurfaceCacheLayer  Layer)

◆ IMPLEMENT_GLOBAL_SHADER() [1/4]

IMPLEMENT_GLOBAL_SHADER ( FClearCompressedAtlasCS  ,
"/Engine/Private/Lumen/SurfaceCache/LumenSurfaceCache.usf"  ,
"ClearCompressedAtlasCS"  ,
SF_Compute   
)

◆ IMPLEMENT_GLOBAL_SHADER() [2/4]

IMPLEMENT_GLOBAL_SHADER ( FCopyCapturedCardPageCS  ,
"/Engine/Private/Lumen/SurfaceCache/LumenSurfaceCache.usf"  ,
"CopyCapturedCardPageCS"  ,
SF_Compute   
)

◆ IMPLEMENT_GLOBAL_SHADER() [3/4]

IMPLEMENT_GLOBAL_SHADER ( FGenerateDilationTileDataCS  ,
"/Engine/Private/Lumen/SurfaceCache/LumenSurfaceCache.usf"  ,
"GenerateDilationTileDataCS"  ,
SF_Compute   
)

◆ IMPLEMENT_GLOBAL_SHADER() [4/4]

IMPLEMENT_GLOBAL_SHADER ( FLumenCardCopyPS  ,
"/Engine/Private/Lumen/SurfaceCache/LumenSurfaceCache.usf"  ,
"LumenCardCopyPS"  ,
SF_Pixel   
)

Variable Documentation

◆ GLumenSurfaceCacheCompress

int32 GLumenSurfaceCacheCompress = 1