Class TextLayoutOptions

Structure which describes text layout properties.

System.Object
TextLayoutOptions
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class TextLayoutOptions : ValueType

Fields

BaseLinesGapScale

Base line gap scale. Default is 1.

Declaration
[EditorOrder(50)]
[Limit(-1000F, 1000F, 0.01F)]
public float BaseLinesGapScale
Field Value
System.Single

Bounds

The layout rectangle (text bounds).

Declaration
[EditorOrder(0)]
public Rectangle Bounds
Field Value
Rectangle

HorizontalAlignment

The horizontal alignment mode.

Declaration
[EditorOrder(10)]
public TextAlignment HorizontalAlignment
Field Value
TextAlignment

Scale

The text scale factor. Default is 1.

Declaration
[EditorOrder(40)]
[Limit(-1000F, 1000F, 0.01F)]
public float Scale
Field Value
System.Single

TextWrapping

The text wrapping mode.

Declaration
[EditorOrder(30)]
public TextWrapping TextWrapping
Field Value
TextWrapping

VerticalAlignment

The vertical alignment mode.

Declaration
[EditorOrder(20)]
public TextAlignment VerticalAlignment
Field Value
TextAlignment

Properties

Default

Gets the default layout.

Declaration
public static TextLayoutOptions Default { get; }
Property Value
TextLayoutOptions

Extension Methods