Table of Contents

Class TextMeshOptions

Namespace
Stride.CommunityToolkit.Rendering.Text
Assembly
Stride.CommunityToolkit.dll

How TextMesh sizes, extrudes and lays out a string.

public sealed class TextMeshOptions
Inheritance
TextMeshOptions

Properties

Alignment

How lines of different widths line up with each other. Defaults to left.

public TextAlignment Alignment { get; set; }

Property Value

TextAlignment

Anchor

Which point of the text block sits at the origin. null, the default, is the typographic origin: the baseline of the first line at y = 0 and the pen at x = 0. The block is the font's ascent to its descent over every line, so the anchor does not move with the letters used.

public TextAnchor? Anchor { get; set; }

Property Value

TextAnchor?

Bevel

A rounded edge between the caps and the walls, front and back; null, the default, is a sharp edge. See TextBevel for the size, the thickness and the steps.

public TextBevel? Bevel { get; set; }

Property Value

TextBevel

CurveQuality

How many points a full turn of curve gets; see Flatten(int). Defaults to 32, which is smooth at letter sizes. Lower it for far-away or tiny lettering, raise it for a logo the camera gets close to.

public int CurveQuality { get; set; }

Property Value

int

Depth

How far the lettering extends along Z, centred on zero. Defaults to 0.25.

public float Depth { get; set; }

Property Value

float

Kerning

Whether to apply the font's pair kerning (AV, To). Defaults to on; it only takes effect for fonts with a kern table, see GetKerning(int, int).

public bool Kerning { get; set; }

Property Value

bool

LetterSpacing

Extra space after every glyph, in EM units; negative tightens. Defaults to 0.

public float LetterSpacing { get; set; }

Property Value

float

LineSpacing

The distance between lines as a multiple of the font's own line height. Defaults to 1.

public float LineSpacing { get; set; }

Property Value

float

Size

World units per EM: the height a font's design grid maps to, so a capital letter comes out about 0.7 of this tall. Defaults to 1.

public float Size { get; set; }

Property Value

float