ONE::util::Profiler Class Reference

List of all members.

---

Detailed Description

used to time functions

To profile a function or a set of functions, create a StopWatch object in each scope that you want to time. Call Profiler::reset at the beginning of each frame and Profiler::output at the end. The profiler must be set up by calling Profiler::setOutput and Profiler::setMaxSampleCount.

Author:

Daniel Seibert

Public Types
typedef unsigned int	count
typedef G3D::uint64	Time
Static Public Member Functions
static void	mergeRecursive (bool)
	sets the treatment of profiled recursive calls
static void	output ()
	sends the profiling results to the output set by Profiler::setOutput
static void	reset ()
	resets the profiler for a new run
static void	setMaxSampleCount (count num)
	sets the maximum number of samples that may be taken
static void	setOutput (Output *)
	sets the Output object used to display or store the profiling results
Classes
class	Output
	SampleInfo output interface More...
struct	Sample
struct	SampleInfo
	holds profiling results More...
class	StopWatch

---

Member Typedef Documentation

typedef unsigned int ONE::util::Profiler::count

typedef G3D::uint64 ONE::util::Profiler::Time

---

Member Function Documentation

static void ONE::util::Profiler::mergeRecursive (  bool   )  [static]

sets the treatment of profiled recursive calls If set to true, nested samples with the same name will be merged to form one sample.

static void ONE::util::Profiler::output (   )  [static]

sends the profiling results to the output set by Profiler::setOutput

static void ONE::util::Profiler::reset (   )  [static]

resets the profiler for a new run This function should be called at the beginning of every frame.

static void ONE::util::Profiler::setMaxSampleCount (  count  num  )  [static]

sets the maximum number of samples that may be taken

static void ONE::util::Profiler::setOutput (  Output *   )  [static]

sets the Output object used to display or store the profiling results Note: it is the user's responsibility to delete the given output object

---