Ogre::ProfileInstance Class Reference

Represents an individual profile call. More...

#include <OgreProfiler.h>

Inheritance diagram for Ogre::ProfileInstance:

Public Types
typedef Ogre::map< String, ProfileInstance * >::type	ProfileChildrenMap
typedef Ogre::vector< ProfileInstance * >::type	ProfileChildrenVec

Public Member Functions
	ProfileInstance ()
virtual	~ProfileInstance ()
void	destroyAllChildren ()
void	logResults ()
void	reset ()
bool	watchForLimit (const String &profileName, Real limit, bool greaterThan=true)
bool	watchForLimit (Real limit, bool greaterThan=true)
bool	watchForMax ()
bool	watchForMax (const String &profileName)
bool	watchForMin ()
bool	watchForMin (const String &profileName)

Public Attributes
uint64	accum
	Represents the total time of all child profiles to subtract from this profile.
ProfileChildrenVec	children
ProfileChildrenMap	childrenMap
uint64	currTime
	The time this profile was started.
ProfileFrame	frame
ulong	frameNumber
uint	hierarchicalLvl
	The hierarchical level of this profile, 0 being the root profile.
ProfileHistory	history
String	name
	The name of the profile.
ProfileInstance *	parent
	The name of the parent, null if root.

Detailed Description

Represents an individual profile call.

Member Typedef Documentation

ProfileChildrenMap

typedef Ogre::map<String,ProfileInstance*>::type Ogre::ProfileInstance::ProfileChildrenMap

ProfileChildrenVec

typedef Ogre::vector<ProfileInstance*>::type Ogre::ProfileInstance::ProfileChildrenVec

Constructor & Destructor Documentation

ProfileInstance()

Ogre::ProfileInstance::ProfileInstance

(

)

~ProfileInstance()

virtual Ogre::ProfileInstance::~ProfileInstance ( )

virtual

Member Function Documentation

destroyAllChildren()

void Ogre::ProfileInstance::destroyAllChildren

(

)

logResults()

void Ogre::ProfileInstance::logResults

(

)

reset()

void Ogre::ProfileInstance::reset

(

)

watchForLimit() [1/2]

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

watchForLimit() [2/2]

bool Ogre::ProfileInstance::watchForLimit ( Real  limit, bool  greaterThan = true  )

inline

References Ogre::ProfileHistory::currentTimePercent, and history.

watchForMax() [1/2]

bool Ogre::ProfileInstance::watchForMax ( )

inline

References Ogre::ProfileHistory::currentTimePercent, history, and Ogre::ProfileHistory::maxTimePercent.

watchForMax() [2/2]

bool Ogre::ProfileInstance::watchForMax

(

const String &

profileName

)

watchForMin() [1/2]

bool Ogre::ProfileInstance::watchForMin ( )

inline

References Ogre::ProfileHistory::currentTimePercent, history, and Ogre::ProfileHistory::minTimePercent.

watchForMin() [2/2]

bool Ogre::ProfileInstance::watchForMin

(

const String &

profileName

)

Member Data Documentation

accum

uint64 Ogre::ProfileInstance::accum

Represents the total time of all child profiles to subtract from this profile.

children

ProfileChildrenVec Ogre::ProfileInstance::children

childrenMap

ProfileChildrenMap Ogre::ProfileInstance::childrenMap

currTime

uint64 Ogre::ProfileInstance::currTime

The time this profile was started.

frame

ProfileFrame Ogre::ProfileInstance::frame

frameNumber

ulong Ogre::ProfileInstance::frameNumber

hierarchicalLvl

uint Ogre::ProfileInstance::hierarchicalLvl

The hierarchical level of this profile, 0 being the root profile.

history

ProfileHistory Ogre::ProfileInstance::history

Referenced by watchForLimit(), watchForMax(), and watchForMin().

name

String Ogre::ProfileInstance::name

The name of the profile.

parent

ProfileInstance* Ogre::ProfileInstance::parent

The name of the parent, null if root.

---

The documentation for this class was generated from the following file:

• OgreProfiler.h