Graphic3d_FrameStatsDataTmp Class Reference

Temporary data frame definition. More...

#include <Graphic3d_FrameStatsData.hxx>

Inheritance diagram for Graphic3d_FrameStatsDataTmp:

Public Member Functions
	Graphic3d_FrameStatsDataTmp ()
	Empty constructor.
void	FlushTimers (size_t theNbFrames, bool theIsFinal)
	Compute average data considering the amount of rendered frames.
void	Reset ()
	Reset data.
void	operator= (const Graphic3d_FrameStatsData &theOther)
	Assignment operator (skip copying irrelevant properties).
double &	ChangeFrameRate ()
	Returns FPS (frames per seconds, elapsed time).
double &	ChangeFrameRateCpu ()
	Returns CPU FPS (frames per seconds, CPU time).
double &	ChangeImmediateFrameRate ()
	Returns FPS for immediate redraws.
double &	ChangeImmediateFrameRateCpu ()
	Returns CPU FPS for immediate redraws.
OSD_Timer &	ChangeTimer (Graphic3d_FrameStatsTimer theTimer)
	Return a timer object for time measurements.
size_t &	ChangeCounterValue (Graphic3d_FrameStatsCounter theIndex)
	Get counter value.
size_t &	operator[] (Graphic3d_FrameStatsCounter theIndex)
	Modify counter value.
double &	ChangeTimerValue (Graphic3d_FrameStatsTimer theIndex)
	Modify timer value.
double &	operator[] (Graphic3d_FrameStatsTimer theIndex)
	Modify timer value.
Public Member Functions inherited from Graphic3d_FrameStatsData
double	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.
double	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).
double	ImmediateFrameRate () const
	Returns FPS for immediate redraws.
double	ImmediateFrameRateCpu () const
	Returns CPU FPS for immediate redraws.
size_t	CounterValue (Graphic3d_FrameStatsCounter theIndex) const
	Get counter value.
size_t	operator[] (Graphic3d_FrameStatsCounter theIndex) const
	Get counter value.
double	TimerValue (Graphic3d_FrameStatsTimer theIndex) const
	Get timer value.
double	operator[] (Graphic3d_FrameStatsTimer theIndex) const
	Get timer value.
	Graphic3d_FrameStatsData ()
	Empty constructor.
	Graphic3d_FrameStatsData (const Graphic3d_FrameStatsData &theOther)
	Copy constructor.
	Graphic3d_FrameStatsData (Graphic3d_FrameStatsData &&theOther) noexcept
	Move constructor.
Graphic3d_FrameStatsData &	operator= (const Graphic3d_FrameStatsData &theOther)
	Assignment operator.
Graphic3d_FrameStatsData &	operator= (Graphic3d_FrameStatsData &&theOther) noexcept
	Assignment with move operator.
void	Reset ()
	Reset data.
void	FillMax (const Graphic3d_FrameStatsData &theOther)
	Fill with maximum values.

Protected Attributes
NCollection_LinearVector< OSD_Timer >	myOsdTimers
	precise timers for time measurements
NCollection_LinearVector< double >	myTimersPrev
	previous timers values
Protected Attributes inherited from Graphic3d_FrameStatsData
NCollection_LinearVector< size_t >	myCounters
	counters
NCollection_LinearVector< double >	myTimers
	timers
NCollection_LinearVector< double >	myTimersMin
	minimal values of timers
NCollection_LinearVector< double >	myTimersMax
	maximum values of timers
double	myFps
	FPS meter (frames per seconds, elapsed time)
double	myFpsCpu
	CPU FPS meter (frames per seconds, CPU time)
double	myFpsImmediate
	FPS meter for immediate redraws.
double	myFpsCpuImmediate
	CPU FPS meter for immediate redraws.

Detailed Description

Temporary data frame definition.

Constructor & Destructor Documentation

Graphic3d_FrameStatsDataTmp()

Graphic3d_FrameStatsDataTmp::Graphic3d_FrameStatsDataTmp

(

)

Empty constructor.

Member Function Documentation

ChangeCounterValue()

size_t & Graphic3d_FrameStatsDataTmp::ChangeCounterValue ( Graphic3d_FrameStatsCounter theIndex )

inline

Get counter value.

ChangeFrameRate()

double & Graphic3d_FrameStatsDataTmp::ChangeFrameRate ( )

inline

Returns FPS (frames per seconds, elapsed time).

ChangeFrameRateCpu()

double & Graphic3d_FrameStatsDataTmp::ChangeFrameRateCpu ( )

inline

Returns CPU FPS (frames per seconds, CPU time).

ChangeImmediateFrameRate()

double & Graphic3d_FrameStatsDataTmp::ChangeImmediateFrameRate ( )

inline

Returns FPS for immediate redraws.

ChangeImmediateFrameRateCpu()

double & Graphic3d_FrameStatsDataTmp::ChangeImmediateFrameRateCpu ( )

inline

Returns CPU FPS for immediate redraws.

ChangeTimer()

OSD_Timer & Graphic3d_FrameStatsDataTmp::ChangeTimer ( Graphic3d_FrameStatsTimer theTimer )

inline

Return a timer object for time measurements.

ChangeTimerValue()

double & Graphic3d_FrameStatsDataTmp::ChangeTimerValue ( Graphic3d_FrameStatsTimer theIndex )

inline

Modify timer value.

FlushTimers()

void Graphic3d_FrameStatsDataTmp::FlushTimers	(	size_t	theNbFrames,
		bool	theIsFinal )

Compute average data considering the amount of rendered frames.

operator=()

void Graphic3d_FrameStatsDataTmp::operator= ( const Graphic3d_FrameStatsData & theOther )

inline

Assignment operator (skip copying irrelevant properties).

operator[]() [1/2]

size_t & Graphic3d_FrameStatsDataTmp::operator[] ( Graphic3d_FrameStatsCounter theIndex )

inline

Modify counter value.

operator[]() [2/2]

double & Graphic3d_FrameStatsDataTmp::operator[] ( Graphic3d_FrameStatsTimer theIndex )

inline

Modify timer value.

Reset()

void Graphic3d_FrameStatsDataTmp::Reset

(

)

Reset data.

Field Documentation

myOsdTimers

NCollection_LinearVector<OSD_Timer> Graphic3d_FrameStatsDataTmp::myOsdTimers

protected

precise timers for time measurements

myTimersPrev

NCollection_LinearVector<double> Graphic3d_FrameStatsDataTmp::myTimersPrev

protected

previous timers values

---

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

• Graphic3d_FrameStatsData.hxx