Text layouter is used for laying out text to a constrained area. More...
#include <kanzi/core/legacy/debug/kzs_error.hpp>#include <kanzi/core/legacy/kzs_types.hpp>#include <kanzi/core/legacy/wrappers/kzs_math.hpp>Classes | |
| class | TextConcept |
Namespaces | |
| kanzi | |
Functions | |
| KANZI_API kzsError | kzuTextLayouterDelete (struct KzuTextLayouter *textLayouter) |
| Deletes the text layouter. More... | |
| KANZI_API void | kzuTextLayouterSetMaximumWidth (struct KzuTextLayouter *textLayouter, kzFloat width) |
| Sets the maximum width in pixels for the text layout area. More... | |
| kzFloat | kzuTextLayouterGetMaximumWidth (const struct KzuTextLayouter *textLayouter) |
| Gets the maximum width in pixels for the text layout area. More... | |
| void | kzuTextLayouterSetMaximumCharactersPerLine (struct KzuTextLayouter *textLayouter, kzUint charactersPerLine) |
| Sets the maximum number of characters per line for the text layout area. More... | |
| void | kzuTextLayouterSetMaximumHeight (struct KzuTextLayouter *textLayouter, kzFloat height) |
| Sets the maximum height in pixels for the layout. More... | |
| kzFloat | kzuTextLayouterGetMaximumHeight (const struct KzuTextLayouter *textLayouter) |
| Gets the maximum height in pixels for the text layout area. More... | |
| void | kzuTextLayouterSetMaximumLines (struct KzuTextLayouter *textLayouter, kzUint maximumLines) |
| Sets the maximum number of lines for the layout. More... | |
| kzsError | kzuTextLayouterSetTerminator (struct KzuTextLayouter *textLayouter, kzString terminator) |
| Sets the terminator string used when both horizontal and vertical space is running out for the text layout. More... | |
| kzString | kzuTextLayouterGetTerminator (const struct KzuTextLayouter *textLayouter) |
| Gets the terminator string used when both horizontal and vertical space is running out for the text layout. More... | |
| KANZI_API void | kzuTextLayouterSetHorizontalAlignment (struct KzuTextLayouter *textLayouter, TextConcept::TextHorizontalAlignment alignment) |
| Sets the horizontal alignment of the text. More... | |
| KANZI_API void | kzuTextLayouterSetVerticalAlignment (struct KzuTextLayouter *textLayouter, TextConcept::TextVerticalAlignment alignment) |
| Sets the vertical alignment of the text. More... | |
| void | kzuTextLayouterSetLineSpacing (struct KzuTextLayouter *textLayouter, kzFloat lineSpacing) |
| Sets the line spacing. More... | |
| kzFloat | kzuTextLayouterGetLineSpacing (const struct KzuTextLayouter *textLayouter) |
| Gets the line spacing. More... | |
| void | kzuTextLayouterSetCharacterSpacing (struct KzuTextLayouter *textLayouter, kzFloat characterSpacing) |
| Sets the character spacing. More... | |
| kzFloat | kzuTextLayouterGetCharacterSpacing (const struct KzuTextLayouter *textLayouter) |
| Gets the character spacing. More... | |
| void | kzuTextLayouterSetFixedCharacterWidth (struct KzuTextLayouter *textLayouter, kzFloat fixedCharacterWidth) |
| Sets the fixed character width. More... | |
| kzFloat | kzuTextLayouterGetFixedCharacterWidth (const struct KzuTextLayouter *textLayouter) |
| Gets the fixed character width. More... | |
| void | kzuTextLayouterSetBidiShapingEnabled (struct KzuTextLayouter *textLayouter, kzBool bidiShapingEnabled) |
| Sets whether support for complex scripts is enabled. More... | |
| KANZI_API kzsError | kzuTextLayouterCreateLayout (const struct KzuTextLayouter *textLayouter, const struct KzcMemoryManager *memoryManager, kzString text, struct KzuTextLayout **out_textLayout) |
| Lays out the given text using the given text layouter. More... | |
| kzsError | kzuTextLayouterDrawText (const struct KzuTextLayouter *textLayouter, const struct KzcMemoryManager *memoryManager, kanzi::Renderer *renderer, kzString text, kzFloat x, kzFloat y) |
| Helper function for performing the layout and drawing the result on the screen. More... | |
| kzsError | kzuTextLayouterDrawText3D (const struct KzuTextLayouter *textLayouter, const struct KzcMemoryManager *memoryManager, kanzi::Renderer *renderer, kzString text) |
| Helper function for performing the layout and drawing the result to 3D space. More... | |
| struct KzuFont * | kzuTextLayoutGetFont (const struct KzuTextLayout *textLayout) |
| Gets the font used for the text layout. More... | |
| KANZI_API kzsError | kzuTextLayoutDelete (struct KzuTextLayout *textLayout) |
| Deletes the text layout. More... | |
Text layouter is used for laying out text to a constrained area.
The text is splitted to several lines when necessary.
Below is a common use scenario for the text layouting. initialization: result = kzuBasicTextLayouterCreate(memoryManager, font, &textLayouter); kzsErrorForward(result);
Optionally set text layout parameters such as alignment and maximum bounds
when the text has changed or in initialization for static text: result = kzuTextLayouterCreateLayout(textLayouter, memoryManager, text, &textLayout); kzsErrorForward(result);
result = kzuFontPrepareTextLayout(textLayout, renderer); kzsErrorForward(result);
rendering: result = kzuFontDrawTextLayout(textLayout, renderer, x, y); kzsErrorForward(result);
uninitialization: result = kzuTextLayoutDelete(textLayout); kzsErrorForward(result);
result = kzuTextLayouterDelete(textLayouter); kzsErrorForward(result); Text layouter can also be deleted already right after the text layout is created.
Copyright 2008-2017 by Rightware. All rights reserved.
| KANZI_API kzsError kzuTextLayouterDelete | ( | struct KzuTextLayouter * | textLayouter | ) |
Deletes the text layouter.
| KANZI_API void kzuTextLayouterSetMaximumWidth | ( | struct KzuTextLayouter * | textLayouter, |
| kzFloat | width | ||
| ) |
Sets the maximum width in pixels for the text layout area.
Note that at least one character per line will always be layouted. Use KZS_INFINITY for unlimited width.
| kzFloat kzuTextLayouterGetMaximumWidth | ( | const struct KzuTextLayouter * | textLayouter | ) |
Gets the maximum width in pixels for the text layout area.
| void kzuTextLayouterSetMaximumCharactersPerLine | ( | struct KzuTextLayouter * | textLayouter, |
| kzUint | charactersPerLine | ||
| ) |
Sets the maximum number of characters per line for the text layout area.
| void kzuTextLayouterSetMaximumHeight | ( | struct KzuTextLayouter * | textLayouter, |
| kzFloat | height | ||
| ) |
Sets the maximum height in pixels for the layout.
Note that at least one line will always be layouted. Use KZS_INFINITY for unlimited height.
| kzFloat kzuTextLayouterGetMaximumHeight | ( | const struct KzuTextLayouter * | textLayouter | ) |
Gets the maximum height in pixels for the text layout area.
| void kzuTextLayouterSetMaximumLines | ( | struct KzuTextLayouter * | textLayouter, |
| kzUint | maximumLines | ||
| ) |
Sets the maximum number of lines for the layout.
| kzsError kzuTextLayouterSetTerminator | ( | struct KzuTextLayouter * | textLayouter, |
| kzString | terminator | ||
| ) |
Sets the terminator string used when both horizontal and vertical space is running out for the text layout.
| kzString kzuTextLayouterGetTerminator | ( | const struct KzuTextLayouter * | textLayouter | ) |
Gets the terminator string used when both horizontal and vertical space is running out for the text layout.
| KANZI_API void kzuTextLayouterSetHorizontalAlignment | ( | struct KzuTextLayouter * | textLayouter, |
| TextConcept::TextHorizontalAlignment | alignment | ||
| ) |
Sets the horizontal alignment of the text.
| KANZI_API void kzuTextLayouterSetVerticalAlignment | ( | struct KzuTextLayouter * | textLayouter, |
| TextConcept::TextVerticalAlignment | alignment | ||
| ) |
Sets the vertical alignment of the text.
| void kzuTextLayouterSetLineSpacing | ( | struct KzuTextLayouter * | textLayouter, |
| kzFloat | lineSpacing | ||
| ) |
Sets the line spacing.
The value is relative to the font height, for example 1 is normal spacing and 2 is double spacing.
| kzFloat kzuTextLayouterGetLineSpacing | ( | const struct KzuTextLayouter * | textLayouter | ) |
Gets the line spacing.
| void kzuTextLayouterSetCharacterSpacing | ( | struct KzuTextLayouter * | textLayouter, |
| kzFloat | characterSpacing | ||
| ) |
Sets the character spacing.
The value is relative to the character advance, for example 1 is the normal advance and 2 is double advance.
| kzFloat kzuTextLayouterGetCharacterSpacing | ( | const struct KzuTextLayouter * | textLayouter | ) |
Gets the character spacing.
| void kzuTextLayouterSetFixedCharacterWidth | ( | struct KzuTextLayouter * | textLayouter, |
| kzFloat | fixedCharacterWidth | ||
| ) |
Sets the fixed character width.
To disable the feature, set to a non-positive value.
| kzFloat kzuTextLayouterGetFixedCharacterWidth | ( | const struct KzuTextLayouter * | textLayouter | ) |
Gets the fixed character width.
| void kzuTextLayouterSetBidiShapingEnabled | ( | struct KzuTextLayouter * | textLayouter, |
| kzBool | bidiShapingEnabled | ||
| ) |
Sets whether support for complex scripts is enabled.
This includes support for bi-directional text and languages that require ligatures.
| KANZI_API kzsError kzuTextLayouterCreateLayout | ( | const struct KzuTextLayouter * | textLayouter, |
| const struct KzcMemoryManager * | memoryManager, | ||
| kzString | text, | ||
| struct KzuTextLayout ** | out_textLayout | ||
| ) |
Lays out the given text using the given text layouter.
The returned text layout can be directly rendered with the associated font or the layout information can be read from the structure.
| kzsError kzuTextLayouterDrawText | ( | const struct KzuTextLayouter * | textLayouter, |
| const struct KzcMemoryManager * | memoryManager, | ||
| kanzi::Renderer * | renderer, | ||
| kzString | text, | ||
| kzFloat | x, | ||
| kzFloat | y | ||
| ) |
Helper function for performing the layout and drawing the result on the screen.
If the same text is rendered more than once, the layout and drawing should be done separately. Parameters x and y specifies where the text layout is drawn and depends on the specified alignments of the text layouter.
| kzsError kzuTextLayouterDrawText3D | ( | const struct KzuTextLayouter * | textLayouter, |
| const struct KzcMemoryManager * | memoryManager, | ||
| kanzi::Renderer * | renderer, | ||
| kzString | text | ||
| ) |
Helper function for performing the layout and drawing the result to 3D space.
If the same text is rendered more than once, the layout and drawing should be done separately.
| struct KzuFont* kzuTextLayoutGetFont | ( | const struct KzuTextLayout * | textLayout | ) |
Gets the font used for the text layout.
| KANZI_API kzsError kzuTextLayoutDelete | ( | struct KzuTextLayout * | textLayout | ) |
Deletes the text layout.