The profiler allows you to measure the performance of your code. More...

#include <OgreProfiler.h>

Inheritance diagram for Ogre::Profiler:

Public Member Functions
	Profiler ()
	~Profiler ()
void	addListener (ProfileSessionListener *listener)
void	beginGPUEvent (const String &event)
	Mark the beginning of a GPU event group.
void	beginProfile (const String &profileName, uint32 groupID=(uint32) OGREPROF_USER_DEFAULT)
	Begins a profile.
void	disableProfile (const String &profileName)
	Disables a profile.
void	enableProfile (const String &profileName)
	Enables a previously disabled profile.
void	endGPUEvent (const String &event)
	Mark the end of a GPU event group.
void	endProfile (const String &profileName, uint32 groupID=(uint32) OGREPROF_USER_DEFAULT)
	Ends a profile.
bool	getEnabled () const
	Gets whether this profiler is enabled.
uint32	getProfileGroupMask () const
	Get the mask which all profiles must pass to be enabled.
Timer *	getTimer ()
	Retrieves the timer for the profiler.
uint	getUpdateDisplayFrequency () const
	Gets the frequency that the Profiler display is updated.
void	logResults ()
	Outputs current profile statistics to the log.
void	markGPUEvent (const String &event)
	Mark a specific, ungrouped, GPU event.
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	removeListener (ProfileSessionListener *listener)
void	reset ()
	Clears the profiler statistics.
void	setEnabled (bool enabled)
	Sets whether this profiler is enabled.
void	setProfileGroupMask (uint32 mask)
	Set the mask which all profiles must pass to be enabled.
void	setTimer (Timer *t)
	Sets the timer for the profiler.
void	setUpdateDisplayFrequency (uint freq)
	Sets the Profiler so the display of results are updated every n frames.
bool	watchForLimit (const String &profileName, Real limit, bool greaterThan=true)
	Returns true if the specified profile goes over or under the given limit frame time.
bool	watchForMax (const String &profileName)
	Returns true if the specified profile reaches a new frame time maximum.
bool	watchForMin (const String &profileName)
	Returns true if the specified profile reaches a new frame time minimum.
Static Public Member Functions
static Profiler &	getSingleton (void)
	Override standard Singleton retrieval.
static Profiler *	getSingletonPtr (void)
	Override standard Singleton retrieval.
Protected Types
typedef set< String >::type	DisabledProfileMap
typedef ProfileInstance::ProfileChildren	ProfileChildren
typedef vector < ProfileSessionListener * > ::type	TProfileSessionListener
Protected Member Functions
void	changeEnableState ()
	Handles a change of the profiler's enabled state.
void	displayResults ()
void	initialize ()
	Initializes the profiler's GUI elements.
void	processFrameStats (void)
	Processes frame stats for all of the mRoot's children.
void	processFrameStats (ProfileInstance *instance, Real &maxFrameTime)
	Processes specific ProfileInstance and it's children recursively.
Protected Attributes
Real	mAverageFrameTime
	Rolling average of millisecs.
ProfileInstance *	mCurrent
uint	mCurrentFrame
	The number of elapsed frame, used with mUpdateDisplayFrequency.
DisabledProfileMap	mDisabledProfiles
	Holds the names of disabled profiles.
bool	mEnabled
	Whether this profiler is enabled.
bool	mInitialized
	Whether the GUI elements have been initialized.
ProfileInstance *	mLast
TProfileSessionListener	mListeners
ulong	mMaxTotalFrameTime
	The max frame time recorded.
bool	mNewEnableState
	Keeps track of the new enabled/disabled state that the user has requested which will be applied after the frame ends.
uint32	mProfileMask
	Mask to decide whether a type of profile is enabled or not.
bool	mResetExtents
ProfileInstance	mRoot
Timer *	mTimer
	The timer used for profiling.
ulong	mTotalFrameTime
	The total time each frame takes.
uint	mUpdateDisplayFrequency
	The number of frames that must elapse before the current frame display is updated.
Static Protected Attributes
static Profiler *	msSingleton
Friends
class	ProfileInstance

Detailed Description

The profiler allows you to measure the performance of your code.

Remarks:: Do not create profiles directly from this unless you want a profile to last outside of its scope (i.e. the main game loop). For most cases, use the macro OgreProfile(name) and braces to limit the scope. You must enable the Profile before you can used it with setEnabled(true). If you want to disable profiling in Ogre, simply set the macro OGRE_PROFILING to 0.

Author:: Amit Mathew (amitmathew (at) yahoo (dot) com)

Definition at line 280 of file OgreProfiler.h.

Member Typedef Documentation

typedef set<String>::type Ogre::Profiler::DisabledProfileMap [protected]

Definition at line 473 of file OgreProfiler.h.

typedef ProfileInstance::ProfileChildren Ogre::Profiler::ProfileChildren [protected]

Definition at line 474 of file OgreProfiler.h.

typedef vector<ProfileSessionListener*>::type Ogre::Profiler::TProfileSessionListener [protected]

Definition at line 456 of file OgreProfiler.h.

Constructor & Destructor Documentation

Ogre::Profiler::Profiler ( )

Ogre::Profiler::~Profiler ( )

Member Function Documentation

void Ogre::Profiler::addListener ( ProfileSessionListener * listener )

Remarks:: Register a ProfileSessionListener from the Profiler

Parameters:

listener A valid listener derived class

void Ogre::Profiler::beginGPUEvent ( const String & event )

Mark the beginning of a GPU event group.

Remarks:: Can be safely called in the middle of the profile.

