LedTextSettings

StructLEDStudioLEDStudio

public struct LedTextSettings

Shared bitmap and font-texture text layout settings, including pixel sizing, fit, alignment, wrapping, line spacing, character spacing, and rasterization.

Fields

RenderMode

[Tooltip("Selects the internal bitmap renderer, TMP font renderer, or an optional external text backend.")]
public LedTextRenderMode RenderMode

Returns

LEDStudio.LedTextRenderMode

RasterizationMode

[Tooltip("Controls smoothing for TMP font rendering. This does not apply to the internal bitmap renderer.")]
public LedTextRasterizationMode RasterizationMode

Returns

LEDStudio.LedTextRasterizationMode

SizingMode

[Tooltip("Controls whether font-backed text uses a fixed size or fits within the source texture.")]
public LedTextSizingMode SizingMode

Returns

LEDStudio.LedTextSizingMode

TextSize

[Min(1)]
[Tooltip("Text height in source pixels for internal bitmap text and fixed-size font-backed text.")]
public float TextSize

Returns

System.Single

MinTextSize

[Min(1)]
[Tooltip("Smallest text size allowed while fitting font-backed text.")]
public float MinTextSize

Returns

System.Single

MaxTextSize

[Min(1)]
[Tooltip("Largest text size allowed while fitting font-backed text.")]
public float MaxTextSize

Returns

System.Single

LineSpacing

[Range(0.5, 2)]
[Tooltip("Multiplies the distance between font-backed text lines.")]
public float LineSpacing

Returns

System.Single

CharacterSpacing

[Range(-10, 20)]
[Tooltip("Adjusts horizontal spacing between characters. Internal bitmap text interprets the value as source pixels; negative values tighten or overlap glyphs.")]
public float CharacterSpacing

Returns

System.Single

Alignment

[Tooltip("Positions text within the source texture.")]
public TextAnchor Alignment

Returns

UnityEngine.TextAnchor

WordWrap

[Tooltip("Wraps font-backed text onto additional lines when it reaches the source width.")]
public bool WordWrap

Returns

System.Boolean

PixelPerfectFit

[Tooltip("Restricts fitted font-backed text to whole-pixel size steps for crisper output.")]
public bool PixelPerfectFit

Returns

System.Boolean

Methods

Normalized()

public LedTextSettings Normalized()

Returns a copy with valid text-size, fit-range, line-spacing, and character-spacing values.

Returns

LEDStudio.LedTextSettings

Equals(LedTextSettings)

public bool Equals(LedTextSettings other)

Parameters

Name	Type
other	LEDStudio.LedTextSettings

Returns

System.Boolean

Equals(object)

public override bool Equals(object obj)

Parameters

Name	Type
obj	System.Object

Returns

System.Boolean

GetHashCode()

public override int GetHashCode()

Returns

System.Int32

Operators

operator ==(LedTextSettings, LedTextSettings)

public static bool operator ==(LedTextSettings a, LedTextSettings b)

Determines whether two text configurations select the same modes and layout behavior, using Unity’s approximate comparison for numeric layout values.

Parameters

Name	Type
a	LEDStudio.LedTextSettings
b	LEDStudio.LedTextSettings

Returns

System.Boolean

operator !=(LedTextSettings, LedTextSettings)

public static bool operator !=(LedTextSettings a, LedTextSettings b)

Determines whether two text configurations differ in any mode, layout option, or numeric layout value.

Parameters

Name	Type
a	LEDStudio.LedTextSettings
b	LEDStudio.LedTextSettings

Returns

System.Boolean

Properties

Default

public static LedTextSettings Default { get; }

Returns

LEDStudio.LedTextSettings