Open CASCADE Technology  7.4.1.dev
Public Member Functions | Protected Attributes
Graphic3d_FrameStatsData Class Reference

Data frame definition. More...

#include <Graphic3d_FrameStatsData.hxx>

Inheritance diagram for Graphic3d_FrameStatsData:
Inheritance graph
[legend]

Public Member Functions

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. More...
 
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). More...
 
Standard_Real ImmediateFrameRate () const
 Returns FPS for immediate redraws. More...
 
Standard_Real ImmediateFrameRateCpu () const
 Returns CPU FPS for immediate redraws. More...
 
Standard_Size CounterValue (Graphic3d_FrameStatsCounter theIndex) const
 Get counter value. More...
 
Standard_Size operator[] (Graphic3d_FrameStatsCounter theIndex) const
 Get counter value. More...
 
Standard_Real TimerValue (Graphic3d_FrameStatsTimer theIndex) const
 Get timer value. More...
 
Standard_Real operator[] (Graphic3d_FrameStatsTimer theIndex) const
 Get timer value. More...
 
 Graphic3d_FrameStatsData ()
 Empty constructor. More...
 
Graphic3d_FrameStatsDataoperator= (const Graphic3d_FrameStatsData &theOther)
 Assignment operator. More...
 
void Reset ()
 Reset data. More...
 
void FillMax (const Graphic3d_FrameStatsData &theOther)
 Fill with maximum values. More...
 

Protected Attributes

std::vector< Standard_SizemyCounters
 counters More...
 
std::vector< Standard_RealmyTimers
 timers More...
 
std::vector< Standard_RealmyTimersMin
 minimal values of timers More...
 
std::vector< Standard_RealmyTimersMax
 maximum values of timers More...
 
Standard_Real myFps
 FPS meter (frames per seconds, elapsed time) More...
 
Standard_Real myFpsCpu
 CPU FPS meter (frames per seconds, CPU time) More...
 
Standard_Real myFpsImmediate
 FPS meter for immediate redraws. More...
 
Standard_Real myFpsCpuImmediate
 CPU FPS meter for immediate redraws. More...
 

Detailed Description

Data frame definition.

Constructor & Destructor Documentation

◆ Graphic3d_FrameStatsData()

Graphic3d_FrameStatsData::Graphic3d_FrameStatsData ( )

Empty constructor.

Member Function Documentation

◆ CounterValue()

Standard_Size 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()

Standard_Real 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()

Standard_Real 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()

Standard_Real Graphic3d_FrameStatsData::ImmediateFrameRate ( ) const
inline

Returns FPS for immediate redraws.

◆ ImmediateFrameRateCpu()

Standard_Real Graphic3d_FrameStatsData::ImmediateFrameRateCpu ( ) const
inline

Returns CPU FPS for immediate redraws.

◆ operator=()

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

Assignment operator.

◆ operator[]() [1/2]

Standard_Size Graphic3d_FrameStatsData::operator[] ( Graphic3d_FrameStatsCounter  theIndex) const
inline

Get counter value.

◆ operator[]() [2/2]

Standard_Real Graphic3d_FrameStatsData::operator[] ( Graphic3d_FrameStatsTimer  theIndex) const
inline

Get timer value.

◆ Reset()

void Graphic3d_FrameStatsData::Reset ( )

Reset data.

◆ TimerValue()

Standard_Real Graphic3d_FrameStatsData::TimerValue ( Graphic3d_FrameStatsTimer  theIndex) const
inline

Get timer value.

Field Documentation

◆ myCounters

std::vector<Standard_Size> Graphic3d_FrameStatsData::myCounters
protected

counters

◆ myFps

Standard_Real Graphic3d_FrameStatsData::myFps
protected

FPS meter (frames per seconds, elapsed time)

◆ myFpsCpu

Standard_Real Graphic3d_FrameStatsData::myFpsCpu
protected

CPU FPS meter (frames per seconds, CPU time)

◆ myFpsCpuImmediate

Standard_Real Graphic3d_FrameStatsData::myFpsCpuImmediate
protected

CPU FPS meter for immediate redraws.

◆ myFpsImmediate

Standard_Real Graphic3d_FrameStatsData::myFpsImmediate
protected

FPS meter for immediate redraws.

◆ myTimers

std::vector<Standard_Real> Graphic3d_FrameStatsData::myTimers
protected

timers

◆ myTimersMax

std::vector<Standard_Real> Graphic3d_FrameStatsData::myTimersMax
protected

maximum values of timers

◆ myTimersMin

std::vector<Standard_Real> Graphic3d_FrameStatsData::myTimersMin
protected

minimal values of timers


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