Struct TextLayoutOptions

Structure which describes text layout properties.

Assembly: FlaxEngine.dll

File: Engine/Render2D/TextLayoutOptions.h

Syntax

public struct TextLayoutOptions

Constructors

TextLayoutOptions()

Initializes a new instance of the TextLayoutOptions struct.

Declaration

public TextLayoutOptions()

Fields

BaseLinesGapScale

Base line gap scale. Default is 1.

Declaration

public float BaseLinesGapScale

Field Value

float

Bounds

The layout rectangle (text bounds).

Declaration

public Rectangle Bounds

Field Value

Rectangle

HorizontalAlignment

The horizontal alignment mode.

Declaration

public TextAlignment HorizontalAlignment

Field Value

TextAlignment

Scale

The text scale factor. Default is 1.

Declaration

public float Scale

Field Value

float

TextWrapping

The text wrapping mode.

Declaration

public TextWrapping TextWrapping

Field Value

TextWrapping

VerticalAlignment

The vertical alignment mode.

Declaration

public TextAlignment VerticalAlignment

Field Value

TextAlignment

Methods

operator!=(const TextLayoutOptions& other)

Declaration

public bool operator!=(const TextLayoutOptions& other) const

Parameters

TextLayoutOptions other

Returns

bool

operator==(const TextLayoutOptions& other)

Declaration

public bool operator==(const TextLayoutOptions& other) const

Parameters

TextLayoutOptions other

Returns

bool