struct TextSpriteInformation

Inherits: SpriteInformation

Information for initializing or updating a text sprite.

Public

Constructors

TextSpriteInformation

TextSpriteInformation() = default

Methods

InitializeFromStyleSheetRules

void InitializeFromStyleSheetRules(const GUIStyleSheetRules &rules)

Initializes the sprite information from data provided by the style sheet.

Fields

Anchor

Determines how to anchor the text within the bounds.

Text

String Text

UTF-8 encoded text to generate geometry for.

Font

HFont Font

Font containing the data about character glyphs.

FontSize

float FontSize

Size of the font to use when displaying the text, in points.

HorzAlign

Specifies how is text horizontally aligned within its bounds.

VertAlign

Specifies how is text vertically aligned within its bounds.

WordWrap

bool WordWrap

If true the text will word wrap when it doesn't fit, otherwise it will overflow.

WordBreak

bool WordBreak

If enabled together with word wrap it will allow words to be broken if they don't fit.

Size

Size2I Size

Size of the sprite in pixels.

Transparent

bool Transparent

Should the sprite be rendered with transparency.

Color

Color tint to apply to the sprite.