Kanzi  3.9.7
Kanzi Engine API
kanzi::PerformanceInfo Class Reference

HUD class allows drawing information on top of tests. More...

#include <kanzi/core.ui/application/performance_info.hpp>

Public Member Functions

void drawFps ()
 Draws the FPS information on the screen. More...
 
void drawInfo ()
 Draws performance related information on the screen. More...
 
void drawProfilingInfo ()
 Draws profiling graphs. More...
 
 PerformanceInfo (FrameTimeQueue &frameTimeQueue, Domain *domain, const PerformanceInfoProperties &properties)
 Constructor for HUD. More...
 
 PerformanceInfo (Domain *domain, KzuEngine *engine, ScreenSharedPtr screen, const PerformanceInfoProperties &properties)
 Constructor. More...
 
void setBorderColor (const ColorRGBA &borderColor)
 Sets the border color of the HUD info boxes. More...
 
void setFontColor (const ColorRGBA &fontColor)
 Sets the font color for drawing the HUD info. More...
 
void setLineColor (const ColorRGBA &lineColor)
 Sets the color of the lines used to draw the performance graphs. More...
 
void setTextTopLeft (int x, int y)
 Set the text top-left corner position. More...
 

Detailed Description

HUD class allows drawing information on top of tests.

Constructor & Destructor Documentation

kanzi::PerformanceInfo::PerformanceInfo ( FrameTimeQueue frameTimeQueue,
Domain domain,
const PerformanceInfoProperties properties 
)
explicit

Constructor for HUD.

Parameters
frameTimeQueueThe FrameTimeQueue from which to query the frame rate.
domainThe Application Domain.
propertiesProperties for the PerformanceInfo HUD to construct.
kanzi::PerformanceInfo::PerformanceInfo ( Domain domain,
KzuEngine engine,
ScreenSharedPtr  screen,
const PerformanceInfoProperties properties 
)
explicit

Constructor.

Deprecated:
In Kanzi 3.9.6. Use the constructor that does not take the deprecated KzuEngine pointer as a parameter.

Member Function Documentation

void kanzi::PerformanceInfo::drawFps ( )

Draws the FPS information on the screen.

void kanzi::PerformanceInfo::drawInfo ( )

Draws performance related information on the screen.

void kanzi::PerformanceInfo::drawProfilingInfo ( )

Draws profiling graphs.

void kanzi::PerformanceInfo::setFontColor ( const ColorRGBA fontColor)

Sets the font color for drawing the HUD info.

Parameters
fontColorThe ColorRGBA color value of the font
void kanzi::PerformanceInfo::setLineColor ( const ColorRGBA lineColor)

Sets the color of the lines used to draw the performance graphs.

Parameters
lineColorThe ColorRGBA color value for the graph lines
void kanzi::PerformanceInfo::setBorderColor ( const ColorRGBA borderColor)

Sets the border color of the HUD info boxes.

Parameters
borderColorThe ColorRGBA color value for the graph borders
void kanzi::PerformanceInfo::setTextTopLeft ( int  x,
int  y 
)

Set the text top-left corner position.

Parameters
xText x-position on the screen.
yText y-position on the screen.

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