void Ogre::Profiler::beginProfile	(	const String &	profileName,
		uint32	groupID = `(uint32) OGREPROF_USER_DEFAULT`
	)

Begins a profile.

Remarks:: Use the macro OgreProfileBegin(name) instead of calling this directly so that profiling can be ignored in the release version of your app.; You only use the macro (or this) if you want a profile to last outside of its scope (i.e. the main game loop). If you use this function, make sure you use a corresponding OgreProfileEnd(name). Usually you would use the macro OgreProfile(name). This function will be ignored for a profile that has been disabled or if the profiler is disabled.

Parameters:

profileName	Must be unique and must not be an empty string
groupID	A profile group identifier, which can allow you to mask profiles

void Ogre::Profiler::changeEnableState ( ) [protected]

Handles a change of the profiler's enabled state.

void Ogre::Profiler::disableProfile ( const String & profileName )

Disables a profile.

Remarks:: Can be safely called in the middle of the profile.

void Ogre::Profiler::displayResults ( ) [protected]

void Ogre::Profiler::enableProfile ( const String & profileName )

Enables a previously disabled profile.

Remarks:: Can be safely called in the middle of the profile.

void Ogre::Profiler::endGPUEvent ( const String & event )

Mark the end of a GPU event group.

Remarks:: Can be safely called in the middle of the profile.

void Ogre::Profiler::endProfile	(	const String &	profileName,
		uint32	groupID = `(uint32) OGREPROF_USER_DEFAULT`
	)

Ends a profile.

Remarks:: Use the macro OgreProfileEnd(name) instead of calling this directly so that profiling can be ignored in the release version of your app.; This function is usually not called directly unless you want a profile to last outside of its scope. In most cases, using the macro OgreProfile(name) which will call this function automatically when it goes out of scope. Make sure the name of this profile matches its corresponding beginProfile name. This function will be ignored for a profile that has been disabled or if the profiler is disabled.

Parameters:

profileName	Must be unique and must not be an empty string
groupID	A profile group identifier, which can allow you to mask profiles

bool Ogre::Profiler::getEnabled ( ) const

Gets whether this profiler is enabled.

uint32 Ogre::Profiler::getProfileGroupMask ( ) const

Get the mask which all profiles must pass to be enabled.

Definition at line 365 of file OgreProfiler.h.

static Profiler& Ogre::Profiler::getSingleton ( void ) [static]

Override standard Singleton retrieval.

Remarks:: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< Profiler >.

static Profiler* Ogre::Profiler::getSingletonPtr ( void ) [static]

Override standard Singleton retrieval.

Remarks:: Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

: This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< Profiler >.

Timer* Ogre::Profiler::getTimer ( )

Retrieves the timer for the profiler.

uint Ogre::Profiler::getUpdateDisplayFrequency ( ) const

Gets the frequency that the Profiler display is updated.

void Ogre::Profiler::initialize ( ) [protected]

Initializes the profiler's GUI elements.

void Ogre::Profiler::logResults ( )

Outputs current profile statistics to the log.

void Ogre::Profiler::markGPUEvent ( const String & event )

Mark a specific, ungrouped, GPU event.

Remarks:: Can be safely called in the middle of the profile.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)		`[inherited]`

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)		`[inherited]`

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)		`[inherited]`

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)		`[inherited]`

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)		`[inherited]`

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)		`[inherited]`

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::Profiler::processFrameStats ( void ) [protected]

Processes frame stats for all of the mRoot's children.

void Ogre::Profiler::processFrameStats	(	ProfileInstance *	instance,
		Real &	maxFrameTime
	)		`[protected]`

Processes specific ProfileInstance and it's children recursively.

void Ogre::Profiler::removeListener ( ProfileSessionListener * listener )

Remarks:: Unregister a ProfileSessionListener from the Profiler

Parameters:

listener A valid listener derived class

void Ogre::Profiler::reset ( )

Clears the profiler statistics.

void Ogre::Profiler::setEnabled ( bool enabled )

Sets whether this profiler is enabled.

Only takes effect after the the frame has ended.

Remarks:: When this is called the first time with the parameter true, it initializes the GUI for the Profiler

void Ogre::Profiler::setProfileGroupMask ( uint32 mask )

Set the mask which all profiles must pass to be enabled.

Definition at line 362 of file OgreProfiler.h.

void Ogre::Profiler::setTimer ( Timer * t )

Sets the timer for the profiler.

void Ogre::Profiler::setUpdateDisplayFrequency ( uint freq )

Sets the Profiler so the display of results are updated every n frames.

bool Ogre::Profiler::watchForLimit	(	const String &	profileName,
		Real	limit,
		bool	greaterThan = `true`
	)

Returns true if the specified profile goes over or under the given limit frame time.

Remarks:: If this is called during a frame, it will be reading the results from the previous frame. Therefore, it is best to use this after the frame has ended.

Parameters:

limit	A number between 0 and 1 representing the percentage of frame time
greaterThan	If true, this will return whether the limit is exceeded. Otherwise, it will return if the frame time has gone under this limit.

bool Ogre::Profiler::watchForMax ( const String & profileName )

Returns true if the specified profile reaches a new frame time maximum.

Remarks:: If this is called during a frame, it will be reading the results from the previous frame. Therefore, it is best to use this after the frame has ended.

bool Ogre::Profiler::watchForMin ( const String & profileName )

Returns true if the specified profile reaches a new frame time minimum.

Remarks:: If this is called during a frame, it will be reading the results from the previous frame. Therefore, it is best to use this after the frame has ended.