Class storing the frame statistics. More...

#include <Graphic3d_FrameStats.hxx>

Inheritance diagram for Graphic3d_FrameStats:

[legend]

Public Member Functions
	Graphic3d_FrameStats ()
	Default constructor.

virtual	~Graphic3d_FrameStats ()
	Destructor.

Standard_Real	UpdateInterval () const
	Returns interval in seconds for updating meters across several frames; 1 second by default.

void	SetUpdateInterval (Standard_Real theInterval)
	Sets interval in seconds for updating values.

Standard_Boolean	IsLongLineFormat () const
	Prefer longer lines over more greater of lines.

void	SetLongLineFormat (Standard_Boolean theValue)
	Set if format should prefer longer lines over greater number of lines.

virtual void	FrameStart (const Handle< Graphic3d_CView > &theView, bool theIsImmediateOnly)
	Frame redraw started.

virtual void	FrameEnd (const Handle< Graphic3d_CView > &theView, bool theIsImmediateOnly)
	Frame redraw finished.

virtual TCollection_AsciiString	FormatStats (Graphic3d_RenderingParams::PerfCounters theFlags) const
	Returns formatted string.

virtual void	FormatStats (TColStd_IndexedDataMapOfStringString &theDict, Graphic3d_RenderingParams::PerfCounters theFlags) const
	Fill in the dictionary with formatted statistic info.

Standard_Real	FrameDuration () const
	Returns duration of the last frame in seconds.

Standard_Real	FrameRate () const
	Returns FPS (frames per seconds, elapsed time). This number indicates an actual frame rate averaged for several frames within UpdateInterval() duration, basing on a real elapsed time between updates.

Standard_Real	FrameRateCpu () const
	Returns CPU FPS (frames per seconds, CPU time). This number indicates a PREDICTED frame rate, basing on CPU elapsed time between updates and NOT real elapsed time (which might include periods of CPU inactivity). Number is expected to be greater then actual frame rate returned by FrameRate(). Values significantly greater actual frame rate indicate that rendering is limited by GPU performance (CPU is stalled in-between), while values around actual frame rate indicate rendering being limited by CPU performance (GPU is stalled in-between).

Standard_Size	CounterValue (Graphic3d_FrameStatsCounter theCounter) const
	Returns value of specified counter, cached between stats updates. Should NOT be called between FrameStart() and FrameEnd() calls.

Standard_Real	TimerValue (Graphic3d_FrameStatsTimer theTimer) const
	Returns value of specified timer for modification, should be called between FrameStart() and FrameEnd() calls. Should NOT be called between FrameStart() and FrameEnd() calls.

Standard_Boolean	HasCulledLayers () const
	Returns TRUE if some Layers have been culled.

Standard_Boolean	HasCulledStructs () const
	Returns TRUE if some structures have been culled.

const Graphic3d_FrameStatsData &	LastDataFrame () const
	Returns last data frame, cached between stats updates. Should NOT be called between FrameStart() and FrameEnd() calls.

Standard_Integer	LastDataFrameIndex () const
	Returns last data frame index.

const NCollection_Array1< Graphic3d_FrameStatsData > &	DataFrames () const
	Returns data frames.

NCollection_Array1< Graphic3d_FrameStatsData > &	ChangeDataFrames ()
	Returns data frames.

Standard_Size &	ChangeCounter (Graphic3d_FrameStatsCounter theCounter)
	Returns value of specified counter for modification, should be called between FrameStart() and FrameEnd() calls.

Standard_Real &	ChangeTimer (Graphic3d_FrameStatsTimer theTimer)
	Returns value of specified timer for modification, should be called between FrameStart() and FrameEnd() calls.

Graphic3d_FrameStatsDataTmp &	ActiveDataFrame ()
	Returns currently filling data frame for modification, should be called between FrameStart() and FrameEnd() calls.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
virtual void	updateStatistics (const Handle< Graphic3d_CView > &theView, bool theIsImmediateOnly)=0
	Method to collect statistics from the View; called by FrameEnd().

Protected Attributes
OSD_Timer	myFpsTimer
	timer for FPS measurements

Standard_Real	myFrameStartTime
	time at the beginning of frame redraw

Standard_Real	myFrameDuration
	frame duration

Standard_Real	myUpdateInterval
	interval to update meters

Standard_Size	myFpsFrameCount
	FPS counter (within short measurement time slice)

NCollection_Array1< Graphic3d_FrameStatsData >	myCounters
	data frames history

