Docsv2.12.12
Back to API Reference
Struct

TextProcessSettings

sealed

Configuration settings for text processing operations.

Remarks

This struct encapsulates all parameters needed by TextProcessor to process, shape, and lay out Unicode text. It combines layout settings with text-specific options like font size and base direction.
public float MaxWidth{ get; set }

Gets or sets the maximum width for text layout.

public float MaxHeight{ get; set }

Gets or sets the maximum height for text layout.

public HorizontalAlignment HorizontalAlignment{ get; set }

Gets or sets the horizontal text alignment.

public VerticalAlignment VerticalAlignment{ get; set }

Gets or sets the vertical text alignment.

public TextJustify TextJustify{ get; set }

Gets or sets how extra horizontal space is distributed when HorizontalAlignment is Justify.

public LastLineAlignment LastLineAlignment{ get; set }

Gets or sets how paragraph-terminating lines are aligned when HorizontalAlignment is Justify.

public float LineSpacing{ get; set }

Gets or sets the additional spacing between lines.

public TextOverEdge OverEdge{ get; set }

Gets or sets the top edge metric for text box trimming.

public TextUnderEdge UnderEdge{ get; set }

Gets or sets the bottom edge metric for text box trimming.

public LeadingDistribution LeadingDistribution{ get; set }

Gets or sets how extra leading from line-height is distributed.

public LineHeightMode LineHeightMode{ get; set }

Gets or sets how each line's height is determined relative to the fonts it contains.

public float LineHeightScale{ get; set }

Gets or sets the line height as a multiple of font size, used when LineHeightMode is Scaled.

public static const float FloatMax

Maximum float value used to represent unlimited width or height.

public LayoutSettings layout

Layout settings including alignment, max dimensions, and spacing.

public float fontSize

Font size in points for text rendering.

public TextDirection baseDirection

Base paragraph direction for bidirectional text processing.

public bool enableWordWrap

Gets or sets a value indicating whether word wrapping is enabled.

See Also

TextProcessorLayoutSettings
Back to API Reference