IStatistics

Detailed Description

class IStatistics : public RED::IREDObject

Processing informations on the world.

The CID_ARTWorld class object (the world singleton) implements the ART::IStatistics interface. This interface lets you access measurements on the simulation and rendering of the system.

Public Functions

SET_CID(CID_class_ARTIStatistics)
virtual double GetFPS() const = 0
Returns

The number of rendered frames per second.

virtual double GetMainThreadREDsdkImageUpdateTime() const = 0
Returns

The time taken updating REDsdk images before rendering a frame.

virtual double GetMainThreadREDsdkClusterUpdateTime() const = 0
Returns

The time taken by the REDsdk cluster update.

virtual double GetMainThreadREDsdkDrawTime() const = 0
Returns

The REDsdk rendering time.

virtual double GetMainThreadREDsdkAuxiliaryDrawTime() const = 0
Returns

The REDsdk auxiliary pipeline rendering time.

virtual double GetMainThreadSyncWaitTime() const = 0
Returns

The time spent waiting for the update thread to complete a frame.

virtual double GetMainThreadOutsideUpdateTime() const = 0
Returns

The time spent outside of the application update loop.

virtual double GetUpdateThreadSimulationTime() const = 0
Returns

The time spent in the simulation update.

virtual double GetUpdateThreadStatelessSynchronizationTime() const = 0
Returns

The time spent in the stateless graphics synchronization.

virtual double GetUpdateThreadREDsdkTransactionWaitTime() const = 0
Returns

The time spent waiting for an available REDsdk transaction.

virtual double GetUpdateThreadFullSynchronizationTime() const = 0

Time spent waiting for the full graphics synchronization.

virtual int GetLandscapeTrianglesCount() const = 0

This value is only meaningful if we’re close enough of a planet. Otherwise, 0 will be returned.

Returns

The number of triangles used for the display of the landscape of the closest planet.

virtual int GetLandscapeBatchesCount() const = 0

This value is only meaningful if we’re close enough of a planet. Otherwise, 0 will be returned.

Returns

The number of rendering batches used for the display of the landscape of the closest planet.

virtual double GetLandscapeVisibilityUpdateTime() const = 0
Returns

The time taken by landscape patch visibility processing.

virtual double GetLandscapeSubmitTime() const = 0
Returns

The time taken by landscape patch calculation orders dispatch among calculating threads.

virtual double GetLandscapePatchUpdateTime() const = 0
Returns

The time taken by landscape patch processing time during an update.

virtual double GetLandscapeBatchUpdateTime() const = 0
Returns

The time taken by landscape batches processing during an update.

virtual double GetLandscapeSyncTime() const = 0
Returns

The time taken by landscape update calculations since the camera has stopped moving.

virtual int GetPrismsCount() const = 0

This value is only meaningful if we’re close enough of a planet. Otherwise, 0 will be returned.

Returns

The number of prisms displayed on the closest planet.

virtual int GetPrismsBatchesCount() const = 0

This value is only meaningful if we’re close enough of a planet. Otherwise, 0 will be returned.

Returns

The number of rendering batches used for the display of prisms of the closest planet.

virtual const RED::Map<unsigned int, RED::String> &GetPipelineIDToNames() const = 0
Returns

The rendering pipeline ID to names map.