Graphic3d_FrameStatsData Class Reference

Data frame definition. More...

#include <Graphic3d_FrameStatsData.hxx>

Inheritance diagram for Graphic3d_FrameStatsData:

Public Member Functions
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< 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

Data frame definition.

Constructor & Destructor Documentation

Graphic3d_FrameStatsData() [1/3]

Graphic3d_FrameStatsData::Graphic3d_FrameStatsData

(

)

Empty constructor.

Graphic3d_FrameStatsData() [2/3]

Graphic3d_FrameStatsData::Graphic3d_FrameStatsData

(

const Graphic3d_FrameStatsData &

theOther

)

Copy constructor.

Graphic3d_FrameStatsData() [3/3]

Graphic3d_FrameStatsData::Graphic3d_FrameStatsData ( Graphic3d_FrameStatsData && theOther )

noexcept

Move constructor.

Member Function Documentation

CounterValue()

size_t Graphic3d_FrameStatsData::CounterValue ( Graphic3d_FrameStatsCounter theIndex ) const

inline

Get counter value.

FillMax()

void Graphic3d_FrameStatsData::FillMax

(

const Graphic3d_FrameStatsData &

theOther

)

Fill with maximum values.

FrameRate()

double Graphic3d_FrameStatsData::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()

double Graphic3d_FrameStatsData::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).

ImmediateFrameRate()

double Graphic3d_FrameStatsData::ImmediateFrameRate ( ) const

inline

Returns FPS for immediate redraws.

ImmediateFrameRateCpu()

double Graphic3d_FrameStatsData::ImmediateFrameRateCpu ( ) const

inline

Returns CPU FPS for immediate redraws.

operator=() [1/2]

Graphic3d_FrameStatsData & Graphic3d_FrameStatsData::operator=

(

const Graphic3d_FrameStatsData &

theOther

)

Assignment operator.

operator=() [2/2]

Graphic3d_FrameStatsData & Graphic3d_FrameStatsData::operator= ( Graphic3d_FrameStatsData && theOther )

noexcept

Assignment with move operator.

operator[]() [1/2]

size_t Graphic3d_FrameStatsData::operator[] ( Graphic3d_FrameStatsCounter theIndex ) const

inline

Get counter value.

operator[]() [2/2]

double Graphic3d_FrameStatsData::operator[] ( Graphic3d_FrameStatsTimer theIndex ) const

inline

Get timer value.

Reset()

void Graphic3d_FrameStatsData::Reset

(

)

Reset data.

TimerValue()

double Graphic3d_FrameStatsData::TimerValue ( Graphic3d_FrameStatsTimer theIndex ) const

inline

Get timer value.

Field Documentation

myCounters

NCollection_LinearVector<size_t> Graphic3d_FrameStatsData::myCounters

protected

counters

myFps

double Graphic3d_FrameStatsData::myFps

protected

FPS meter (frames per seconds, elapsed time)

myFpsCpu

double Graphic3d_FrameStatsData::myFpsCpu

protected

CPU FPS meter (frames per seconds, CPU time)

myFpsCpuImmediate

double Graphic3d_FrameStatsData::myFpsCpuImmediate

protected

CPU FPS meter for immediate redraws.

myFpsImmediate

double Graphic3d_FrameStatsData::myFpsImmediate

protected

FPS meter for immediate redraws.

myTimers

NCollection_LinearVector<double> Graphic3d_FrameStatsData::myTimers

protected

timers

myTimersMax

NCollection_LinearVector<double> Graphic3d_FrameStatsData::myTimersMax

protected

maximum values of timers

myTimersMin

NCollection_LinearVector<double> Graphic3d_FrameStatsData::myTimersMin

protected

minimal values of timers

---

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

• Graphic3d_FrameStatsData.hxx