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

Classes

class  FLocalFogVolumeTiledCullingCS
 
class  FLocalFogVolumeTiledRenderVS
 
class  FLocalFogVolumeTiledRenderPS
 
struct  FDepthBoundSetup
 
class  FMobileLocalFogVolumeTiledRenderVS
 
class  FMobileLocalFogVolumeTiledRenderPS
 
class  FMobileLocalFogVolumeTiledRenderHalfResPS
 

Functions

bool ProjectSupportsLocalFogVolumes ()
 
bool ShouldRenderLocalFogVolume (const FScene *Scene, const FSceneViewFamily &SceneViewFamily)
 
bool ShouldRenderLocalFogVolumeDuringHeightFogPass (const FScene *Scene, const FSceneViewFamily &SceneViewFamily)
 
bool ShouldRenderLocalFogVolumeInVolumetricFog (const FScene *Scene, const FSceneViewFamily &SceneViewFamily, bool bShouldRenderVolumetricFog)
 
bool ShouldRenderLocalFogVolumeVisualizationPass (const FScene *Scene, const FSceneViewFamily &SceneViewFamily)
 
float GetLocalFogVolumeGlobalStartDistance ()
 
bool IsLocalFogVolumeHalfResolution ()
 
 DECLARE_GPU_STAT (LocalFogVolumeVolumes)
 
void SetDummyLocalFogVolumeUniformParametersStruct (FRDGBuilder &GraphBuilder, FLocalFogVolumeUniformParameters &UniformParametersStruct)
 
void SetDummyLocalFogVolumeForView (FRDGBuilder &GraphBuilder, FViewInfo &View)
 
void SetDummyLocalFogVolumeForViews (FRDGBuilder &GraphBuilder, TArray< FViewInfo > &Views)
 
void SetDummyLocalFogVolumeForViews (FRDGBuilder &GraphBuilder, TArray< FViewInfo * > &Views)
 
 IMPLEMENT_GLOBAL_SHADER (FLocalFogVolumeTiledCullingCS, "/Engine/Private/LocalFogVolumes/LocalFogVolumeTiledCulling.usf", "LocalFogVolumeTiledCullingCS", SF_Compute)
 
void GetLocalFogVolumeViewSortingData (const FScene *Scene, const FViewInfo &View, FRDGBuilder &GraphBuilder, FLocalFogVolumeSortingData &Out)
 
void CreateViewLocalFogVolumeBufferSRV (const FScene *Scene, FViewInfo &View, FRDGBuilder &GraphBuilder, FLocalFogVolumeSortingData &SortingData, bool bShouldRenderLocalFogVolumeInVolumetricFog, bool bUseHalfResLocalFogVolume)
 
void InitLocalFogVolumesForViews (const FScene *Scene, TArray< FViewInfo > &Views, const FSceneViewFamily &SceneViewFamily, FRDGBuilder &GraphBuilder, bool bShouldRenderVolumetricFog, bool bUseHalfResLocalFogVolume)
 
 IMPLEMENT_GLOBAL_SHADER (FLocalFogVolumeTiledRenderVS, "/Engine/Private/LocalFogVolumes/LocalFogVolumeSplat.usf", "LocalFogVolumeTiledVS", SF_Vertex)
 
 IMPLEMENT_GLOBAL_SHADER (FLocalFogVolumeTiledRenderPS, "/Engine/Private/LocalFogVolumes/LocalFogVolumeSplat.usf", "LocalFogVolumeTiledPS", SF_Pixel)
 
void RenderLocalFogVolume (const FScene *Scene, TArray< FViewInfo > &Views, const FSceneViewFamily &SceneViewFamily, FRDGBuilder &GraphBuilder, const FMinimalSceneTextures &SceneTextures, FRDGTextureRef LightShaftOcclusionTexture, bool bVisualizationPass)
 
