UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Friends | List of all members
FSceneCullingRenderer Class Reference

#include <SceneCullingRenderer.h>

+ Inheritance diagram for FSceneCullingRenderer:

Public Member Functions

 FSceneCullingRenderer (FSceneRendererBase &InSceneRenderer, FSceneCulling &InSceneCulling)
 
bool IsEnabled () const
 
FInstanceHierarchyParameters & GetShaderParameters (FRDGBuilder &GraphBuilder)
 
FSceneInstanceCullingQuery * CullInstances (FRDGBuilder &GraphBuilder, const TConstArrayView< FConvexVolume > &ViewCullVolumes)
 
FSceneInstanceCullingQuery * CullInstances (FRDGBuilder &GraphBuilder, const FConvexVolume &ViewCullVolume)
 
FSceneInstanceCullingQuery * CreateInstanceQuery (FRDGBuilder &GraphBuilder)
 
void DebugRender (FRDGBuilder &GraphBuilder, TArrayView< FViewInfo > Views)
 
- Public Member Functions inherited from ISceneExtensionRenderer
 ISceneExtensionRenderer (FSceneRendererBase &InSceneRenderer)
 
virtual ~ISceneExtensionRenderer ()
 
virtual void Begin (FSceneRendererBase *InRenderer)
 
virtual void End ()
 
virtual void PreInitViews (FRDGBuilder &GraphBuilder)
 
virtual void UpdateViewData (FRDGBuilder &GraphBuilder, const FRendererViewDataManager &ViewDataManager)
 
virtual void UpdateSceneUniformBuffer (FRDGBuilder &GraphBuilder, FSceneUniformBuffer &SceneUniforms)
 
virtual void PreRender (FRDGBuilder &GraphBuilder)
 
virtual void PostRender (FRDGBuilder &GraphBuilder)
 

Friends

class FSceneInstanceCullingQuery
 

Additional Inherited Members

- Protected Member Functions inherited from ISceneExtensionRenderer
FSceneRendererBase & GetSceneRenderer ()
 

Detailed Description

Renderer-lifetime functionality, provides scope for anything that should share life-time with a Scene Renderer, rather than Scene.

Constructor & Destructor Documentation

◆ FSceneCullingRenderer()

FSceneCullingRenderer::FSceneCullingRenderer ( FSceneRendererBase &  InSceneRenderer,
FSceneCulling &  InSceneCulling 
)
inline

Member Function Documentation

◆ CreateInstanceQuery()

FSceneInstanceCullingQuery * FSceneCullingRenderer::CreateInstanceQuery ( FRDGBuilder &  GraphBuilder)

Create a query that is not immediately dispatched, such that jobs can be added first.

◆ CullInstances() [1/2]

FSceneInstanceCullingQuery * FSceneCullingRenderer::CullInstances ( FRDGBuilder &  GraphBuilder,
const FConvexVolume &  ViewCullVolume 
)
inline

◆ CullInstances() [2/2]

FSceneInstanceCullingQuery * FSceneCullingRenderer::CullInstances ( FRDGBuilder &  GraphBuilder,
const TConstArrayView< FConvexVolume > &  ViewCullVolumes 
)

Create and dispatch a culling query for a set of views that has a 1:1 mapping from culling volume to view index May run async.

◆ DebugRender()

void FSceneCullingRenderer::DebugRender ( FRDGBuilder &  GraphBuilder,
TArrayView< FViewInfo >  Views 
)

◆ GetShaderParameters()

FInstanceHierarchyParameters & FSceneCullingRenderer::GetShaderParameters ( FRDGBuilder &  GraphBuilder)

Getting the shader parameters forces a sync wrt the hierarchy update, since we need to resize the GPU buffers at this point.

◆ IsEnabled()

bool FSceneCullingRenderer::IsEnabled ( ) const
inline

Friends And Related Symbol Documentation

◆ FSceneInstanceCullingQuery

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