\hypertarget{class_ogre_1_1_profile_session_listener}{}\section{Ogre\+:\+:Profile\+Session\+Listener Class Reference}
\label{class_ogre_1_1_profile_session_listener}\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}


\hyperlink{class_ogre_1_1_profile_session_listener}{Profile\+Session\+Listener} should be used to visualize profile results.  




{\ttfamily \#include $<$Ogre\+Profiler.\+h$>$}



Inheritance diagram for Ogre\+:\+:Profile\+Session\+Listener\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=233pt]{class_ogre_1_1_profile_session_listener__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum \hyperlink{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fd}{Display\+Mode} \{ \hyperlink{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fda41b686b0d7ded3976777b3011ad322a9}{D\+I\+S\+P\+L\+A\+Y\+\_\+\+P\+E\+R\+C\+E\+N\+T\+A\+GE}, 
\hyperlink{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fda2d7f2f9e8df9608e2cf8eecf1a97a7f9}{D\+I\+S\+P\+L\+A\+Y\+\_\+\+M\+I\+L\+L\+I\+S\+E\+C\+O\+N\+DS}
 \}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_profile_session_listener_a4b5aef7f8bcff4dbb69a10698c028167}{Profile\+Session\+Listener} ()
\item 
virtual \hyperlink{class_ogre_1_1_profile_session_listener_aa66be03fee41bf798a8941b54ae664ec}{$\sim$\+Profile\+Session\+Listener} ()
\item 
virtual void \hyperlink{class_ogre_1_1_profile_session_listener_a890e4c31d485fd9842beece13d2752e9}{change\+Enable\+State} (bool enabled)
\begin{DoxyCompactList}\small\item\em If the profiler disables this listener then it should hide its panels (if any exists) or stop sending data over the network. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_profile_session_listener_a113fcfa3b7e251bccbaf12c9b58790b5}{display\+Results} (const \hyperlink{class_ogre_1_1_profile_instance}{Profile\+Instance} \&instance, \hyperlink{namespace_ogre_a4304981347643708ee9a7ba8884e5758}{ulong} max\+Total\+Frame\+Time)
\begin{DoxyCompactList}\small\item\em Here we get the real profiling information which we can use. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_profile_session_listener_a4e5b4b6405ab857d9eb381975010eaa1}{finialize\+Session} ()=0
\begin{DoxyCompactList}\small\item\em All internal resources should be deleted here. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fd}{Display\+Mode} \hyperlink{class_ogre_1_1_profile_session_listener_ae1e613f73f9d96f4a9a6531f58a25262}{get\+Display\+Mode} () const
\begin{DoxyCompactList}\small\item\em Get the display mode for the overlay. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_profile_session_listener_a2a55689ef0b65d011ecbe5e618ec6061}{initialize\+Session} ()=0
\begin{DoxyCompactList}\small\item\em Create the internal resources. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_profile_session_listener_a0c25d6616ec6529f589ff8a39c60b3d8}{set\+Display\+Mode} (\hyperlink{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fd}{Display\+Mode} d)
\begin{DoxyCompactList}\small\item\em Set the display mode for the overlay. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\hyperlink{class_ogre_1_1_profile_session_listener}{Profile\+Session\+Listener} should be used to visualize profile results. 

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

\subsection{Member Enumeration Documentation}
\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fd}\label{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fd}} 
\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!Display\+Mode@{Display\+Mode}}
\index{Display\+Mode@{Display\+Mode}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}
\subsubsection{\texorpdfstring{Display\+Mode}{DisplayMode}}
{\footnotesize\ttfamily enum \hyperlink{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fd}{Ogre\+::\+Profile\+Session\+Listener\+::\+Display\+Mode}}

\begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{D\+I\+S\+P\+L\+A\+Y\+\_\+\+P\+E\+R\+C\+E\+N\+T\+A\+GE@{D\+I\+S\+P\+L\+A\+Y\+\_\+\+P\+E\+R\+C\+E\+N\+T\+A\+GE}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!D\+I\+S\+P\+L\+A\+Y\+\_\+\+P\+E\+R\+C\+E\+N\+T\+A\+GE@{D\+I\+S\+P\+L\+A\+Y\+\_\+\+P\+E\+R\+C\+E\+N\+T\+A\+GE}}}\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fda41b686b0d7ded3976777b3011ad322a9}\label{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fda41b686b0d7ded3976777b3011ad322a9}} 
D\+I\+S\+P\+L\+A\+Y\+\_\+\+P\+E\+R\+C\+E\+N\+T\+A\+GE&Display \% frame usage on the overlay. \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{D\+I\+S\+P\+L\+A\+Y\+\_\+\+M\+I\+L\+L\+I\+S\+E\+C\+O\+N\+DS@{D\+I\+S\+P\+L\+A\+Y\+\_\+\+M\+I\+L\+L\+I\+S\+E\+C\+O\+N\+DS}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!D\+I\+S\+P\+L\+A\+Y\+\_\+\+M\+I\+L\+L\+I\+S\+E\+C\+O\+N\+DS@{D\+I\+S\+P\+L\+A\+Y\+\_\+\+M\+I\+L\+L\+I\+S\+E\+C\+O\+N\+DS}}}\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fda2d7f2f9e8df9608e2cf8eecf1a97a7f9}\label{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fda2d7f2f9e8df9608e2cf8eecf1a97a7f9}} 
D\+I\+S\+P\+L\+A\+Y\+\_\+\+M\+I\+L\+L\+I\+S\+E\+C\+O\+N\+DS&Display milliseconds on the overlay. \\
\hline

\end{DoxyEnumFields}


