---

MeProfile.h File Reference

Public profiling API. More...

#include "MePrecision.h"

Go to the source code of this file.

Compounds
struct	_MeProfileOutput
struct	MeProfileTimerMode
Typedefs
typedef struct _MeProfileOutput	MeProfileOutput
	Output style parameters. More...
Enumerations
enum	MeProfileOutput_enum {   kMeProfileOutputAverage,   kMeProfileOutputNormal,   kMeProfileOutputGnuplot }
	Profiling output styles. More...
enum	MeProfileCounterModes_enum {   kMeProfileCounterModeFlops,   kMeProfileCounterModeCache }
	Counter modes. More...
Functions
void	MeProfileStartTiming (MeProfileTimerMode mode)
	Initialises profiling. More...
void	MeProfileStopTiming ()
	Cleans up profiling. More...
void	MeProfileStartFrame ()
	Indicates where in the code a frame is said to have started. More...
void	MeProfileEndFrame ()
	Indicates that the end of a frame has been reached. More...
void	MeProfileStartSection (const char* codeSection, unsigned char autoStop)
	Start timing a section of code. More...
void	MeProfileEndSection (const char* codeSection)
	Explicitly stops timing the specified section of code. More...
void	MeProfileStopTimers ()
	Can be called just before the end of a frame to make sure all timers are stopped. More...
void	MeProfileOutputResults ()
	Output profile results in the currently selected style. More...
void	MeProfileSetOutputParameters (MeProfileOutput output)
	Sets the ouput mode for profiling information. More...

---

Detailed Description

Public profiling API.

---

Typedef Documentation

typedef struct _MeProfileOutput MeProfileOutput

Output style parameters.

---

Enumeration Type Documentation

enum MeProfileCounterModes_enum

Counter modes.

These are only relevant for PS2

Enumeration values:

kMeProfileCounterModeFlops	Counts floating point operations.
kMeProfileCounterModeCache	Counts cache misses.

enum MeProfileOutput_enum

Profiling output styles.

Enumeration values:

kMeProfileOutputAverage	A compact average display (default).
kMeProfileOutputNormal	Lists everything sequentially.
kMeProfileOutputGnuplot	Produces several files in Gnuplot format.

---

Function Documentation

void MeProfileEndFrame ( )

Indicates that the end of a frame has been reached.

void MeProfileEndSection ( const char * cs )

Explicitly stops timing the specified section of code.

You should not call this if you set autostop to 1 in MeProfileStartSection().

void MeProfileOutputResults ( )

Output profile results in the currently selected style.

void MeProfileSetOutputParameters ( MeProfileOutput output )

Sets the ouput mode for profiling information.

void MeProfileStartFrame ( )

Indicates where in the code a frame is said to have started.

void MeProfileStartSection ( const char * codeSection, unsigned char autoStop )

Start timing a section of code.

Parameters:

codeSection	Name of the section to be timed
autoStop	If 1 then the timing of this section of code will stop automatically at the next call to MeProfileStartSection(). If 0 then an explicit call to MeProfileEndSection() will have to be made. This allows for concurrent sections of timed code.

void MeProfileStartTiming ( MeProfileTimerMode mode )

Initialises profiling.

void MeProfileStopTimers ( )

Can be called just before the end of a frame to make sure all timers are stopped.

void MeProfileStopTiming ( )

Cleans up profiling.

---