Base class for text implementations that depend on the backend.
More...
#include <TGUI/Backend/Renderer/BackendText.hpp>
|
|
using | TextVertexData = std::vector<std::pair<std::shared_ptr<BackendTexture>, std::shared_ptr<std::vector<Vertex>>>> |
| | Type of the data that is passed to BackendRenderTarget where the actual rendering happens.
|
| |
|
|
void | updateVertices () |
| |
|
void | addGlyphQuad (std::vector< Vertex > &vertices, Vector2f position, const Vertex::Color &color, const FontGlyph &glyph, float fontScale, float italicShear) |
| |
|
void | addLine (std::vector< Vertex > &vertices, float lineLength, float lineTop, const Vertex::Color &color, float offset, float thickness, float outlineThickness, float fontScale) |
| |
Base class for text implementations that depend on the backend.
◆ findCharacterPos()
| virtual Vector2f tgui::BackendText::findCharacterPos |
( |
std::size_t | index | ) |
const |
|
nodiscardvirtual |
Returns the top-left position of the character at the provided index.
- Parameters
-
| index | Index of the character for which the position should be returned |
◆ getCharacterSize()
| unsigned int tgui::BackendText::getCharacterSize |
( |
| ) |
const |
|
nodiscard |
Returns the character size of the text.
- Returns
- The current text size
◆ getFillColor()
| Color tgui::BackendText::getFillColor |
( |
| ) |
const |
|
nodiscard |
Returns the text fill color.
- Returns
- text color
◆ getFont()
| std::shared_ptr< BackendFont > tgui::BackendText::getFont |
( |
| ) |
const |
|
nodiscard |
Returns the font of the text.
- Returns
- text font
◆ getOutlineColor()
| Color tgui::BackendText::getOutlineColor |
( |
| ) |
const |
|
nodiscard |
Returns the text outline color.
- Returns
- outline color
◆ getOutlineThickness()
| float tgui::BackendText::getOutlineThickness |
( |
| ) |
const |
|
nodiscard |
Returns the text outline thickness.
- Returns
- text outline thickness
◆ getSize()
| virtual Vector2f tgui::BackendText::getSize |
( |
| ) |
|
|
nodiscardvirtual |
Returns the size of the text.
- Returns
- Size of the bounding box around the text
◆ getString()
| const String & tgui::BackendText::getString |
( |
| ) |
const |
|
nodiscard |
Returns the text.
- Returns
- The current text
◆ getStyle()
Returns the style of the text.
- Returns
- The current text style
◆ getVertexData()
| TextVertexData tgui::BackendText::getVertexData |
( |
bool | includeOutline = true, |
|
|
bool | includeText = true ) |
|
nodiscard |
Returns the information that is needed to render this text.
- Parameters
-
| includeOutline | Should the returned data include the text outline? |
| includeText | Should the returned data include the text itself (i.e. everything except the outline)? |
- Returns
- Data that contains the textures and vertices used by this text
◆ setCharacterSize()
| virtual void tgui::BackendText::setCharacterSize |
( |
unsigned int | characterSize | ) |
|
|
virtual |
Sets the size of the characters.
- Parameters
-
| characterSize | Maximum size available for characters above the baseline |
◆ setFillColor()
| virtual void tgui::BackendText::setFillColor |
( |
const Color & | color | ) |
|
|
virtual |
Changes the color of the text.
- Parameters
-
◆ setFont()
| virtual void tgui::BackendText::setFont |
( |
const std::shared_ptr< BackendFont > & | font | ) |
|
|
virtual |
Changes the font used by the text.
- Parameters
-
◆ setOutlineColor()
| virtual void tgui::BackendText::setOutlineColor |
( |
const Color & | color | ) |
|
|
virtual |
Changes the color of the text outline.
- Parameters
-
◆ setOutlineThickness()
| virtual void tgui::BackendText::setOutlineThickness |
( |
float | thickness | ) |
|
|
virtual |
Changes the thickness of the text outline.
- Parameters
-
◆ setString()
| virtual void tgui::BackendText::setString |
( |
const String & | string | ) |
|
|
virtual |
Changes the text.
- Parameters
-
| string | Text that should be displayed |
◆ setStyle()
| virtual void tgui::BackendText::setStyle |
( |
TextStyles | style | ) |
|
|
virtual |
Changes the text style.
- Parameters
-
The documentation for this class was generated from the following file: