Skip to content

TextRenderOptions Struct

Definition

Namespace: Brine2D.Rendering.Text

Options for text rendering with rich formatting support.

C#
public readonly struct TextRenderOptions
Properties
Color Default color if not specified in markup.
Font Default font \(null = use renderer's default font\).
FontSize Base font size in points.
HorizontalAlign Horizontal alignment within the max width.
LineSpacing Line spacing multiplier \(1\.0 = normal, 1\.5 = 150% spacing\).
MarkupParser The markup parser to use when ParseMarkup is true. If null, a default BBCode parser will be used.
MaxHeight Maximum height for vertical alignment \(null = no constraint\).
MaxWidth Maximum width before wrapping \(null = no wrap\).
OutlineColor Outline color \(only used if OutlineThickness \> 0\). Not yet implemented — reserved for future use.
OutlineThickness Outline thickness in pixels \(0 = no outline\). Not yet implemented — reserved for future use.
ParseMarkup Whether to parse markup tags. If false, text is rendered as-is \(including tags\).
ShadowColor Shadow color \(only used if ShadowOffset is set\).
ShadowOffset Shadow offset \(null = no shadow\).
VerticalAlign Vertical alignment within a bounding box \(requires MaxHeight\).