kanzi::PerformanceInfo Class Reference

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

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

Public Types
using	DrawValues
	Draw value listing.
using	DrawValuesRegistry
	Registry for draw values.

Public Member Functions
void	drawFps ()
	Draws the FPS information on the screen.
void	drawFrameProfilingSamples (Renderer &renderer, float graphX, float graphY, float graphWidth, float graphHeight, const DrawValues &drawValues, float minValue, float maxValue, const MaterialSharedPtr &material, const ColorRGBA &lineColor, const ColorRGBA &borderColor)
	Draws frame profiling samples (one set) for the performance info.
void	drawGraph (Renderer &renderer, float x, float y, float width, float height, BrushRenderer *brushRenderer, kanzi::TextFormat *textFormat, const DrawValues &drawValues, const char *name, const MaterialSharedPtr &graphMaterial, const ColorRGBA &lineColor, const ColorRGBA &borderColor)
	Draws graph including the profiling samples.
void	drawGraphicsInfo ()
	Draws Kanzi graphics related information on the screen.
void	drawInfo ()
	Draws performance related information on the screen.
void	drawProfilingInfo ()
	Draws profiling graphs.
	PerformanceInfo (const 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.

Static Public Attributes
static const size_t	s_numIterationsToDraw
	Number of iterations to draw.

Detailed Description

HUD class allows drawing information on top of tests.

Member Typedef Documentation

DrawValues

using kanzi::PerformanceInfo::DrawValues

Draw value listing.

Since

Kanzi 4.0.0

DrawValuesRegistry

using kanzi::PerformanceInfo::DrawValuesRegistry

Registry for draw values.

Since

Kanzi 4.0.0

Constructor & Destructor Documentation

PerformanceInfo()

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

explicit

Constructor for HUD.

Parameters

frameTimeQueue	The FrameTimeQueue from which to query the frame rate.
domain	The Application Domain.
properties	Properties for the PerformanceInfo HUD to construct.

Since

Kanzi 4.0.0 changed the type of the frameTimeQueue parameter to const FrameTimeQueue&.

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.

drawGraphicsInfo()

void kanzi::PerformanceInfo::drawGraphicsInfo

(

)

Draws Kanzi graphics related information on the screen.

drawProfilingInfo()

void kanzi::PerformanceInfo::drawProfilingInfo

(

)

Draws profiling graphs.

drawGraph()

void kanzi::PerformanceInfo::drawGraph	(	Renderer &	renderer,
		float	x,
		float	y,
		float	width,
		float	height,
		BrushRenderer *	brushRenderer,
		kanzi::TextFormat *	textFormat,
		const DrawValues &	drawValues,
		const char *	name,
		const MaterialSharedPtr &	graphMaterial,
		const ColorRGBA &	lineColor,
		const ColorRGBA &	borderColor )

Draws graph including the profiling samples.

Parameters

renderer	Renderer to use.
x	Graph X position.
y	Graph Y position.
width	Graph width.
height	Graph height.
brushRenderer	Brush renderer to use for text.
textFormat	Text format to use for rendering text.
drawValues	Sample values to draw.
name	Name label for the graph.
graphMaterial	Material to use for drawing.
lineColor	Color for the drawn graph lines.
borderColor	Color for the drawn border lines.

Since

Kanzi 4.0.0

drawFrameProfilingSamples()

void kanzi::PerformanceInfo::drawFrameProfilingSamples	(	Renderer &	renderer,
		float	graphX,
		float	graphY,
		float	graphWidth,
		float	graphHeight,
		const DrawValues &	drawValues,
		float	minValue,
		float	maxValue,
		const MaterialSharedPtr &	material,
		const ColorRGBA &	lineColor,
		const ColorRGBA &	borderColor )

Draws frame profiling samples (one set) for the performance info.

Parameters

renderer	Renderer to use.
graphX	Graph X position.
graphY	Graph Y position.
graphWidth	Graph width.
graphHeight	Graph height.
drawValues	Sample values to draw.
minValue	Minimum value in the set.
maxValue	Maximum value in the set.
material	Material to use for drawing.
lineColor	Color for the drawn graph lines.
borderColor	Color for the drawn border lines.

Since

Kanzi 4.0.0 changed the type of the renderer parameter to Renderer&.

setFontColor()

void kanzi::PerformanceInfo::setFontColor

(

const ColorRGBA &

fontColor

)

Sets the font color for drawing the HUD info.

Parameters

fontColor

The 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

lineColor

The 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

borderColor

The ColorRGBA color value for the graph borders

setTextTopLeft()

void kanzi::PerformanceInfo::setTextTopLeft	(	int	x,
		int	y )

Set the text top-left corner position.

Parameters

x	Text x-position on the screen.
y	Text y-position on the screen.

Member Data Documentation

s_numIterationsToDraw

const size_t kanzi::PerformanceInfo::s_numIterationsToDraw

static

Number of iterations to draw.

Since

Kanzi 4.0.0

---

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

• kanzi/core.ui/application/performance_info.hpp