tgui::BackendText Class Reference

Base class for text implementations that depend on the backend. More...

#include <TGUI/Backend/Renderer/BackendText.hpp>

Public Types
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.

Public Member Functions
virtual	~BackendText ()=default
	Virtual destructor.
virtual Vector2f	getSize ()
	Returns the size of the text. More...
virtual void	setString (const String &string)
	Changes the text. More...
const String &	getString () const
	Returns the text. More...
virtual void	setCharacterSize (unsigned int characterSize)
	Sets the size of the characters. More...
unsigned int	getCharacterSize () const
	Returns the character size of the text. More...
virtual void	setFillColor (const Color &color)
	Changes the color of the text. More...
Color	getFillColor () const
	Returns the text fill color. More...
virtual void	setOutlineColor (const Color &color)
	Changes the color of the text outline. More...
Color	getOutlineColor () const
	Returns the text outline color. More...
virtual void	setOutlineThickness (float thickness)
	Changes the thickness of the text outline. More...
float	getOutlineThickness () const
	Returns the text outline thickness. More...
virtual void	setStyle (TextStyles style)
	Changes the text style. More...
TextStyles	getStyle () const
	Returns the style of the text. More...
virtual void	setFont (const std::shared_ptr< BackendFont > &font)
	Changes the font used by the text. More...
std::shared_ptr< BackendFont >	getFont () const
	Returns the font of the text. More...
virtual Vector2f	findCharacterPos (std::size_t index) const
	Returns the top-left position of the character at the provided index. More...
TextVertexData	getVertexData ()
	Returns the information that is needed to render this text. More...

Protected Member Functions
void	updateVertices ()
void	addGlyphQuad (std::vector< Vertex > &vertices, Vector2f position, const Vertex::Color &color, const FontGlyph &glyph, float italicShear)
void	addLine (std::vector< Vertex > &vertices, float lineLength, float lineTop, const Vertex::Color &color, float offset, float thickness, float outlineThickness)

Protected Attributes
std::shared_ptr< BackendFont >	m_font
BackendTexture *	m_lastFontTexture = nullptr
String	m_string
unsigned int	m_characterSize = getGlobalTextSize()
Color	m_fillColor
Color	m_outlineColor
float	m_outlineThickness = 0
TextStyles	m_style = TextStyle::Regular
Vector2f	m_size
std::shared_ptr< std::vector< Vertex > >	m_vertices
std::shared_ptr< std::vector< Vertex > >	m_outlineVertices
bool	m_verticesNeedUpdate = true

Detailed Description

Base class for text implementations that depend on the backend.

Member Function Documentation

findCharacterPos()

virtual Vector2f tgui::BackendText::findCharacterPos ( std::size_t  index ) const

virtual

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

Returns the character size of the text.

Returns

The current text size

getFillColor()

Color tgui::BackendText::getFillColor

(

)

const

Returns the text fill color.

Returns

text color

getFont()

std::shared_ptr< BackendFont > tgui::BackendText::getFont

(

)

const

Returns the font of the text.

Returns

text font

getOutlineColor()

Color tgui::BackendText::getOutlineColor

(

)

const

Returns the text outline color.

Returns

outline color

getOutlineThickness()

float tgui::BackendText::getOutlineThickness

(

)

const

Returns the text outline thickness.

Returns

text outline thickness

getSize()

virtual Vector2f tgui::BackendText::getSize ( )

virtual

Returns the size of the text.

Returns

Size of the bounding box around the text

getString()

const String & tgui::BackendText::getString

(

)

const

Returns the text.

Returns

The current text

getStyle()

TextStyles tgui::BackendText::getStyle

(

)

const

Returns the style of the text.

Returns

The current text style

getVertexData()

TextVertexData tgui::BackendText::getVertexData

(

)

Returns the information that is needed to render this text.

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

color

Text color

setFont()

virtual void tgui::BackendText::setFont ( const std::shared_ptr< BackendFont > &  font )

virtual

Changes the font used by the text.

Parameters

font	New text font

setOutlineColor()

virtual void tgui::BackendText::setOutlineColor ( const Color &  color )

virtual

Changes the color of the text outline.

Parameters

color

Outline color

setOutlineThickness()

virtual void tgui::BackendText::setOutlineThickness ( float  thickness )

virtual

Changes the thickness of the text outline.

Parameters

thickness

Outline thickness

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

style

New text style

---

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

• include/TGUI/Backend/Renderer/BackendText.hpp