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

Detailed Description

HUD class allows drawing information on top of tests.

Constructor & Destructor Documentation

◆ PerformanceInfo() [1/2]

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.

◆ PerformanceInfo() [2/2]

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

◆ drawFps()

void kanzi::PerformanceInfo::drawFps ( )

Draws the FPS information on the screen.

◆ drawInfo()

void kanzi::PerformanceInfo::drawInfo ( )

Draws performance related information on the screen.

◆ drawProfilingInfo()

void kanzi::PerformanceInfo::drawProfilingInfo ( )

Draws profiling graphs.

◆ setFontColor()

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

Sets the font color for drawing the HUD info.

Parameters
fontColorThe ColorRGBA color value of the font

◆ setLineColor()

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

◆ setBorderColor()

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

◆ setTextTopLeft()

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: