Skip to content

TextStudio2DDecorationSpec

StructTextStudioTextStudio
public struct TextStudio2DDecorationSpec

Settings for decoration geometry, topology, reveal visibility, line patterns, and ordered surface treatments.

TextStudio2DDecorationSpec(TextStudio2DDecorationKind, float, float, Vector4, float)

Section titled “TextStudio2DDecorationSpec(TextStudio2DDecorationKind, float, float, Vector4, float)”
public TextStudio2DDecorationSpec(TextStudio2DDecorationKind kind, float thickness, float offset = 0, Vector4 padding = null, float cornerRadius = 0)

Creates a decoration specification with the supplied kind, thickness, offset, padding, and corner radius.

Parameters

NameType
kindTextStudio.TextStudio2DDecorationKind
thicknessSystem.Single
offsetSystem.Single
paddingUnityEngine.Vector4
cornerRadiusSystem.Single

WithPlateShape(float, TextStudio2DDecorationVerticalAnchor, TextStudio2DDecorationEndStyle, TextStudio2DDecorationEndStyle, float)

Section titled “WithPlateShape(float, TextStudio2DDecorationVerticalAnchor, TextStudio2DDecorationEndStyle, TextStudio2DDecorationEndStyle, float)”
public TextStudio2DDecorationSpec WithPlateShape(float plateHeight, TextStudio2DDecorationVerticalAnchor verticalAnchor, TextStudio2DDecorationEndStyle leftEnd, TextStudio2DDecorationEndStyle rightEnd, float capSize = 0)

Configures explicit plate height, anchor, end geometry, and cap size.

Parameters

NameType
plateHeightSystem.Single
verticalAnchorTextStudio.TextStudio2DDecorationVerticalAnchor
leftEndTextStudio.TextStudio2DDecorationEndStyle
rightEndTextStudio.TextStudio2DDecorationEndStyle
capSizeSystem.Single

Returns

TextStudio.TextStudio2DDecorationSpec

public TextStudio2DDecorationSpec WithPlateWidth(float plateWidth)

Returns a decoration specification copy with the supplied explicit plate width.

Parameters

NameType
plateWidthSystem.Single

Returns

TextStudio.TextStudio2DDecorationSpec

WithShape(TextStudio2DDecorationShape, Vector4, float, int, float)

Section titled “WithShape(TextStudio2DDecorationShape, Vector4, float, int, float)”
public TextStudio2DDecorationSpec WithShape(TextStudio2DDecorationShape shape, Vector4 cornerRadii = null, float squirclePower = 4, int polygonSides = 6, float starInset = 0.5)

Returns a decoration copy with the supplied shape, corner radii, squircle power, polygon sides, and star inset.

Parameters

NameType
shapeTextStudio.TextStudio2DDecorationShape
cornerRadiiUnityEngine.Vector4
squirclePowerSystem.Single
polygonSidesSystem.Int32
starInsetSystem.Single

Returns

TextStudio.TextStudio2DDecorationSpec

public TextStudio2DDecorationSpec WithCustomPolygon(Vector2[] points)

Returns a decoration copy configured as a custom polygon with independently copied points.

Parameters

NameType
pointsUnityEngine.Vector2[]

Returns

TextStudio.TextStudio2DDecorationSpec

public TextStudio2DDecorationSpec WithGlyphSilhouette(float padding, float bridgeRadius = 0, bool fillHoles = true)

Derives one retained backing from selected, posed font contours. Treatments apply to its union boundary.

Parameters

NameType
paddingSystem.Single
bridgeRadiusSystem.Single
fillHolesSystem.Boolean

Returns

TextStudio.TextStudio2DDecorationSpec

WithBackplateVisibility(TextStudio2DBackplateVisibility)

Section titled “WithBackplateVisibility(TextStudio2DBackplateVisibility)”
public TextStudio2DDecorationSpec WithBackplateVisibility(TextStudio2DBackplateVisibility visibility)

Returns a decoration specification copy with the supplied visibility behavior during text reveal and hiding.

Parameters

