Kanzi  3.9.7
Kanzi Engine API
kanzi::TextLayout Struct Reference

Structure for layout of arbitrary number of characters for text rendering. More...

#include <kanzi/core.ui/text/text_layout.hpp>

Public Member Functions

 TextLayout (const FontRuntime &font)
 Constructor. More...
 
 ~TextLayout ()
 Destructor. More...
 

Public Attributes

float bottom
 Y axis coordinate of the bottom side of the text bounds. More...
 
unsigned int characterCount
 Number of characters. More...
 
vector< CharacterLayoutcharacters
 Layouted characters of the text. More...
 
const FontRuntimefont
 Font used for rendering the text. More...
 
float height
 Height of the text bounds. More...
 
float left
 X axis coordinate of the left side of the text bounds. More...
 
unsigned int lineCount
 Number of lines. More...
 
bool overlaps
 If at least two characters overlap, set to true. More...
 
float right
 X axis coordinate of the right side of the text bounds. More...
 
float top
 Y axis coordinate of the top side of the text bounds. More...
 
bool truncated
 If the text does not fit in the given maximum bounds, set to true. More...
 
float width
 Width of the text bounds. More...
 

Detailed Description

Structure for layout of arbitrary number of characters for text rendering.

Constructor & Destructor Documentation

kanzi::TextLayout::TextLayout ( const FontRuntime font)
explicit

Constructor.

Parameters
fontFont used for the layout.
kanzi::TextLayout::~TextLayout ( )

Destructor.

Member Data Documentation

vector<CharacterLayout> kanzi::TextLayout::characters

Layouted characters of the text.

const FontRuntime& kanzi::TextLayout::font

Font used for rendering the text.

float kanzi::TextLayout::left

X axis coordinate of the left side of the text bounds.

float kanzi::TextLayout::top

Y axis coordinate of the top side of the text bounds.

float kanzi::TextLayout::right

X axis coordinate of the right side of the text bounds.

float kanzi::TextLayout::bottom

Y axis coordinate of the bottom side of the text bounds.

float kanzi::TextLayout::width

Width of the text bounds.

float kanzi::TextLayout::height

Height of the text bounds.

unsigned int kanzi::TextLayout::lineCount

Number of lines.

unsigned int kanzi::TextLayout::characterCount

Number of characters.

bool kanzi::TextLayout::truncated

If the text does not fit in the given maximum bounds, set to true.

bool kanzi::TextLayout::overlaps

If at least two characters overlap, set to true.


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