CC3PerformanceStatistics Class Reference
| Inherits from | NSObject |
| Conforms to | NSCopying |
| Declared in | CC3PerformanceStatistics.h |
Overview
Collects statistics about the updating and drawing performance of the 3D scene.
To allow flexibility in calculating statistics, this class does not automatically clear the accumulated statistics. It is the responsibility of the application to read the values, and invoke the reset method on the instance periodically, to ensure this instance does not overflow. Depending on the complexity and capabilities of your application, you should reset the performance statistics at least every few seconds.
Tasks
-
updatesHandledproperty -
accumulatedUpdateTimeproperty -
– addUpdateTime: -
nodesUpdatedproperty -
– addNodesUpdated: -
– incrementNodesUpdated -
nodesTransformedproperty -
– addNodesTransformed: -
– incrementNodesTransformed -
framesHandledproperty -
accumulatedFrameTimeproperty -
– addFrameTime: -
nodesVisitedForDrawingproperty -
– addNodesVisitedForDrawing: -
– incrementNodesVisitedForDrawing -
nodesDrawnproperty -
– addNodesDrawn: -
– incrementNodesDrawn -
drawingCallsMadeproperty -
– addDrawingCallsMade: -
facesPresentedproperty -
– addFacesPresented: -
– addSingleCallFacesPresented: -
updateRateproperty -
averageNodesUpdatedPerUpdateproperty -
averageNodesTransformedPerUpdateproperty -
frameRateproperty -
averageNodesVisitedForDrawingPerFrameproperty -
averageNodesDrawnPerFrameproperty -
averageDrawingCallsMadePerFrameproperty -
averageFacesPresentedPerFrameproperty -
+ statistics -
– reset -
– fullDescription
Properties
accumulatedFrameTime
The total time accumulated for frames since the reset method was last invoked.
@property (nonatomic, readonly) CCTime accumulatedFrameTimeDeclared In
CC3PerformanceStatistics.haccumulatedUpdateTime
The total time accumulated for updates since the reset method was last invoked.
@property (nonatomic, readonly) CCTime accumulatedUpdateTimeDeclared In
CC3PerformanceStatistics.haverageDrawingCallsMadePerFrame
The average GL drawing calls made per drawing frame, calculated by dividing the drawingCallsMade property by the framesHandled property.
@property (nonatomic, readonly) GLfloat averageDrawingCallsMadePerFrameDeclared In
CC3PerformanceStatistics.haverageFacesPresentedPerFrame
The average number of triangle faces presented to the GL engine per drawing frame, calculated by dividing the facesPresented property by the framesHandled property.
@property (nonatomic, readonly) GLfloat averageFacesPresentedPerFrameDiscussion
When drawing lines or points, this will be the total number of lines or points presented to the GL engine. This is not necessarily the number of triangles (or other primitives) that were actually drawn, because the GL engine will cull faces that are not visible to the camera.
Declared In
CC3PerformanceStatistics.haverageNodesDrawnPerFrame
The average nodes drawn per drawing frame, calculated by dividing the nodesDrawn property by the framesHandled property.
@property (nonatomic, readonly) GLfloat averageNodesDrawnPerFrameDiscussion
The difference between the averageNodesVisitedForDrawingPerFrame property and this property is the average number of nodes per frame that were not visible or were culled and not presented to the GL engine for drawing.
Declared In
CC3PerformanceStatistics.haverageNodesTransformedPerUpdate
The average nodes whose globalTransformMatrix was recalculated per update, calculated by dividing the nodesTransformed property by the updatesHandled property.
@property (nonatomic, readonly) GLfloat averageNodesTransformedPerUpdateDeclared In
CC3PerformanceStatistics.haverageNodesUpdatedPerUpdate
The average nodes updated per update, calculated by dividing the nodesUpdated property by the updatesHandled property.
@property (nonatomic, readonly) GLfloat averageNodesUpdatedPerUpdateDeclared In
CC3PerformanceStatistics.haverageNodesVisitedForDrawingPerFrame
The average nodes visited per drawing frame, calculated by dividing the nodesVisitedForDrawing property by the framesHandled property.
@property (nonatomic, readonly) GLfloat averageNodesVisitedForDrawingPerFrameDiscussion
The difference between this property and the averageNodesDrawnPerFrame property is the average number of nodes per frame that were not visible or were culled and not presented to the GL engine for drawing.
Declared In
CC3PerformanceStatistics.hdrawingCallsMade
The total number of drawing calls that were made to the GL engine (glDrawArrays & glDrawElements) since the reset method was last invoked.
@property (nonatomic, readonly) GLuint drawingCallsMadeDeclared In
CC3PerformanceStatistics.hfacesPresented
The total number of triangle faces presented to the GL engine since the reset method was last invoked.
@property (nonatomic, readonly) GLuint facesPresentedDiscussion
When drawing lines or points, this will be the total number of lines or points presented to the GL engine. This is not necessarily the number of triangles (or other primitives) that were actually drawn, because the GL engine will cull faces that are not visible to the camera.
Declared In
CC3PerformanceStatistics.hframeRate
The average drawing frame rate, calculated by dividing the framesHandled property by the accumulatedFrameTime property.
@property (nonatomic, readonly) GLfloat frameRateDeclared In
CC3PerformanceStatistics.hframesHandled
The number of frames that have been processed since the reset method was last invoked.
@property (nonatomic, readonly) GLuint framesHandledDeclared In
CC3PerformanceStatistics.hnodesDrawn
The total number of nodes drawn by the GL engine since the reset method was last invoked.
@property (nonatomic, readonly) GLuint nodesDrawnDiscussion
The difference between the nodesVisitedForDrawing property and this property is the total number of nodes that were not visible or were culled and not presented to the GL engine for drawing.
Declared In
CC3PerformanceStatistics.hnodesTransformed
The total number of nodes whose globalTransformMatrix was recalculated since the reset method was last invoked.
@property (nonatomic, readonly) GLuint nodesTransformedDeclared In
CC3PerformanceStatistics.hnodesUpdated
The total number of nodes updated since the reset method was last invoked.
@property (nonatomic, readonly) GLuint nodesUpdatedDeclared In
CC3PerformanceStatistics.hnodesVisitedForDrawing
The total number of nodes visited for drawing since the reset method was last invoked. This includes both nodes that were drawn, and nodes that were culled prior to drawing.
@property (nonatomic, readonly) GLuint nodesVisitedForDrawingDiscussion
The difference between this property and the nodesDrawn property is the total number of nodes that were not visible or were culled and not presented to the GL engine for drawing.
Declared In
CC3PerformanceStatistics.hInstance Methods
addDrawingCallsMade:
Adds the specified number of drawing calls to the drawingCallsMade property.
- (void)addDrawingCallsMade:(GLuint)callCountDeclared In
CC3PerformanceStatistics.haddFacesPresented:
Adds the specified number of faces to the facesPresented property.
- (void)addFacesPresented:(GLuint)faceCountDeclared In
CC3PerformanceStatistics.haddFrameTime:
Adds the specified single-frame delta-time to the accumulated frame time, and increments the count of frame handled by one.
- (void)addFrameTime:(CCTime)deltaTimeDeclared In
CC3PerformanceStatistics.haddNodesDrawn:
Adds the specified number of nodes to the nodesDrawn property.
- (void)addNodesDrawn:(GLuint)nodeCountDeclared In
CC3PerformanceStatistics.haddNodesTransformed:
Adds the specified number of nodes to the nodesTransformed property.
- (void)addNodesTransformed:(GLuint)nodeCountDeclared In
CC3PerformanceStatistics.haddNodesUpdated:
Adds the specified number of nodes to the nodesUpdated property.
- (void)addNodesUpdated:(GLuint)nodeCountDeclared In
CC3PerformanceStatistics.haddNodesVisitedForDrawing:
Adds the specified number of nodes to the nodesVisitedForDrawing property.
- (void)addNodesVisitedForDrawing:(GLuint)nodeCountDeclared In
CC3PerformanceStatistics.haddSingleCallFacesPresented:
Canvenience method that adds the specified number of faces to the facesPresented property, and increments by one the number of drawing calls made.
- (void)addSingleCallFacesPresented:(GLuint)faceCountDeclared In
CC3PerformanceStatistics.haddUpdateTime:
Adds the specified single-update delta-time to the accumulated update time, and increments the count of updates handled by one.
- (void)addUpdateTime:(CCTime)deltaTimeDeclared In
CC3PerformanceStatistics.hfullDescription
Returns a detailed descripton of this instance.
- (NSString *)fullDescriptionDeclared In
CC3PerformanceStatistics.hincrementNodesDrawn
Increments the nodesDrawn property by one.
- (void)incrementNodesDrawnDeclared In
CC3PerformanceStatistics.hincrementNodesTransformed
Increments the nodesTransformed property by one.
- (void)incrementNodesTransformedDeclared In
CC3PerformanceStatistics.hincrementNodesUpdated
Increments the nodesUpdated property by one.
- (void)incrementNodesUpdatedDeclared In
CC3PerformanceStatistics.hincrementNodesVisitedForDrawing
Increments the nodesVisitedForDrawing property by one.
- (void)incrementNodesVisitedForDrawingDeclared In
CC3PerformanceStatistics.hreset
Resets all the performance statistics back to zero.
- (void)resetDiscussion
To allow flexibility in calculating statistics, this class does not automatically clear the accumulated statistics. It is the responsibility of the application to read the values, and invoke the reset method on the instance periodically, to ensure this instance does not overflow. Depending on the complexity and capabilities of your application, you should reset the performance statistics at least every few seconds.
Declared In
CC3PerformanceStatistics.h