#include <OgreProfiler.h>
Inheritance diagram for Ogre::Profiler:

Public Member Functions | |
| Profiler () | |
| ~Profiler () | |
| void | setTimer (Timer *t) |
| Sets the timer for the profiler. | |
| Timer * | getTimer () |
| Retrieves the timer for the profiler. | |
| void | beginProfile (const String &profileName) |
| Begins a profile. | |
| void | endProfile (const String &profileName) |
| Ends a profile. | |
| void | setEnabled (bool enabled) |
| Sets whether this profiler is enabled. | |
| bool | getEnabled () const |
| Gets whether this profiler is enabled. | |
| void | enableProfile (const String &profileName) |
| Enables a previously disabled profile. | |
| void | disableProfile (const String &profileName) |
| Disables a profile. | |
| 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. | |
| 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. | |
| void | logResults () |
| Outputs current profile statistics to the log. | |
| void | reset () |
| Clears the profiler statistics. | |
| void | setUpdateDisplayFrequency (uint freq) |
| Sets the Profiler so the display of results are updated ever n frames. | |
| uint | getUpdateDisplayFrequency () const |
| Gets the frequency that the Profiler display is updated. | |
Static Public Member Functions | |
| Profiler & | getSingleton (void) |
| Override standard Singleton retrieval. | |
| Profiler * | getSingletonPtr (void) |
| Override standard Singleton retrieval. | |
Protected Types | |
| typedef std::list< ProfileInstance > | ProfileStack |
| typedef std::list< ProfileFrame > | ProfileFrameList |
| typedef std::list< ProfileHistory > | ProfileHistoryList |
| typedef std::map< String, ProfileHistoryList::iterator > | ProfileHistoryMap |
| typedef std::map< String, bool > | DisabledProfileMap |
| typedef std::list< OverlayElement * > | ProfileBarList |
Protected Member Functions | |
| void | initialize () |
| Initializes the profiler's gui elements. | |
| void | displayResults () |
| Prints the profiling results of each frame. | |
| void | processFrameStats () |
| Processes the profiler data after each frame. | |
| void | changeEnableState () |
| Handles a change of the profiler's enabled state. | |
| OverlayContainer * | createContainer () |
| An internal function to create the container which will hold our display elements. | |
| OverlayElement * | createTextArea (const String &name, Real width, Real height, Real top, Real left, uint fontSize, const String &caption, bool show=true) |
| An internal function to create a text area. | |
| OverlayElement * | createPanel (const String &name, Real width, Real height, Real top, Real left, const String &materialName, bool show=true) |
| An internal function to create a panel. | |
Protected Attributes | |
| ProfileStack | mProfiles |
| A stack for each individual profile per frame. | |
| ProfileFrameList | mProfileFrame |
| Accumulates the results of each profile per frame (since a profile can be called more than once a frame). | |
| ProfileHistoryList | mProfileHistory |
| Keeps track of the statistics of each profile. | |
| ProfileHistoryMap | mProfileHistoryMap |
| We use this for quick look-ups of profiles in the history list. | |
| DisabledProfileMap | mDisabledProfiles |
| Holds the names of disabled profiles. | |
| ProfileBarList | mProfileBars |
| Holds the display bars for each profile results. | |
| bool | mInitialized |
| Whether the GUI elements have been initialized. | |
| uint | maxProfiles |
| The max number of profiles we can display. | |
| Overlay * | mOverlay |
| The overlay which contains our profiler results display. | |
| OverlayContainer * | mProfileGui |
| The window that displays the profiler results. | |
| Real | mBarHeight |
| The height of each bar. | |
| Real | mGuiHeight |
| The height of the stats window. | |
| Real | mGuiWidth |
| The width of the stats window. | |
| Real | mBarIndent |
| The size of the indent for each profile display bar. | |
| Real | mGuiBorderWidth |
| The width of the border between the profile window and each bar. | |
| Real | mBarLineWidth |
| The width of the min, avg, and max lines in a profile display. | |
| uint | mUpdateDisplayFrequency |
| The number of frames that must elapse before the current frame display is updated. | |
| uint | mCurrentFrame |
| The number of elasped frame, used with mUpdateDisplayFrequency. | |
| Timer * | mTimer |
| The timer used for profiling. | |
| ulong | mTotalFrameTime |
| The total time each frame takes. | |
| bool | mEnabled |
| Whether this profiler is enabled. | |
| bool | mEnableStateChangePending |
| Keeps track of whether this profiler has received a request to be enabled/disabled. | |
| bool | mNewEnableState |
| Keeps track of the new enabled/disabled state that the user has requested which will be applied after the frame ends. | |
Static Protected Attributes | |
| Profiler * | ms_Singleton |
fix display ordering of profiles not called every frame
Definition at line 99 of file OgreProfiler.h.
|
|
Definition at line 330 of file OgreProfiler.h. |
|
|
Definition at line 332 of file OgreProfiler.h. |
|
|
Definition at line 327 of file OgreProfiler.h. |
|
|
Definition at line 328 of file OgreProfiler.h. |
|
|
Definition at line 329 of file OgreProfiler.h. |
|
|
Definition at line 326 of file OgreProfiler.h. |
|
|
|
|
|
|
|
|
Begins a profile.
|
|
|
Handles a change of the profiler's enabled state.
|
|
|
An internal function to create the container which will hold our display elements.
|
|
||||||||||||||||||||||||||||||||
|
An internal function to create a panel.
|
|
||||||||||||||||||||||||||||||||||||
|
An internal function to create a text area.
|
|
|
Disables a profile.
|
|
|
Prints the profiling results of each frame.
|
|
|
Enables a previously disabled profile.
|
|
|
Ends a profile.
|
|
|
Gets whether this profiler is enabled.
|
|
|
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< Profiler >. |
|
|
Override standard Singleton retrieval.
Reimplemented from Ogre::Singleton< Profiler >. |
|
|
Retrieves the timer for the profiler.
|
|
|
Gets the frequency that the Profiler display is updated.
|
|
|
Initializes the profiler's gui elements.
|
|
|
Outputs current profile statistics to the log.
|
|
|
Processes the profiler data after each frame.
|
|
|
Clears the profiler statistics.
|
|
|
Sets whether this profiler is enabled. Only takes effect after the the frame has ended.
|
|
|
Sets the timer for the profiler.
|
|
|
Sets the Profiler so the display of results are updated ever n frames.
|
|
||||||||||||||||
|
Returns true if the specified profile goes over or under the given limit frame time.
|
|
|
Returns true if the specified profile reaches a new frame time maximum.
|
|
|
Returns true if the specified profile reaches a new frame time minimum.
|
|
|
The max number of profiles we can display.
Definition at line 357 of file OgreProfiler.h. |
|
|
The height of each bar.
Definition at line 366 of file OgreProfiler.h. |
|
|
The size of the indent for each profile display bar.
Definition at line 375 of file OgreProfiler.h. |
|
|
The width of the min, avg, and max lines in a profile display.
Definition at line 381 of file OgreProfiler.h. |
|
|
The number of elasped frame, used with mUpdateDisplayFrequency.
Definition at line 388 of file OgreProfiler.h. |
|
|
Holds the names of disabled profiles.
Definition at line 348 of file OgreProfiler.h. |
|
|
Whether this profiler is enabled.
Definition at line 397 of file OgreProfiler.h. |
|
|
Keeps track of whether this profiler has received a request to be enabled/disabled.
Definition at line 401 of file OgreProfiler.h. |
|
|
The width of the border between the profile window and each bar.
Definition at line 378 of file OgreProfiler.h. |
|
|
The height of the stats window.
Definition at line 369 of file OgreProfiler.h. |
|
|
The width of the stats window.
Definition at line 372 of file OgreProfiler.h. |
|
|
Whether the GUI elements have been initialized.
Definition at line 354 of file OgreProfiler.h. |
|
|
Keeps track of the new enabled/disabled state that the user has requested which will be applied after the frame ends.
Definition at line 405 of file OgreProfiler.h. |
|
|
The overlay which contains our profiler results display.
Definition at line 360 of file OgreProfiler.h. |
|
|
Holds the display bars for each profile results.
Definition at line 351 of file OgreProfiler.h. |
|
|
Accumulates the results of each profile per frame (since a profile can be called more than once a frame).
Definition at line 339 of file OgreProfiler.h. |
|
|
The window that displays the profiler results.
Definition at line 363 of file OgreProfiler.h. |
|
|
Keeps track of the statistics of each profile.
Definition at line 342 of file OgreProfiler.h. |
|
|
We use this for quick look-ups of profiles in the history list.
Definition at line 345 of file OgreProfiler.h. |
|
|
A stack for each individual profile per frame.
Definition at line 335 of file OgreProfiler.h. |
|
|
Definition at line 54 of file OgreSingleton.h. |
|
|
The timer used for profiling.
Definition at line 391 of file OgreProfiler.h. |
|
|
The total time each frame takes.
Definition at line 394 of file OgreProfiler.h. |
|
|
The number of frames that must elapse before the current frame display is updated.
Definition at line 385 of file OgreProfiler.h. |
Copyright © 2000-2005 by The OGRE Team
Last modified Sun Nov 20 12:38:26 2005