Struct LabelTextFitInfo

Namespace

Forma

Assembly

Forma.dll

The result of TextFit: the fit and the measured and available text sizes.

public readonly struct LabelTextFitInfo

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

LabelTextFitInfo(LabelTextFit, Vector2, Vector2)

Creates a fit result.

public LabelTextFitInfo(LabelTextFit fit, Vector2 measured, Vector2 available)

Parameters

fit LabelTextFit

measured Vector2

available Vector2

Properties

Available

The size the label's content area has after padding.

public Vector2 Available { get; }

Property Value

Vector2

Fit

How the text relates to its box.

public LabelTextFit Fit { get; }

Property Value

LabelTextFit

Measured

The size the text needs (wrapped to the available width when the label autowraps).

public Vector2 Measured { get; }

Property Value

Vector2

Overflow

How far the text exceeds the content area, per axis; zero when it does not.

public Vector2 Overflow { get; }

Property Value

Vector2