UiTextComponent::DrawBatchLines Struct Reference

#include <UiTextComponent.h>

Public Member Functions
void	Clear ()
	Clears the batch lines list and releases any Font Family references.

Public Attributes
DrawBatchLineContainer	batchLines
	List of batch lines for drawing, each implicitly separated by a newline.
FontFamilyRefSet	fontFamilyRefs
	Set of strongly referenced Font Family objects used by draw batches.
InlineImageContainer	inlineImages
	List of images used by draw batches.
float	height
	The accumulated height of all the batch lines.
float	baseline
	The baseline to use when aligning images. Offset from the y draw position of the text.
AZ::Vector2	fontSizeScale = AZ::Vector2(1.0f, 1.0f)
	A scale that gets applied to the font size when using shrink-to-fit.
bool	m_fontEffectHasTransparency = false

Detailed Description

A collection of batch lines used for multi-line rendering of DrawBatch objects. A single line of text contains a list of batches, and multi-line rendering requires a list of multiple lines of draw batches.

Since different Font Familys can be referenced batch-to-batch, we hold a strong reference (shared_ptr) for each Font Family that's referenced. Once this struct goes out of scope, or is cleared, the references are freed.

---

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

• Gems/LyShine/Code/Source/UiTextComponent.h