Ogre::ProfileSessionListener Class Referenceabstract
Core » General

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

`#include <OgreProfiler.h>`

Inheritance diagram for Ogre::ProfileSessionListener:
[legend]

## 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 229 of file OgreProfiler.h.

## Member Enumeration Documentation

## DisplayMode

enum Ogre::ProfileSessionListener::DisplayMode

Enumerator
DISPLAY_PERCENTAGE | Display % frame usage on the overlay.
DISPLAY_MILLISECONDS | Display milliseconds on the overlay.

Definition at line 232 of file OgreProfiler.h.

## Constructor & Destructor Documentation

## ProfileSessionListener()

Ogre::ProfileSessionListener::ProfileSessionListener | ( |  | ) |

Definition at line 240 of file OgreProfiler.h.

## ~ProfileSessionListener()

virtual Ogre::ProfileSessionListener::~ProfileSessionListener | ( |  | ) |

virtual

Definition at line 241 of file OgreProfiler.h.

## Member Function Documentation

## changeEnableState()

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

virtual

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 253 of file OgreProfiler.h.

## displayResults()

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

virtual

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

Reimplemented in Ogre::OverlayProfileSessionListener.

Definition at line 256 of file OgreProfiler.h.

## finializeSession()

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

pure virtual

All internal resources should be deleted here.

Implemented in Ogre::OverlayProfileSessionListener.

## getDisplayMode()

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

Get the display mode for the overlay.

Definition at line 262 of file OgreProfiler.h.

## initializeSession()

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

pure virtual

Create the internal resources.

Implemented in Ogre::OverlayProfileSessionListener.

## setDisplayMode()

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

Set the display mode for the overlay.

Definition at line 259 of file OgreProfiler.h.

## Member Data Documentation

## mDisplayMode

DisplayMode Ogre::ProfileSessionListener::mDisplayMode

protected

How to display the overlay.

Definition at line 266 of file OgreProfiler.h.

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

- OgreProfiler.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.