class ART::IStatistics

Processing informations on the world. More...

#include <ARTIStatistics.h>

Inherits: IREDObject.

Public functions:

virtual doubleGetFPS ( ) const = 0
virtual intGetLandscapeBatchesCount ( ) const = 0
virtual doubleGetLandscapeBatchUpdateTime ( ) const = 0
virtual doubleGetLandscapePatchUpdateTime ( ) const = 0
virtual doubleGetLandscapeSubmitTime ( ) const = 0
virtual doubleGetLandscapeSyncTime ( ) const = 0
virtual intGetLandscapeTrianglesCount ( ) const = 0
virtual doubleGetLandscapeVisibilityUpdateTime ( ) const = 0
virtual doubleGetMainThreadOutsideUpdateTime ( ) const = 0
virtual doubleGetMainThreadREDsdkClusterUpdateTime ( ) const = 0
virtual doubleGetMainThreadREDsdkDrawTime ( ) const = 0
virtual doubleGetMainThreadREDsdkImageUpdateTime ( ) const = 0
virtual doubleGetMainThreadSyncWaitTime ( ) const = 0
virtual const RED::Map< unsigned int, RED::String > &GetPipelineIDToNames ( ) const = 0
virtual intGetPrismsBatchesCount ( ) const = 0
virtual intGetPrismsCount ( ) const = 0
virtual doubleGetUpdateThreadFullSynchronizationTime ( ) const = 0
virtual doubleGetUpdateThreadREDsdkTransactionWaitTime ( ) const = 0
virtual doubleGetUpdateThreadSimulationTime ( ) const = 0
virtual doubleGetUpdateThreadStatelessSynchronizationTime ( ) const = 0

Public static functions:

static RED::CIDGetClassID ( )

Detailed description:

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.

Functions documentation

public virtual double ART::IStatistics::GetFPS() const = 0

Returns:

The number of rendered frames per second.

Returns:

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

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

public virtual double ART::IStatistics::GetLandscapeBatchUpdateTime() const = 0

Returns:

The time taken by landscape batches processing during an update.
public virtual double ART::IStatistics::GetLandscapePatchUpdateTime() const = 0

Returns:

The time taken by landscape patch processing time during an update.
public virtual double ART::IStatistics::GetLandscapeSubmitTime() const = 0

Returns:

The time taken by landscape patch calculation orders dispatch among calculating threads.
public virtual double ART::IStatistics::GetLandscapeSyncTime() const = 0

Returns:

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

Returns:

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

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

public virtual double ART::IStatistics::GetLandscapeVisibilityUpdateTime() const = 0

Returns:

The time taken by landscape patch visibility processing.
public virtual double ART::IStatistics::GetMainThreadOutsideUpdateTime() const = 0

Returns:

The time spent outside of the application update loop.

Returns:

The time taken by the REDsdk cluster update.
public virtual double ART::IStatistics::GetMainThreadREDsdkDrawTime() const = 0

Returns:

The REDsdk rendering time.

Returns:

The time taken updating REDsdk images before rendering a frame.
public virtual double ART::IStatistics::GetMainThreadSyncWaitTime() const = 0

Returns:

The time spent waiting for the update thread to complete a frame.
public virtual const RED::Map< unsigned int, RED::String > & ART::IStatistics::GetPipelineIDToNames() const = 0

Returns:

The rendering pipeline ID to names map.
public virtual int ART::IStatistics::GetPrismsBatchesCount() const = 0

Returns:

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

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

public virtual int ART::IStatistics::GetPrismsCount() const = 0

Returns:

The number of prisms displayed on the closest planet.

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

Time spent waiting for the full graphics synchronization.

Returns:

The time spent waiting for an available REDsdk transaction.
public virtual double ART::IStatistics::GetUpdateThreadSimulationTime() const = 0

Returns:

The time spent in the simulation update.

Returns:

The time spent in the stateless graphics synchronization.