CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iPerfStats Struct Reference

The performance and statistics plugin. More...

#include <perfstat.h>

Inheritance diagram for iPerfStats:

iBase List of all members.

Public Methods

virtual bool Pause (bool pause)=0
 Set whether paused. Returns previous status. More...

virtual void ResetStats ()=0
 Reset all statistics back to zero. More...

virtual void SetResolution (int iMilSecs)=0
 The frames per second is really the resolution number of frames divided by the time taken to complete them. More...

virtual void SetName (const char *Name)=0
 Set the name of this section, which will be utilised if the stats are printed to file. More...

virtual void SetOutputFile (const char *Name, bool summary)=0
 Output stats to named file. If summary is true, you'll get a summary. More...

virtual float GetFPS ()=0
 Get the current fps. More...

virtual iPerfStats * StartNewSubsection (const char *name)=0
 Start a new set of performance statistics as a subsection, with an optional name. More...

virtual void FinishSubsection ()=0
 Finish the subsection. This will DecRef () the subsection. More...

virtual bool IsSubsection ()=0
 Is there currently a subsection? More...

virtual void PrintSectionStats (int sysflags)=0
 Print this sections current summary stats, where sysflags is for the reporter. More...

virtual void PrintSubsectionStats (int sysflags)=0
 Print the subsections current stats, where sysflags is for the reporter. More...

virtual void DebugSetBreak (int frame_num)=0
 When ran with a debugger, this should cause it to break when starting this frame number, if compiled without CS_DEBUG it will have no effect. More...


Detailed Description

The performance and statistics plugin.

This plugin tracks and records all kinds of useful information while the program is running.

Definition at line 31 of file perfstat.h.


Member Function Documentation

virtual void iPerfStats::DebugSetBreak int    frame_num [pure virtual]
 

When ran with a debugger, this should cause it to break when starting this frame number, if compiled without CS_DEBUG it will have no effect.

If you load this plugin last (like in walktest) then set frame_num to one less.

virtual void iPerfStats::FinishSubsection   [pure virtual]
 

Finish the subsection. This will DecRef () the subsection.

virtual float iPerfStats::GetFPS   [pure virtual]
 

Get the current fps.

virtual bool iPerfStats::IsSubsection   [pure virtual]
 

Is there currently a subsection?

virtual bool iPerfStats::Pause bool    pause [pure virtual]
 

Set whether paused. Returns previous status.

virtual void iPerfStats::PrintSectionStats int    sysflags [pure virtual]
 

Print this sections current summary stats, where sysflags is for the reporter.

virtual void iPerfStats::PrintSubsectionStats int    sysflags [pure virtual]
 

Print the subsections current stats, where sysflags is for the reporter.

virtual void iPerfStats::ResetStats   [pure virtual]
 

Reset all statistics back to zero.

virtual void iPerfStats::SetName const char *    Name [pure virtual]
 

Set the name of this section, which will be utilised if the stats are printed to file.

virtual void iPerfStats::SetOutputFile const char *    Name,
bool    summary
[pure virtual]
 

Output stats to named file. If summary is true, you'll get a summary.

virtual void iPerfStats::SetResolution int    iMilSecs [pure virtual]
 

The frames per second is really the resolution number of frames divided by the time taken to complete them.

Set to -1 to disable (the default). The resolution is the time interval in milliseconds in which a frames-per-second value is computed.

virtual iPerfStats* iPerfStats::StartNewSubsection const char *    name [pure virtual]
 

Start a new set of performance statistics as a subsection, with an optional name.

If you intend to print all the stats to file then this name will identify the subsection.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14