Fps Class Reference

#include <fps.h>

List of all members.

Public Member Functions
void	init (unsigned int atime)
	initialization, sets starting values
void	onFrameRendered (void)
	handler of event, that occurs at the end of each frame render
bool	update (unsigned int atime)
	updates fps count
unsigned int	getTreshold (void)
	gets treshold value (in ms) of update
void	setTreshold (unsigned int treshold_ms)
	sets treshold value (in millisec) of update
unsigned int	get (void)
	gets fps ratio
Static Public Attributes
static const unsigned int	DEFAULT_FPS_UPDATE_THRESHOLD = 100
	update fps every every [n] ms
Private Attributes
unsigned int	mFramesRendered
	the number of frames rendered since init()
unsigned int	mTimeStamp
	last time-stamp (number of ticks) of computing the FPS
unsigned int	mFrameStamp
	last frame-stamp (number of ticks) of computing the FPS
unsigned int	mUpdateTimeTreshold
	minimal number of ticks between fps-update.
float	mFps
	the number of frames per second

---

Detailed Description

Definition at line 7 of file fps.h.

---

Member Function Documentation

unsigned int Fps::get (  void   )  [inline]

gets fps ratio Returns: fps ratio Definition at line 76 of file fps.h. References mFps. Referenced by GFX::getFps().

unsigned int Fps::getTreshold (  void   )  [inline]

gets treshold value (in ms) of update Returns: treshold value (in ms) of update Definition at line 62 of file fps.h. References mUpdateTimeTreshold. Referenced by update().

void Fps::init (  unsigned int  atime  )  [inline]

initialization, sets starting values Parameters: atime  absolute time of measurement start Definition at line 14 of file fps.h. References DEFAULT_FPS_UPDATE_THRESHOLD, mFps, mFramesRendered, mFrameStamp, mTimeStamp, and mUpdateTimeTreshold. Referenced by GFX::resetFps().

void Fps::onFrameRendered (  void   )  [inline]

handler of event, that occurs at the end of each frame render Definition at line 24 of file fps.h. References mFramesRendered. Referenced by GFX::swap_buffers().

void Fps::setTreshold (  unsigned int  treshold_ms  )  [inline]

sets treshold value (in millisec) of update Parameters: treshold_ms  value (in millisec) of treshold update Definition at line 69 of file fps.h. References mUpdateTimeTreshold.

bool Fps::update (  unsigned int  atime  )  [inline]

updates fps count Parameters: atime  absolute time of measurement update Returns: true, if fps count was updated (depends on treshold value) Note: Watches overflow. If time overflew, it skips one period. If frames overflew, it returns the old fps count. Definition at line 34 of file fps.h. References getTreshold(), mFps, mFramesRendered, mFrameStamp, and mTimeStamp. Referenced by GFX::swap_buffers(). Here is the call graph for this function:

---

Member Data Documentation

const unsigned int Fps::DEFAULT_FPS_UPDATE_THRESHOLD = 100 [static]

update fps every every [n] ms Definition at line 87 of file fps.h. Referenced by init().

float Fps::mFps [private]

the number of frames per second Definition at line 84 of file fps.h. Referenced by get(), init(), and update().

unsigned int Fps::mFramesRendered [private]

the number of frames rendered since init() Definition at line 80 of file fps.h. Referenced by init(), onFrameRendered(), and update().

unsigned int Fps::mFrameStamp [private]

last frame-stamp (number of ticks) of computing the FPS Definition at line 82 of file fps.h. Referenced by init(), and update().

unsigned int Fps::mTimeStamp [private]

last time-stamp (number of ticks) of computing the FPS Definition at line 81 of file fps.h. Referenced by init(), and update().

unsigned int Fps::mUpdateTimeTreshold [private]

minimal number of ticks between fps-update. Definition at line 83 of file fps.h. Referenced by getTreshold(), init(), and setTreshold().

---

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

• fps.h

---