NameType
visibilityTextStudio.TextStudio2DBackplateVisibility

Returns

TextStudio.TextStudio2DDecorationSpec

WithTopology(TextStudio2DDecorationTopology, bool)

Section titled “WithTopology(TextStudio2DDecorationTopology, bool)”
public TextStudio2DDecorationSpec WithTopology(TextStudio2DDecorationTopology topology, bool acrossLineBreaks = false)

Returns a decoration copy with the supplied topology and connection behavior across line breaks.

Parameters

NameType
topologyTextStudio.TextStudio2DDecorationTopology
acrossLineBreaksSystem.Boolean

Returns

TextStudio.TextStudio2DDecorationSpec

WithTreatments(params TextStudio2DSurfaceTreatment[])

Section titled “WithTreatments(params TextStudio2DSurfaceTreatment[])”
public TextStudio2DDecorationSpec WithTreatments(params TextStudio2DSurfaceTreatment[] treatments)

Replaces the ordered surface treatments. Index zero is visually topmost.

Parameters

NameType
treatmentsTextStudio.TextStudio2DSurfaceTreatment[]

Returns

TextStudio.TextStudio2DDecorationSpec

public TextStudio2DSurfaceTreatment GetTreatment(int index)

Returns an independent copy of the surface treatment at the specified index, throwing if the index is invalid.

Parameters

NameType
indexSystem.Int32

Returns

TextStudio.TextStudio2DSurfaceTreatment

public TextStudio2DDecorationSpec WithLine(TextStudio2DDecorationLineSpec line)

Returns a decoration copy with the supplied line-pattern and font-metric settings.

Parameters

NameType
lineTextStudio.TextStudio2DDecorationLineSpec

Returns

TextStudio.TextStudio2DDecorationSpec

public Vector2 GetCustomPoint(int index)

Returns the custom polygon point at the specified index, throwing if the index is outside the point array.

Parameters

NameType
indexSystem.Int32

Returns

UnityEngine.Vector2

public TextStudio2DBackplateVisibility BackplateVisibility { get; }

Returns

TextStudio.TextStudio2DBackplateVisibility

public float GlyphPadding { get; }

Returns

System.Single

public float GlyphBridgeRadius { get; }

Returns

System.Single

public bool GlyphFillHoles { get; }

Returns

System.Boolean

public TextStudio2DDecorationKind Kind { get; }

Returns

TextStudio.TextStudio2DDecorationKind

public float Thickness { get; }

Returns

System.Single

public float Offset { get; }

Returns

System.Single

public Vector4 Padding { get; }

Returns

UnityEngine.Vector4

public float CornerRadius { get; }

Returns

System.Single

public float PlateHeight { get; }

Returns

System.Single

public float PlateWidth { get; }

Returns

System.Single

public TextStudio2DDecorationVerticalAnchor VerticalAnchor { get; }

Returns

TextStudio.TextStudio2DDecorationVerticalAnchor

public TextStudio2DDecorationEndStyle LeftEnd { get; }

Returns

TextStudio.TextStudio2DDecorationEndStyle

public TextStudio2DDecorationEndStyle RightEnd { get; }

Returns

TextStudio.TextStudio2DDecorationEndStyle

public float CapSize { get; }

Returns

System.Single

public TextStudio2DDecorationShape Shape { get; }

Returns

TextStudio.TextStudio2DDecorationShape

public Vector4 CornerRadii { get; }

Returns

UnityEngine.Vector4

public float SquirclePower { get; }

Returns

System.Single

public int PolygonSides { get; }

Returns

System.Int32

public float StarInset { get; }

Returns

System.Single

public int CustomPointCount { get; }

Returns

System.Int32

public TextStudio2DDecorationTopology Topology { get; }

Returns

TextStudio.TextStudio2DDecorationTopology

public bool ConnectAcrossLineBreaks { get; }

Returns

System.Boolean

public int TreatmentCount { get; }

Returns

System.Int32

public TextStudio2DDecorationLineSpec Line { get; }

Returns

TextStudio.TextStudio2DDecorationLineSpec