---

MeProfile.h

Go to the documentation of this file.

#ifndef MEPROFILE_H
#define MEPROFILE_H

/*
  Copyright MathEngine PLC 1999

  $Name$

  $Id$
*/

/** @file
 * Public profiling API
 */

/** @mainpage
 *
 * @section overview Overview
 *
 * This library provides a variety of useful services:
 * 
 * @arg Math helper functions.
 * @arg Profiling support.
 * @arg Simple cross platform file handling.
 * @arg Cross platform precision-related definitions.
 *
 */
#include "MePrecision.h"

#ifdef __cplusplus
extern "C" {
#endif

/** Profiling output styles */
typedef enum {
  kMeProfileOutputAverage, /**< A compact average display (default) */
  kMeProfileOutputNormal,  /**< Lists everything sequentially */
  kMeProfileOutputGnuplot, /**< Produces several files in Gnuplot format */
} MeProfileOutput_enum;

typedef struct _MeProfileTimerResult {
    MeI64 cpuCycles;
    MeI64 count0;
    MeI64 count1;
} MeProfileTimerResult;

/** Counter modes. These are only relevant for PS2 */
typedef enum {
    /** Counts floating point operations */
    kMeProfileCounterModeFlops,
    /** Counts cache misses */
    kMeProfileCounterModeCache
} MeProfileCounterModes_enum;

/** Timer mode. These settings are only relevant for PS2 */
typedef struct {
    unsigned char granularity;  /**< Granularity */
    MeProfileCounterModes_enum counterMode;   /**< Counter mode */
} MeProfileTimerMode;

/** Output style parameters */
typedef struct _MeProfileOutput {
    MeProfileOutput_enum style; /**< Output style */
    float jaggedness;           /**< For gnuplot */
    unsigned char settletime;   /**< For gnuplot */
} MeProfileOutput;


/** Initialises profiling */
void MeProfileStartTiming(MeProfileTimerMode mode);

/** Cleans up profiling */
void MeProfileStopTiming();

/** Indicates where in the code a frame is said to have started. */
void MeProfileStartFrame();

/** Indicates that the end of a frame has been reached. */
void MeProfileEndFrame();

/** Start timing a section of code.
 *  @param codeSection Name of the section to be timed
 *  @param 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 MeProfileStartSection(const char* codeSection, unsigned char autoStop);

/** Explicitly stops timing the specified section of code.
 *  You should not call this if you set autostop to 1 in MeProfileStartSection().
 */
void MeProfileEndSection(const char* codeSection);

/** Can be called just before the end of a frame
 *  to make sure all timers are stopped.
 */
void MeProfileStopTimers();

/** Output profile results in the currently selected style. */
void MeProfileOutputResults();

MeReal MeProfileGetSectionTime(const char* codeSection);

MeI64 MeProfileGetClockSpeed();

/** Sets the ouput mode for profiling information. */
void MeProfileSetOutputParameters(MeProfileOutput output);

#if defined WIN32
extern void MeProfileLimit(unsigned seconds);
#endif

#ifdef __cplusplus
}
#endif

#endif /* MEPROFILE_H */

---