ps
Class CProfileViewer
Singleton
|
+--CProfileViewer
in ProfileViewer.h
in ProfileViewer.cpp
- class CProfileViewer
- extends Singleton
Class CProfileViewer: Manage and display profiling tables.
Method Summary |
void |
AddRootTable( AbstractProfileTable* table )
AddRootTable: Add a new profile table as a root table (i.e. the
tables that you cycle through via the profile hotkey). |
InReaction |
Input( const SDL_Event_* ev )
Input: Filter and handle any input events that the profile display
is interested in. |
static InReaction |
InputThunk( const SDL_Event_* ev )
InputThunk: Delegate to the singleton's Input() member function
if the singleton has been initialized. |
void |
RenderProfile()
RenderProfile: Render the profile display using OpenGL if the user
has enabled it. |
void |
SaveToFile()
SaveToFile: Save the current profiler data (for all profile tables)
to a file in the 'logs' directory. |
void |
ShowTable( const CStr& table )
ShowTable: Set the named profile table to be the displayed one. |
m
private CProfileViewerInternals* m;
CProfileViewer
public CProfileViewer();
~CProfileViewer
public ~CProfileViewer();
AddRootTable
public void AddRootTable( AbstractProfileTable* table );
- AddRootTable: Add a new profile table as a root table (i.e. the
tables that you cycle through via the profile hotkey).
- Parameters:
table
- This table is added as a root table.
Input
public InReaction Input( const SDL_Event_* ev );
- Input: Filter and handle any input events that the profile display
is interested in.
In particular, this function handles enable/disable of the profile
display as well as navigating the information tree.
- Parameters:
ev
- The incoming event.
- Returns:
- IN_PASS or IN_HANDLED depending on whether the event relates
to the profiling display.
InputThunk
public static InReaction InputThunk( const SDL_Event_* ev );
- InputThunk: Delegate to the singleton's Input() member function
if the singleton has been initialized.
This allows our input handler to be installed via in_add_handler
like a normal, global function input handler.
RenderProfile
public void RenderProfile();
- RenderProfile: Render the profile display using OpenGL if the user
has enabled it.
SaveToFile
public void SaveToFile();
- SaveToFile: Save the current profiler data (for all profile tables)
to a file in the 'logs' directory.
ShowTable
public void ShowTable( const CStr& table );
- ShowTable: Set the named profile table to be the displayed one. If it
is not found, no profile is displayed.
- Parameters:
table
- The table name (matching AbstractProfileTable::GetName),
or the empty string to display no table.