class GUILabel

GUI element that displays text and optionally a content image.

Public

Methods

staticGetGuiTypeName

static const String &GetGuiTypeName()

Returns type name of the GUI element used for finding GUI element styles.

SetContent

void SetContent(const GUIContent &content)

Changes the active content of the label.

staticCreate

static GUIElementType *Create(const ContentType &contents, const String &styleClass, const TInlineArray<GUIOption, 4> &options)

Creates a new GUI element.

contents
Structure describing the contents of the GUI element to create.
styleClass
Style class that will be used for determining GUI element visuals from the current style sheet. If no class is provided, default style is determined based on GUI element type.
options
Additional options that control GUI element size and position. This will override options set in the style sheet.

Internal

Constructors

GUILabel

GUILabel(PrivatelyConstruct, const GUIContent &content, const String &styleClass, const GUISizeConstraints &dimensions)

Methods

CalculateUnconstrainedOptimalSize

GUILogicalSize CalculateUnconstrainedOptimalSize() const override

Calculates the optimal size for the GUI element, ignoring size constraints.

GetStyleSheetElement

const char *GetStyleSheetElement() const override

Returns the name of the GUI element type to be used for style lookup in the style sheet.

Protected

Methods

~GUILabel

~GUILabel() noexcept

GetRenderElementDepthRange

u32 GetRenderElementDepthRange() const override

Returns the range of depths that the child elements can be rendered it.

UpdateRenderElements

void UpdateRenderElements() override

Recreates the internal render elements.

Must be called before GetRenderElementVertexAndIndexData/FillBuffer if element is dirty. Marks the element as non dirty.

Private

Fields

mContent

GUIContent mContent

mTextSprite

TextSprite * mTextSprite

mBackgroundSprite

GUIBackgroundSprite mBackgroundSprite

mTextSpriteInformation

TextSpriteInformation mTextSpriteInformation