FPrimitiveOcclusionHistory Class Reference

#include <ScenePrivate.h>

Public Member Functions
	FPrimitiveOcclusionHistory (FPrimitiveComponentId InPrimitiveId, int32 SubQuery)
	FPrimitiveOcclusionHistory ()
FRHIRenderQuery *	GetQueryForReading (uint32 FrameNumber, int32 NumBufferedFrames, int32 LagTolerance, bool &bOutGrouped) const
void	SetCurrentQuery (uint32 FrameNumber, FRHIRenderQuery *NewQuery, int32 NumBufferedFrames, bool bGrouped, bool bNeedsScan)
uint32	LastQuerySubmitFrame () const

Public Attributes
FPrimitiveComponentId	PrimitiveId
FRHIRenderQuery *	PendingOcclusionQuery [FOcclusionQueryHelpers::MaxBufferedOcclusionFrames]
uint32	PendingOcclusionQueryFrames [FOcclusionQueryHelpers::MaxBufferedOcclusionFrames]
uint32	LastTestFrameNumber
uint32	LastConsideredFrameNumber
uint32	HZBTestIndex
float	LastProvenVisibleTime
float	LastConsideredTime
float	LastPixelsPercentage
int32	CustomIndex
uint8	BecameEligibleForQueryCooldown: 6
uint8	WasOccludedLastFrame: 1
uint8	OcclusionStateWasDefiniteLastFrame: 1
bool	bGroupedQuery [FOcclusionQueryHelpers::MaxBufferedOcclusionFrames]

Detailed Description

Holds information about a single primitive's occlusion.

Constructor & Destructor Documentation

FPrimitiveOcclusionHistory() [1/2]

FPrimitiveOcclusionHistory::FPrimitiveOcclusionHistory ( FPrimitiveComponentId  InPrimitiveId, int32  SubQuery  )

inline

Initialization constructor.

FPrimitiveOcclusionHistory() [2/2]

FPrimitiveOcclusionHistory::FPrimitiveOcclusionHistory ( )

inline

Member Function Documentation

GetQueryForReading()

FRHIRenderQuery * FPrimitiveOcclusionHistory::GetQueryForReading ( uint32  FrameNumber, int32  NumBufferedFrames, int32  LagTolerance, bool &  bOutGrouped  ) const

inline

LastQuerySubmitFrame()

uint32 FPrimitiveOcclusionHistory::LastQuerySubmitFrame ( ) const

inline

SetCurrentQuery()

void FPrimitiveOcclusionHistory::SetCurrentQuery ( uint32  FrameNumber, FRHIRenderQuery *  NewQuery, int32  NumBufferedFrames, bool  bGrouped, bool  bNeedsScan  )

inline

Member Data Documentation

BecameEligibleForQueryCooldown

uint8 FPrimitiveOcclusionHistory::BecameEligibleForQueryCooldown

When things first become eligible for occlusion, then might be sweeping into the frustum, we are going to leave them at visible for a few frames, then start real queries.

bGroupedQuery

bool FPrimitiveOcclusionHistory::bGroupedQuery[FOcclusionQueryHelpers::MaxBufferedOcclusionFrames]

whether or not this primitive was grouped the last time it was queried

CustomIndex

int32 FPrimitiveOcclusionHistory::CustomIndex

For things that have subqueries (foliage), this is the non-zero

HZBTestIndex

uint32 FPrimitiveOcclusionHistory::HZBTestIndex

LastConsideredFrameNumber

uint32 FPrimitiveOcclusionHistory::LastConsideredFrameNumber

LastConsideredTime

float FPrimitiveOcclusionHistory::LastConsideredTime

The last time the primitive was in the view frustum.

LastPixelsPercentage

float FPrimitiveOcclusionHistory::LastPixelsPercentage

The pixels that were rendered the last time the primitive was drawn. It is the ratio of pixels unoccluded to the resolution of the scene.

LastProvenVisibleTime

float FPrimitiveOcclusionHistory::LastProvenVisibleTime

The last time the primitive was visible.

LastTestFrameNumber

uint32 FPrimitiveOcclusionHistory::LastTestFrameNumber

OcclusionStateWasDefiniteLastFrame

uint8 FPrimitiveOcclusionHistory::OcclusionStateWasDefiniteLastFrame

PendingOcclusionQuery

FRHIRenderQuery* FPrimitiveOcclusionHistory::PendingOcclusionQuery[FOcclusionQueryHelpers::MaxBufferedOcclusionFrames]

The occlusion query which contains the primitive's pending occlusion results.

PendingOcclusionQueryFrames

uint32 FPrimitiveOcclusionHistory::PendingOcclusionQueryFrames[FOcclusionQueryHelpers::MaxBufferedOcclusionFrames]

PrimitiveId

FPrimitiveComponentId FPrimitiveOcclusionHistory::PrimitiveId

The primitive the occlusion information is about.

WasOccludedLastFrame

uint8 FPrimitiveOcclusionHistory::WasOccludedLastFrame

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/Renderer/Private/ScenePrivate.h