void RenderLocalFogVolumeVisualization (const FScene *Scene, TArray< FViewInfo > &Views, const FSceneViewFamily &SceneViewFamily, FRDGBuilder &GraphBuilder, const FMinimalSceneTextures &SceneTextures)
 
 IMPLEMENT_GLOBAL_SHADER (FMobileLocalFogVolumeTiledRenderVS, "/Engine/Private/LocalFogVolumes/LocalFogVolumeSplat.usf", "LocalFogVolumeTiledVS", SF_Vertex)
 
 IMPLEMENT_GLOBAL_SHADER (FMobileLocalFogVolumeTiledRenderPS, "/Engine/Private/LocalFogVolumes/LocalFogVolumeSplat.usf", "LocalFogVolumeTiledPS", SF_Pixel)
 
 IMPLEMENT_GLOBAL_SHADER (FMobileLocalFogVolumeTiledRenderHalfResPS, "/Engine/Private/LocalFogVolumes/LocalFogVolumeSplat.usf", "LocalFogVolumeTiledPS", SF_Pixel)
 
void RenderLocalFogVolumeMobile (FRHICommandList &RHICmdList, const FViewInfo &View)
 
void RenderLocalFogVolumeHalfResMobile (FRDGBuilder &GraphBuilder, const FViewInfo &View)
 

Function Documentation

◆ CreateViewLocalFogVolumeBufferSRV()

void CreateViewLocalFogVolumeBufferSRV ( const FScene Scene,
FViewInfo View,
FRDGBuilder GraphBuilder,
FLocalFogVolumeSortingData SortingData,
bool  bShouldRenderLocalFogVolumeInVolumetricFog,
bool  bUseHalfResLocalFogVolume 
)

◆ DECLARE_GPU_STAT()

DECLARE_GPU_STAT ( LocalFogVolumeVolumes  )

◆ GetLocalFogVolumeGlobalStartDistance()

float GetLocalFogVolumeGlobalStartDistance ( )

◆ GetLocalFogVolumeViewSortingData()

void GetLocalFogVolumeViewSortingData ( const FScene Scene,
const FViewInfo View,
FRDGBuilder GraphBuilder,
FLocalFogVolumeSortingData Out 
)

◆ IMPLEMENT_GLOBAL_SHADER() [1/6]

IMPLEMENT_GLOBAL_SHADER ( FLocalFogVolumeTiledCullingCS  ,
"/Engine/Private/LocalFogVolumes/LocalFogVolumeTiledCulling.usf"  ,
"LocalFogVolumeTiledCullingCS"  ,
SF_Compute   
)

◆ IMPLEMENT_GLOBAL_SHADER() [2/6]

IMPLEMENT_GLOBAL_SHADER ( FLocalFogVolumeTiledRenderPS  ,
"/Engine/Private/LocalFogVolumes/LocalFogVolumeSplat.usf"  ,
"LocalFogVolumeTiledPS"  ,
SF_Pixel   
)

◆ IMPLEMENT_GLOBAL_SHADER() [3/6]

IMPLEMENT_GLOBAL_SHADER ( FLocalFogVolumeTiledRenderVS  ,
"/Engine/Private/LocalFogVolumes/LocalFogVolumeSplat.usf"  ,
"LocalFogVolumeTiledVS"  ,
SF_Vertex   
)

◆ IMPLEMENT_GLOBAL_SHADER() [4/6]

IMPLEMENT_GLOBAL_SHADER ( FMobileLocalFogVolumeTiledRenderHalfResPS  ,
"/Engine/Private/LocalFogVolumes/LocalFogVolumeSplat.usf"  ,
"LocalFogVolumeTiledPS"  ,
SF_Pixel   
)

◆ IMPLEMENT_GLOBAL_SHADER() [5/6]

IMPLEMENT_GLOBAL_SHADER ( FMobileLocalFogVolumeTiledRenderPS  ,
"/Engine/Private/LocalFogVolumes/LocalFogVolumeSplat.usf"  ,
"LocalFogVolumeTiledPS"  ,
SF_Pixel   
)

◆ IMPLEMENT_GLOBAL_SHADER() [6/6]

IMPLEMENT_GLOBAL_SHADER ( FMobileLocalFogVolumeTiledRenderVS  ,
"/Engine/Private/LocalFogVolumes/LocalFogVolumeSplat.usf"  ,
"LocalFogVolumeTiledVS"  ,
SF_Vertex   
)

◆ InitLocalFogVolumesForViews()

void InitLocalFogVolumesForViews ( const FScene Scene,
TArray< FViewInfo > &  Views,
const FSceneViewFamily SceneViewFamily,
FRDGBuilder GraphBuilder,
bool  bShouldRenderVolumetricFog,
bool  bUseHalfResLocalFogVolume 
)

◆ IsLocalFogVolumeHalfResolution()

bool IsLocalFogVolumeHalfResolution ( )

◆ ProjectSupportsLocalFogVolumes()

bool ProjectSupportsLocalFogVolumes ( )

◆ RenderLocalFogVolume()

void RenderLocalFogVolume ( const FScene Scene,
TArray< FViewInfo > &  Views,
const FSceneViewFamily SceneViewFamily,
FRDGBuilder GraphBuilder,
const FMinimalSceneTextures SceneTextures,
FRDGTextureRef  LightShaftOcclusionTexture,
bool  bVisualizationPass 
)

◆ RenderLocalFogVolumeHalfResMobile()

void RenderLocalFogVolumeHalfResMobile ( FRDGBuilder GraphBuilder,
const FViewInfo View 
)

◆ RenderLocalFogVolumeMobile()

void RenderLocalFogVolumeMobile ( FRHICommandList RHICmdList,
const FViewInfo View 
)

◆ RenderLocalFogVolumeVisualization()

void RenderLocalFogVolumeVisualization ( const FScene Scene,
TArray< FViewInfo > &  Views,
const FSceneViewFamily SceneViewFamily,
FRDGBuilder GraphBuilder,
const FMinimalSceneTextures SceneTextures 
)

◆ SetDummyLocalFogVolumeForView()

void SetDummyLocalFogVolumeForView ( FRDGBuilder GraphBuilder,
FViewInfo View 
)

◆ SetDummyLocalFogVolumeForViews() [1/2]

void SetDummyLocalFogVolumeForViews ( FRDGBuilder GraphBuilder,
TArray< FViewInfo * > &  Views 
)

◆ SetDummyLocalFogVolumeForViews() [2/2]

void SetDummyLocalFogVolumeForViews ( FRDGBuilder GraphBuilder,
TArray< FViewInfo > &  Views 
)

◆ SetDummyLocalFogVolumeUniformParametersStruct()

void SetDummyLocalFogVolumeUniformParametersStruct ( FRDGBuilder GraphBuilder,
FLocalFogVolumeUniformParameters UniformParametersStruct 
)

◆ ShouldRenderLocalFogVolume()

bool ShouldRenderLocalFogVolume ( const FScene Scene,
const FSceneViewFamily SceneViewFamily 
)

◆ ShouldRenderLocalFogVolumeDuringHeightFogPass()

bool ShouldRenderLocalFogVolumeDuringHeightFogPass ( const FScene Scene,
const FSceneViewFamily SceneViewFamily 
)

◆ ShouldRenderLocalFogVolumeInVolumetricFog()

bool ShouldRenderLocalFogVolumeInVolumetricFog ( const FScene Scene,
const FSceneViewFamily SceneViewFamily,
bool  bShouldRenderVolumetricFog 
)

◆ ShouldRenderLocalFogVolumeVisualizationPass()

bool ShouldRenderLocalFogVolumeVisualizationPass ( const FScene Scene,
const FSceneViewFamily SceneViewFamily 
)