OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::OverlayProfileSessionListener Class Reference

Concrete impl. More...

#include <OgreOverlayProfileSessionListener.h>

+ Inheritance diagram for Ogre::OverlayProfileSessionListener:
+ Collaboration diagram for Ogre::OverlayProfileSessionListener:

Public Types

enum  DisplayMode { DISPLAY_PERCENTAGE, DISPLAY_MILLISECONDS }
 

Public Member Functions

 OverlayProfileSessionListener ()
 
virtual ~OverlayProfileSessionListener ()
 
virtual void changeEnableState (bool enabled)
 
virtual void displayResults (const ProfileInstance &instance, ulong maxTotalFrameTime)
 
virtual void finializeSession ()
 
DisplayMode getDisplayMode () const
 Get the display mode for the overlay. More...
 
Real getOverlayHeight () const
 
Real getOverlayLeft () const
 
Real getOverlayTop () const
 
Real getOverlayWidth () const
 
virtual void initializeSession ()
 
void setDisplayMode (DisplayMode d)
 Set the display mode for the overlay. More...
 
void setOverlayDimensions (Real width, Real height)
 Set the size of the profiler overlay, in pixels. More...
 
void setOverlayPosition (Real left, Real top)
 Set the position of the profiler overlay, in pixels. More...
 

Protected Attributes

DisplayMode mDisplayMode
 How to display the overlay. More...
 

Private Types

typedef list< OverlayElement * >
::type 
ProfileBarList
 

Private Member Functions

OverlayContainercreateContainer ()
 An internal function to create the container which will hold our display elements. More...
 
OverlayElementcreatePanel (const String &name, Real width, Real height, Real top, Real left, const String &materialName, bool show=true)
 An internal function to create a panel. More...
 
OverlayElementcreateTextArea (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. More...
 
void displayResults (ProfileInstance *instance, ProfileBarList::const_iterator &bIter, Real &maxTimeMillisecs, Real &newGuiHeight, int &profileCount)
 Prints the profiling results of each frame. More...
 

Private Attributes

Real mBarHeight
 The height of each bar. More...
 
Real mBarIndent
 The size of the indent for each profile display bar. More...
 
Real mBarLineWidth
 The width of the min, avg, and max lines in a profile display. More...
 
Real mBarSpacing
 The distance between bars. More...
 
Real mGuiBorderWidth
 The width of the border between the profile window and each bar. More...
 
Real mGuiHeight
 The height of the stats window. More...
 
Real mGuiLeft
 The horz position of the stats window. More...
 
Real mGuiTop
 The vertical position of the stats window. More...
 
Real mGuiWidth
 The width of the stats window. More...
 
uint mMaxDisplayProfiles
 The max number of profiles we can display. More...
 
OverlaymOverlay
 The overlay which contains our profiler results display. More...
 
ProfileBarList mProfileBars
 Holds the display bars for each profile results. More...
 
OverlayContainermProfileGui
 The window that displays the profiler results. More...
 

Detailed Description

Concrete impl.

of the ProfileSessionListener which visualizes the profling results using overlays.

Definition at line 47 of file OgreOverlayProfileSessionListener.h.

Member Enumeration Documentation

Enumerator
DISPLAY_PERCENTAGE 

Display % frame usage on the overlay.

DISPLAY_MILLISECONDS 

Display milliseconds on the overlay.

Definition at line 231 of file OgreProfiler.h.

Member Function Documentation

DisplayMode Ogre::ProfileSessionListener::getDisplayMode ( ) const
inlineinherited

Get the display mode for the overlay.

Definition at line 261 of file OgreProfiler.h.

void Ogre::ProfileSessionListener::setDisplayMode ( DisplayMode  d)
inlineinherited

Set the display mode for the overlay.

Definition at line 258 of file OgreProfiler.h.

Member Data Documentation

DisplayMode Ogre::ProfileSessionListener::mDisplayMode
protectedinherited

How to display the overlay.

Definition at line 265 of file OgreProfiler.h.


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