OGRE-Next  4.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::FrameStats Class Reference

All returned values are either in seconds or frames per second. More...

#include <OgreFrameStats.h>

+ Inheritance diagram for Ogre::FrameStats:

Public Member Functions

 FrameStats ()
 
void addSample (const uint64 timeUs)
 Adds a new measured time, in microseconds More...
 
double getAllTimeAverage () const
 Returns the average since the last reset(). More...
 
double getAllTimeAverageFps () const
 Same as getAllTimeAverage(), but expressed as frames per second instead of seconds. More...
 
double getBestTime () const
 Returns the best frame time in seconds since the last reset(). More...
 
uint64 getLastTimeRawMicroseconds () const
 
double getLatestTimeSinceLast () const
 Returns latest record of the time since last measurement. More...
 
double getLatestTimeSinceLastFps () const
 Same as getLatestTimeSinceLast() but expressed as frames per second instead of seconds. More...
 
double getPercentile95th (bool bUseTime) const
 Gets the 95th percentile, since the last reset(). More...
 
double getPercentile99th (bool bUseTime) const
 Gets the 99th percentile, since the last reset. See getPercentile95th(). More...
 
double getPercentileNth (double percentile, bool bUseTime) const
 Gets the desired percentile, since the last reset. More...
 
double getRollingAverage () const
 Returns the rolling average. More...
 
double getRollingAverageFps () const
 Same as getRollingAverage(), but expressed as frames per second instead of seconds. More...
 
double getWorstTime () const
 Returns the worst frame time in seconds since the last reset(). More...
 
 OGRE_DEPRECATED_VER (4) double getLastTime() const
 
 OGRE_DEPRECATED_VER (4) float getAvgFps() const
 
 OGRE_DEPRECATED_VER (4) float getAvgTime() const
 
 OGRE_DEPRECATED_VER (4) float getFps() const
 
void reset (uint64 timeUs)
 

Detailed Description

All returned values are either in seconds or frames per second.

Member Function Documentation

◆ OGRE_DEPRECATED_VER() [1/3]

Ogre::FrameStats::OGRE_DEPRECATED_VER ( ) const
inline
Deprecated:
since 4.0 in favour of getLatestTimeSinceLast().

◆ OGRE_DEPRECATED_VER() [2/3]

Ogre::FrameStats::OGRE_DEPRECATED_VER ( ) const
inline
Deprecated:
since 4.0 in favour of getRollingAverageFps().

◆ OGRE_DEPRECATED_VER() [3/3]

Ogre::FrameStats::OGRE_DEPRECATED_VER ( ) const
inline
Deprecated:
since 4.0 in favour of getRollingAverage().

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