Graphic3d_FrameStatsDataTmp	myCountersTmp
	data frame values filled to be filled between FrameStart() and FrameEnd() calls

Graphic3d_FrameStatsData	myCountersMax
	data frame values with absolute maximum values in the history

Standard_Integer	myLastFrameIndex
	last data frame index

Standard_Boolean	myIsLongLineFormat
	prefer longer lines over greater number of lines

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

Class storing the frame statistics.

Constructor & Destructor Documentation

◆ Graphic3d_FrameStats()

Graphic3d_FrameStats::Graphic3d_FrameStats ( )

Default constructor.

◆ ~Graphic3d_FrameStats()

virtual Graphic3d_FrameStats::~Graphic3d_FrameStats ( )

virtual

Destructor.

Member Function Documentation

◆ ActiveDataFrame()

Graphic3d_FrameStatsDataTmp & Graphic3d_FrameStats::ActiveDataFrame ( )

inline

Returns currently filling data frame for modification, should be called between FrameStart() and FrameEnd() calls.

◆ ChangeCounter()

Standard_Size & Graphic3d_FrameStats::ChangeCounter ( Graphic3d_FrameStatsCounter theCounter )

inline

Returns value of specified counter for modification, should be called between FrameStart() and FrameEnd() calls.

◆ ChangeDataFrames()

NCollection_Array1< Graphic3d_FrameStatsData > & Graphic3d_FrameStats::ChangeDataFrames ( )

inline

Returns data frames.

◆ ChangeTimer()

Standard_Real & Graphic3d_FrameStats::ChangeTimer ( Graphic3d_FrameStatsTimer theTimer )

inline

Returns value of specified timer for modification, should be called between FrameStart() and FrameEnd() calls.

◆ CounterValue()

Standard_Size Graphic3d_FrameStats::CounterValue ( Graphic3d_FrameStatsCounter theCounter ) const

inline

Returns value of specified counter, cached between stats updates. Should NOT be called between FrameStart() and FrameEnd() calls.

◆ DataFrames()

const NCollection_Array1< Graphic3d_FrameStatsData > & Graphic3d_FrameStats::DataFrames ( ) const

inline

Returns data frames.

◆ FormatStats() [1/2]

virtual TCollection_AsciiString Graphic3d_FrameStats::FormatStats ( Graphic3d_RenderingParams::PerfCounters theFlags ) const

virtual

Returns formatted string.

◆ FormatStats() [2/2]

virtual void Graphic3d_FrameStats::FormatStats	(	TColStd_IndexedDataMapOfStringString &	theDict,
		Graphic3d_RenderingParams::PerfCounters	theFlags
	)		const

virtual

Fill in the dictionary with formatted statistic info.

◆ FrameDuration()

Standard_Real Graphic3d_FrameStats::FrameDuration ( ) const

inline

Returns duration of the last frame in seconds.

◆ FrameEnd()

virtual void Graphic3d_FrameStats::FrameEnd	(	const Handle< Graphic3d_CView > &	theView,
		bool	theIsImmediateOnly
	)

virtual

Frame redraw finished.

◆ FrameRate()

Standard_Real Graphic3d_FrameStats::FrameRate ( ) const

inline

Returns FPS (frames per seconds, elapsed time). This number indicates an actual frame rate averaged for several frames within UpdateInterval() duration, basing on a real elapsed time between updates.

◆ FrameRateCpu()

Standard_Real Graphic3d_FrameStats::FrameRateCpu ( ) const

inline

Returns CPU FPS (frames per seconds, CPU time). This number indicates a PREDICTED frame rate, basing on CPU elapsed time between updates and NOT real elapsed time (which might include periods of CPU inactivity). Number is expected to be greater then actual frame rate returned by FrameRate(). Values significantly greater actual frame rate indicate that rendering is limited by GPU performance (CPU is stalled in-between), while values around actual frame rate indicate rendering being limited by CPU performance (GPU is stalled in-between).

◆ FrameStart()

virtual void Graphic3d_FrameStats::FrameStart	(	const Handle< Graphic3d_CView > &	theView,
		bool	theIsImmediateOnly
	)

virtual

Frame redraw started.

◆ HasCulledLayers()

Standard_Boolean Graphic3d_FrameStats::HasCulledLayers ( ) const

inline

Returns TRUE if some Layers have been culled.

◆ HasCulledStructs()

Standard_Boolean Graphic3d_FrameStats::HasCulledStructs ( ) const

inline

