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

#include <SceneRendering.h>

Public Types

enum  { OccludedPrimitiveQueryBatchSize = 16 }
 

Public Member Functions

 FOcclusionQueryBatcher (class FSceneViewState *ViewState, uint32 InMaxBatchedPrimitives, uint32 InNumInstances)
 
 ~FOcclusionQueryBatcher ()
 
bool HasBatches (void) const
 
void Flush (FRHICommandList &RHICmdList)
 
FRHIRenderQuery * BatchPrimitive (const FVector &BoundsOrigin, const FVector &BoundsBoxExtent, FGlobalDynamicVertexBuffer &DynamicVertexBuffer)
 
int32 GetNumBatchOcclusionQueries () const
 

Detailed Description

Combines consecutive primitives which use the same occlusion query into a single DrawIndexedPrimitive call.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

The maximum number of consecutive previously occluded primitives which will be combined into a single occlusion query.

Enumerator
OccludedPrimitiveQueryBatchSize 

Constructor & Destructor Documentation

◆ FOcclusionQueryBatcher()

FOcclusionQueryBatcher::FOcclusionQueryBatcher ( class FSceneViewState *  ViewState,
uint32  InMaxBatchedPrimitives,
uint32  InNumInstances 
)

Initialization constructor.

◆ ~FOcclusionQueryBatcher()

FOcclusionQueryBatcher::~FOcclusionQueryBatcher ( )

Destructor.

Member Function Documentation

◆ BatchPrimitive()

FRHIRenderQuery * FOcclusionQueryBatcher::BatchPrimitive ( const FVector &  BoundsOrigin,
const FVector &  BoundsBoxExtent,
FGlobalDynamicVertexBuffer &  DynamicVertexBuffer 
)

Batches a primitive's occlusion query for rendering.

Parameters
Bounds- The primitive's bounds.

◆ Flush()

void FOcclusionQueryBatcher::Flush ( FRHICommandList &  RHICmdList)

Renders the current batch and resets the batch state.

◆ GetNumBatchOcclusionQueries()

int32 FOcclusionQueryBatcher::GetNumBatchOcclusionQueries ( ) const
inline

◆ HasBatches()

bool FOcclusionQueryBatcher::HasBatches ( void  ) const
inline
Returns
True if the batcher has any outstanding batches, otherwise false.
The documentation for this class was generated from the following files: