Kanzi 3.9.10
kanzi::CharacterLayout Struct Reference

Structure for layout of a single character for text rendering. More...

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

Public Attributes

bool addedDuringLayouting
 Flag to determine whether character is part of the input text, or it was added during layouting, for example, due to overflow.
 
unsigned int character
 Character glyph index in a font.
 
unsigned int clusterEnd
 Index of the character in the input text that starts the next cluster, or length of the input text if this is the last cluster.
 
unsigned int clusterStart
 Index of the first character in the input text that is part of this cluster.
 
bool leftToRight
 True if the character has left-to-right layout, false otherwise.
 
float x
 X axis coordinate of the left side of a character.
 
float y
 Y axis coordinate of the bottom of a character.
 

Detailed Description

Structure for layout of a single character for text rendering.

Member Data Documentation

◆ x

float kanzi::CharacterLayout::x

X axis coordinate of the left side of a character.

◆ y

float kanzi::CharacterLayout::y

Y axis coordinate of the bottom of a character.

◆ character

unsigned int kanzi::CharacterLayout::character

Character glyph index in a font.

◆ clusterStart

unsigned int kanzi::CharacterLayout::clusterStart

Index of the first character in the input text that is part of this cluster.

See https://harfbuzz.github.io/clusters.html for more information.

Since
Kanzi 3.9.0

◆ clusterEnd

unsigned int kanzi::CharacterLayout::clusterEnd

Index of the character in the input text that starts the next cluster, or length of the input text if this is the last cluster.

Since
Kanzi 3.9.0

◆ leftToRight

bool kanzi::CharacterLayout::leftToRight

True if the character has left-to-right layout, false otherwise.

Since
Kanzi 3.9.0

◆ addedDuringLayouting

bool kanzi::CharacterLayout::addedDuringLayouting

Flag to determine whether character is part of the input text, or it was added during layouting, for example, due to overflow.

This is set to true if the character was added during layouting and false if the character is part of the input text.

Since
Kanzi 3.9.0

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