\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_a4b5aef7f8bcff4dbb69a10698c028167}\label{class_ogre_1_1_profile_session_listener_a4b5aef7f8bcff4dbb69a10698c028167}} 
\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!Profile\+Session\+Listener@{Profile\+Session\+Listener}}
\index{Profile\+Session\+Listener@{Profile\+Session\+Listener}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}
\subsubsection{\texorpdfstring{Profile\+Session\+Listener()}{ProfileSessionListener()}}
{\footnotesize\ttfamily Ogre\+::\+Profile\+Session\+Listener\+::\+Profile\+Session\+Listener (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_aa66be03fee41bf798a8941b54ae664ec}\label{class_ogre_1_1_profile_session_listener_aa66be03fee41bf798a8941b54ae664ec}} 
\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!````~Profile\+Session\+Listener@{$\sim$\+Profile\+Session\+Listener}}
\index{````~Profile\+Session\+Listener@{$\sim$\+Profile\+Session\+Listener}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}
\subsubsection{\texorpdfstring{$\sim$\+Profile\+Session\+Listener()}{~ProfileSessionListener()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Profile\+Session\+Listener\+::$\sim$\+Profile\+Session\+Listener (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_a2a55689ef0b65d011ecbe5e618ec6061}\label{class_ogre_1_1_profile_session_listener_a2a55689ef0b65d011ecbe5e618ec6061}} 
\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!initialize\+Session@{initialize\+Session}}
\index{initialize\+Session@{initialize\+Session}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}
\subsubsection{\texorpdfstring{initialize\+Session()}{initializeSession()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Profile\+Session\+Listener\+::initialize\+Session (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Create the internal resources. 



Implemented in \hyperlink{group___overlays_ga015d977b47be9122d96cc185c5f9f818}{Ogre\+::\+Overlay\+Profile\+Session\+Listener}.

\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_a4e5b4b6405ab857d9eb381975010eaa1}\label{class_ogre_1_1_profile_session_listener_a4e5b4b6405ab857d9eb381975010eaa1}} 
\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!finialize\+Session@{finialize\+Session}}
\index{finialize\+Session@{finialize\+Session}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}
\subsubsection{\texorpdfstring{finialize\+Session()}{finializeSession()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Profile\+Session\+Listener\+::finialize\+Session (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



All internal resources should be deleted here. 



Implemented in \hyperlink{group___overlays_ga7652f6ce58d31b3613fecb2206142a3c}{Ogre\+::\+Overlay\+Profile\+Session\+Listener}.

\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_a890e4c31d485fd9842beece13d2752e9}\label{class_ogre_1_1_profile_session_listener_a890e4c31d485fd9842beece13d2752e9}} 
\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!change\+Enable\+State@{change\+Enable\+State}}
\index{change\+Enable\+State@{change\+Enable\+State}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}
\subsubsection{\texorpdfstring{change\+Enable\+State()}{changeEnableState()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Profile\+Session\+Listener\+::change\+Enable\+State (\begin{DoxyParamCaption}\item[{bool}]{enabled }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [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 \hyperlink{group___overlays_ga71c22e881e91f9cc375ba55c145ce02a}{Ogre\+::\+Overlay\+Profile\+Session\+Listener}.

\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_a113fcfa3b7e251bccbaf12c9b58790b5}\label{class_ogre_1_1_profile_session_listener_a113fcfa3b7e251bccbaf12c9b58790b5}} 
\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!display\+Results@{display\+Results}}
\index{display\+Results@{display\+Results}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}
\subsubsection{\texorpdfstring{display\+Results()}{displayResults()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Profile\+Session\+Listener\+::display\+Results (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_profile_instance}{Profile\+Instance} \&}]{instance,  }\item[{\hyperlink{namespace_ogre_a4304981347643708ee9a7ba8884e5758}{ulong}}]{max\+Total\+Frame\+Time }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



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



Reimplemented in \hyperlink{group___overlays_gaa6f75403a640cfc3c1b70c60faf3ad03}{Ogre\+::\+Overlay\+Profile\+Session\+Listener}.

\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_a0c25d6616ec6529f589ff8a39c60b3d8}\label{class_ogre_1_1_profile_session_listener_a0c25d6616ec6529f589ff8a39c60b3d8}} 
\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!set\+Display\+Mode@{set\+Display\+Mode}}
\index{set\+Display\+Mode@{set\+Display\+Mode}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}
\subsubsection{\texorpdfstring{set\+Display\+Mode()}{setDisplayMode()}}
{\footnotesize\ttfamily void Ogre\+::\+Profile\+Session\+Listener\+::set\+Display\+Mode (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fd}{Display\+Mode}}]{d }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Set the display mode for the overlay. 

\mbox{\Hypertarget{class_ogre_1_1_profile_session_listener_ae1e613f73f9d96f4a9a6531f58a25262}\label{class_ogre_1_1_profile_session_listener_ae1e613f73f9d96f4a9a6531f58a25262}} 
\index{Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}!get\+Display\+Mode@{get\+Display\+Mode}}
\index{get\+Display\+Mode@{get\+Display\+Mode}!Ogre\+::\+Profile\+Session\+Listener@{Ogre\+::\+Profile\+Session\+Listener}}
\subsubsection{\texorpdfstring{get\+Display\+Mode()}{getDisplayMode()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_profile_session_listener_a7d8c034deef087a5969bf5cce55334fd}{Display\+Mode} Ogre\+::\+Profile\+Session\+Listener\+::get\+Display\+Mode (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the display mode for the overlay. 



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_profiler_8h}{Ogre\+Profiler.\+h}\end{DoxyCompactItemize}
