Skip to content

TextStudio3DRuntimeOverrides

StructTextStudio.ThreeDTextStudio.3D
public readonly struct TextStudio3DRuntimeOverrides

Immutable, non-destructive runtime layer for visibility, depth, tint, material, and bounded quality overrides.

public TextStudio3DRuntimeOverrides WithVisibility(bool visible)

Returns a copy that overrides whether generated output is visible.

Parameters

Name Type
visible System.Boolean

Returns

TextStudio.ThreeD.TextStudio3DRuntimeOverrides

public TextStudio3DRuntimeOverrides WithDepthScale(float depthScale)

Returns a copy that scales generated depth around each glyph’s front anchor without changing authored layers.

Parameters

Name Type
depthScale System.Single

Returns

TextStudio.ThreeD.TextStudio3DRuntimeOverrides

Remarks

Non-finite values become one and negative values are clamped to zero.

public TextStudio3DRuntimeOverrides WithTint(Color32 tint)

Returns a copy that applies a common tint except where an explicit per-glyph tint has priority.

Parameters

Name Type
tint UnityEngine.Color32

Returns

TextStudio.ThreeD.TextStudio3DRuntimeOverrides

public TextStudio3DRuntimeOverrides WithMaterial(Material material)

Returns a copy that replaces every generated material region, or clears that override when material is null.

Parameters

Name Type
material UnityEngine.Material

Returns

TextStudio.ThreeD.TextStudio3DRuntimeOverrides

public TextStudio3DRuntimeOverrides WithQuality(int maximumBevelSegments, float curveToleranceMultiplier = 1)

Returns a copy with bounded runtime bevel detail and curve-tolerance multipliers.

Parameters

Name Type Description
maximumBevelSegments System.Int32 Maximum bevel subdivisions, clamped from one to 128.
curveToleranceMultiplier System.Single Tolerance multiplier clamped from 0.25 to four.

Returns

TextStudio.ThreeD.TextStudio3DRuntimeOverrides

Without(TextStudio3DRuntimeOverrideFields)

Section titled “Without(TextStudio3DRuntimeOverrideFields)”
public TextStudio3DRuntimeOverrides Without(TextStudio3DRuntimeOverrideFields fields)

Returns a copy with the selected override fields disabled, restoring their authored values.

Parameters

Name Type
fields TextStudio.ThreeD.TextStudio3DRuntimeOverrideFields

Returns

TextStudio.ThreeD.TextStudio3DRuntimeOverrides

public bool Has(TextStudio3DRuntimeOverrideFields fields)

Reports whether every requested field is active in this override value.

Parameters

Name Type
fields TextStudio.ThreeD.TextStudio3DRuntimeOverrideFields

Returns

System.Boolean

public bool Equals(TextStudio3DRuntimeOverrides other)

Parameters

Name Type
other TextStudio.ThreeD.TextStudio3DRuntimeOverrides

Returns

System.Boolean

public override bool Equals(object obj)

Parameters

Name Type
obj System.Object

Returns

System.Boolean

public override int GetHashCode()

Returns

System.Int32

public TextStudio3DRuntimeOverrideFields ActiveFields { get; }

Returns

TextStudio.ThreeD.TextStudio3DRuntimeOverrideFields

public bool Visible { get; }

Returns

System.Boolean

public float DepthScale { get; }

Returns

System.Single

public Color32 Tint { get; }

Returns

UnityEngine.Color32

public Material Material { get; }

Returns

UnityEngine.Material

public int MaximumBevelSegments { get; }

Returns

System.Int32

public float CurveToleranceMultiplier { get; }

Returns

System.Single