Struct Text

Draws 3D text in the world.
Note that only basic ASCII characters plus a few extras are supported to keep the font atlas size to a minimum, though the character set can be customized if necessary - see DOC LINK HERE

public struct Text

Extension Methods

TextExtensions.Align(ref Text, TextAlign)

TextExtensions.Color(ref Text, Color?)

TextExtensions.FaceCamera(ref Text)

TextExtensions.Facing(ref Text, Facing)

TextExtensions.Position(ref Text, float3)

TextExtensions.Ref(Text)

TextExtensions.Rotation(ref Text, float)

TextExtensions.SetDefault(ref Text)

TextExtensions.Size(ref Text, Size)

TextExtensions.Text(ref Text, ReadOnlySpan<char>)

Fields

align

Controls how the text is positioned relative to its origin.

public TextAlign align

Field Value

TextAlign

color

The color of the text.

public Color? color

Field Value

Color?

defaultAlign

The default alignment for all text.

public static TextAlign defaultAlign

Field Value

TextAlign

facing

The facing direction of this text.

public Facing facing

Field Value

Facing

position

The position of this text.

public float3 position

Field Value

float3

size

The size of a line of text in world space.

public Size size

Field Value

Size

Properties

OutlineColor

Change the outline color for all text.
Only applicable when RenderStyle is set to Outline.

public static Color OutlineColor { get; set; }

Property Value

Color

OutlineWidth

Change the outline width for all text. Limited to the range (0..4).
Only applicable when RenderStyle is set to Outline.

public static float OutlineWidth { get; set; }

Property Value

float

RenderStyle

Sets the style for all text.

public static TextRenderStyle RenderStyle { get; set; }

Property Value

TextRenderStyle

ShadowColor

Change the shadow color for all text.
Only applicable when RenderStyle is set to DropShadow.

public static Color ShadowColor { get; set; }

Property Value

Color

ShadowOffset

Change the shadow offset for all text. Limited to the range (-2..2).
Only applicable when RenderStyle is set to DropShadow.

public static float2 ShadowOffset { get; set; }

Property Value

float2

ShadowWidth

Change the shadow width for all text. Limited to the range (0..2).
Only applicable when RenderStyle is set to DropShadow.

public static float ShadowWidth { get; set; }

Property Value

float

Methods

CalculateSize()

public float2 CalculateSize()

Returns

float2