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

ProfileSessionListener should be used to visualize profile results. More...

#include <OgreProfiler.h>

+ Inheritance diagram for Ogre::ProfileSessionListener:

Public Types

enum  DisplayMode { DISPLAY_PERCENTAGE, DISPLAY_MILLISECONDS }
 

Public Member Functions

 ProfileSessionListener ()
 
virtual ~ProfileSessionListener ()
 
virtual void changeEnableState (bool enabled)
 If the profiler disables this listener then it should hide its panels (if any exists) or stop sending data over the network. More...
 
virtual void displayResults (const ProfileInstance &instance, ulong maxTotalFrameTime)
 Here we get the real profiling information which we can use. More...
 
virtual void finializeSession ()=0
 All internal resources should be deleted here. More...
 
DisplayMode getDisplayMode () const
 Get the display mode for the overlay. More...
 
virtual void initializeSession ()=0
 Create the internal resources. More...
 
void setDisplayMode (DisplayMode d)
 Set the display mode for the overlay. More...
 

Protected Attributes

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

Detailed Description

ProfileSessionListener should be used to visualize profile results.

Concrete impl. could be done using Overlay's but its not limited to them you can also create a custom listener which sends the profile informtaion over a network.

Definition at line 228 of file OgreProfiler.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.

Constructor & Destructor Documentation

Ogre::ProfileSessionListener::ProfileSessionListener ( )
inline

Definition at line 239 of file OgreProfiler.h.

virtual Ogre::ProfileSessionListener::~ProfileSessionListener ( )
inlinevirtual

Definition at line 240 of file OgreProfiler.h.

Member Function Documentation

virtual void Ogre::ProfileSessionListener::changeEnableState ( bool  enabled)
inlinevirtual

If the profiler disables this listener then it should hide its panels (if any exists) or stop sending data over the network.

Reimplemented in Ogre::OverlayProfileSessionListener.

Definition at line 252 of file OgreProfiler.h.

virtual void Ogre::ProfileSessionListener::displayResults ( const ProfileInstance instance,
ulong  maxTotalFrameTime 
)
inlinevirtual

Here we get the real profiling information which we can use.

Reimplemented in Ogre::OverlayProfileSessionListener.

Definition at line 255 of file OgreProfiler.h.

virtual void Ogre::ProfileSessionListener::finializeSession ( )
pure virtual

All internal resources should be deleted here.

Implemented in Ogre::OverlayProfileSessionListener.

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

Get the display mode for the overlay.

Definition at line 261 of file OgreProfiler.h.

virtual void Ogre::ProfileSessionListener::initializeSession ( )
pure virtual

Create the internal resources.

Implemented in Ogre::OverlayProfileSessionListener.

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

Set the display mode for the overlay.

Definition at line 258 of file OgreProfiler.h.

Member Data Documentation

DisplayMode Ogre::ProfileSessionListener::mDisplayMode
protected

How to display the overlay.

Definition at line 265 of file OgreProfiler.h.


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