Ogre::OverlayProfileSessionListener Class Reference
Core » Overlays

Concrete impl. More...

`#include <OgreOverlayProfileSessionListener.h>`

Inheritance diagram for Ogre::OverlayProfileSessionListener:
[legend]

## 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

OverlayContainer * | createContainer ()
| An internal function to create the container which will hold our display elements. More...
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. More...
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. 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...
Overlay * | mOverlay
| The overlay which contains our profiler results display. More...
ProfileBarList | mProfileBars
| Holds the display bars for each profile results. More...
OverlayContainer * | mProfileGui
| 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 48 of file OgreOverlayProfileSessionListener.h.

## Member Enumeration Documentation

## DisplayMode

enum Ogre::ProfileSessionListener::DisplayMode

inherited

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

Definition at line 232 of file OgreProfiler.h.

## Member Function Documentation

## getDisplayMode()

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

inherited

Get the display mode for the overlay.

Definition at line 262 of file OgreProfiler.h.

## setDisplayMode()

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

inherited

Set the display mode for the overlay.

Definition at line 259 of file OgreProfiler.h.

## Member Data Documentation

## mDisplayMode

DisplayMode Ogre::ProfileSessionListener::mDisplayMode

protected inherited

How to display the overlay.

Definition at line 266 of file OgreProfiler.h.

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

- OgreOverlayProfileSessionListener.h

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