Returns TRUE if some structures have been culled.

◆ IsLongLineFormat()

Standard_Boolean Graphic3d_FrameStats::IsLongLineFormat ( ) const

inline

Prefer longer lines over more greater of lines.

◆ LastDataFrame()

const Graphic3d_FrameStatsData & Graphic3d_FrameStats::LastDataFrame ( ) const

inline

Returns last data frame, cached between stats updates. Should NOT be called between FrameStart() and FrameEnd() calls.

◆ LastDataFrameIndex()

Standard_Integer Graphic3d_FrameStats::LastDataFrameIndex ( ) const

inline

Returns last data frame index.

◆ SetLongLineFormat()

void Graphic3d_FrameStats::SetLongLineFormat ( Standard_Boolean theValue )

inline

Set if format should prefer longer lines over greater number of lines.

◆ SetUpdateInterval()

void Graphic3d_FrameStats::SetUpdateInterval ( Standard_Real theInterval )

inline

Sets interval in seconds for updating values.

◆ TimerValue()

Standard_Real Graphic3d_FrameStats::TimerValue ( Graphic3d_FrameStatsTimer theTimer ) const

inline

Returns value of specified timer for modification, should be called between FrameStart() and FrameEnd() calls. Should NOT be called between FrameStart() and FrameEnd() calls.

◆ UpdateInterval()

Standard_Real Graphic3d_FrameStats::UpdateInterval ( ) const

inline

Returns interval in seconds for updating meters across several frames; 1 second by default.

◆ updateStatistics()

virtual void Graphic3d_FrameStats::updateStatistics	(	const Handle< Graphic3d_CView > &	theView,
		bool	theIsImmediateOnly
	)

protectedpure virtual

Method to collect statistics from the View; called by FrameEnd().

Implemented in OpenGl_FrameStats.

Field Documentation

◆ myCounters

NCollection_Array1<Graphic3d_FrameStatsData> Graphic3d_FrameStats::myCounters

protected

data frames history

◆ myCountersMax

Graphic3d_FrameStatsData Graphic3d_FrameStats::myCountersMax

protected

data frame values with absolute maximum values in the history

◆ myCountersTmp

Graphic3d_FrameStatsDataTmp Graphic3d_FrameStats::myCountersTmp

protected

data frame values filled to be filled between FrameStart() and FrameEnd() calls

◆ myFpsFrameCount

Standard_Size Graphic3d_FrameStats::myFpsFrameCount

protected

FPS counter (within short measurement time slice)

◆ myFpsTimer

OSD_Timer Graphic3d_FrameStats::myFpsTimer

protected

timer for FPS measurements

◆ myFrameDuration

Standard_Real Graphic3d_FrameStats::myFrameDuration

protected

frame duration

◆ myFrameStartTime

Standard_Real Graphic3d_FrameStats::myFrameStartTime

protected

time at the beginning of frame redraw

◆ myIsLongLineFormat

Standard_Boolean Graphic3d_FrameStats::myIsLongLineFormat

protected

prefer longer lines over greater number of lines

◆ myLastFrameIndex

Standard_Integer Graphic3d_FrameStats::myLastFrameIndex

protected

last data frame index

◆ myUpdateInterval

Standard_Real Graphic3d_FrameStats::myUpdateInterval

protected

interval to update meters

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

Graphic3d_FrameStats.hxx

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Graphic3d_FrameStats()

◆ ~Graphic3d_FrameStats()

Member Function Documentation

◆ ActiveDataFrame()

◆ ChangeCounter()

◆ ChangeDataFrames()

◆ ChangeTimer()

◆ CounterValue()

◆ DataFrames()

◆ FormatStats() [1/2]

◆ FormatStats() [2/2]

◆ FrameDuration()

◆ FrameEnd()

◆ FrameRate()

◆ FrameRateCpu()

◆ FrameStart()

◆ HasCulledLayers()

◆ HasCulledStructs()

◆ IsLongLineFormat()

◆ LastDataFrame()

◆ LastDataFrameIndex()

◆ SetLongLineFormat()

◆ SetUpdateInterval()

◆ TimerValue()

◆ UpdateInterval()

◆ updateStatistics()

Field Documentation

◆ myCounters

◆ myCountersMax

◆ myCountersTmp

◆ myFpsFrameCount

◆ myFpsTimer

◆ myFrameDuration

◆ myFrameStartTime

◆ myIsLongLineFormat

◆ myLastFrameIndex

◆ myUpdateInterval