Instrument Neutral Distributed Interface INDI  2.0.2
Public Member Functions | List of all members
INDI::FPSMeter Class Reference

#include <fpsmeter.h>

Public Member Functions

 FPSMeter (double timeWindow=1000)
 
void reset ()
 Reset all frame information. More...
 
bool newFrame ()
 When you get a frame, call the function to count. More...
 
void setTimeWindow (double timeWindow)
 Time window setup. More...
 
double framesPerSecond () const
 Number of frames per second counted in the time window. More...
 
double deltaTime () const
 Time in milliseconds between last frames. More...
 
uint64_t totalFrames () const
 Total frames. More...
 
double totalTime () const
 Total time. More...
 

Detailed Description

Definition at line 27 of file fpsmeter.h.

Constructor & Destructor Documentation

◆ FPSMeter()

INDI::FPSMeter::FPSMeter ( double  timeWindow = 1000)

Definition at line 25 of file fpsmeter.cpp.

Member Function Documentation

◆ deltaTime()

double INDI::FPSMeter::deltaTime ( ) const

Time in milliseconds between last frames.

Definition at line 65 of file fpsmeter.cpp.

◆ framesPerSecond()

double INDI::FPSMeter::framesPerSecond ( ) const

Number of frames per second counted in the time window.

Definition at line 60 of file fpsmeter.cpp.

◆ newFrame()

bool INDI::FPSMeter::newFrame ( )

When you get a frame, call the function to count.

Returns
returns true if the time window has been reached

Definition at line 31 of file fpsmeter.cpp.

◆ reset()

void INDI::FPSMeter::reset ( )

Reset all frame information.

Definition at line 80 of file fpsmeter.cpp.

◆ setTimeWindow()

void INDI::FPSMeter::setTimeWindow ( double  timeWindow)

Time window setup.

Parameters
timeWindowTime window in milliseconds over which the frames are counted

Definition at line 55 of file fpsmeter.cpp.

◆ totalFrames()

uint64_t INDI::FPSMeter::totalFrames ( ) const

Total frames.

Returns
Number of frames counted

Definition at line 70 of file fpsmeter.cpp.

◆ totalTime()

double INDI::FPSMeter::totalTime ( ) const

Total time.

Returns
Total time of counted frames

Definition at line 75 of file fpsmeter.cpp.


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