Castle Game Engine

Record TRenderStatistics

Description
Hierarchy
Fields
Methods
Properties

Unit

CastleTransform

Declaration

type TRenderStatistics = record

Description

Statistics about what was rendered during last frame. You will usually access this by viewport property, see TCastleViewport.Statistics.

Overview

Fields

Public ShapesRendered: Cardinal;
Public ShapesVisible: Cardinal;
Public BoxesOcclusionQueriedCount: Cardinal;
Public ScenesRendered: Cardinal;
Public ScenesVisible: Cardinal;

Methods

Public function ToString: String;

Description

Fields

Public ShapesRendered: Cardinal;

How many shapes were rendered (send to OpenGL) versus all shapes that were potentially visible. Potentially visible shapes are the ones with TShape.Visible inside a TCastleTransform with TCastleTransform.Exists.

When ShapesRendered is much smaller than ShapesVisible, it means that the algorithm for removing invisible scene parts works good. This includes per-shape frustum culling (see TCastleScene.FrustumCulling), distance culling (TCastleScene.DistanceCulling), occlusion culling (see TCastleRenderOptions.OcclusionQuery).

Public ShapesVisible: Cardinal;

How many shapes were rendered (send to OpenGL) versus all shapes that were potentially visible. Potentially visible shapes are the ones with TShape.Visible inside a TCastleTransform with TCastleTransform.Exists.

When ShapesRendered is much smaller than ShapesVisible, it means that the algorithm for removing invisible scene parts works good. This includes per-shape frustum culling (see TCastleScene.FrustumCulling), distance culling (TCastleScene.DistanceCulling), occlusion culling (see TCastleRenderOptions.OcclusionQuery).

Public BoxesOcclusionQueriedCount: Cardinal;

The number of shapes that were not rendered, but their bounding box was rendered to check with occlusion query. This is always zero when not using occlusion query (see TCastleRenderOptions.OcclusionQuery). Basically, this measures the "invisible overhead" of occlusion query.

Public ScenesRendered: Cardinal;

TCastleScene rendered vs all visible.

Public ScenesVisible: Cardinal;

TCastleScene rendered vs all visible.

Methods

Public function ToString: String;

Present the statistics information as a multi-line string. Display it e.g. by assigning to TCastleLabel.Caption.

Generated by PasDoc 0.16.0.