ITextStudio3DGlyphs

InterfaceTextStudio.ThreeDTextStudio.3D

public interface ITextStudio3DGlyphs

Focused stable-handle contract for querying and changing generated glyph output.

Methods

TryGetAllGlyphs(out TextStudio3DGlyphRange)

bool TryGetAllGlyphs(out TextStudio3DGlyphRange range)

Creates a topology-versioned range covering all currently visible glyphs.

Parameters

Name	Type
range	TextStudio.ThreeD.TextStudio3DGlyphRange

Returns

System.Boolean

TryGetGlyphHandle(int, out TextStudio3DGlyphHandle)

bool TryGetGlyphHandle(int visibleGlyphIndex, out TextStudio3DGlyphHandle handle)

Resolves the first generated layer entry for a visible glyph.

Parameters

Name	Type
visibleGlyphIndex	System.Int32
handle	TextStudio.ThreeD.TextStudio3DGlyphHandle

Returns

System.Boolean

TryGetGlyphHandle(int, int, out TextStudio3DGlyphHandle)

bool TryGetGlyphHandle(int visibleGlyphIndex, int layerIndex, out TextStudio3DGlyphHandle handle)

Resolves a generated layer entry by visible-glyph and authored-layer identity.

Parameters

Name	Type
visibleGlyphIndex	System.Int32
layerIndex	System.Int32
handle	TextStudio.ThreeD.TextStudio3DGlyphHandle

Returns

System.Boolean

TryGetGlyphRange(int, int, out TextStudio3DGlyphRange)

bool TryGetGlyphRange(int startVisibleGlyphIndex, int count, out TextStudio3DGlyphRange range)

Creates a topology-versioned range for consecutive visible glyphs.

Parameters

Name	Type
startVisibleGlyphIndex	System.Int32
count	System.Int32
range	TextStudio.ThreeD.TextStudio3DGlyphRange

Returns

System.Boolean

GetGlyphHandles(TextStudio3DGlyphRange)

TextStudio3DGlyphHandleCollection GetGlyphHandles(TextStudio3DGlyphRange range)

Returns an allocation-free enumerable over every generated layer entry selected by a current range.

Parameters

Name	Type
range	TextStudio.ThreeD.TextStudio3DGlyphRange

Returns

TextStudio.ThreeD.TextStudio3DGlyphHandleCollection

IsGlyphHandleCurrent(TextStudio3DGlyphHandle)

bool IsGlyphHandleCurrent(TextStudio3DGlyphHandle handle)

Reports whether a handle still belongs to this renderer’s current topology.

Parameters

Name	Type
handle	TextStudio.ThreeD.TextStudio3DGlyphHandle

Returns

System.Boolean

IsGlyphRangeCurrent(TextStudio3DGlyphRange)

bool IsGlyphRangeCurrent(TextStudio3DGlyphRange range)

Reports whether a range still belongs to this renderer’s current topology.

Parameters

Name	Type
range	TextStudio.ThreeD.TextStudio3DGlyphRange

Returns

System.Boolean

SetGlyphColorTint(TextStudio3DGlyphHandle, Color32)

bool SetGlyphColorTint(TextStudio3DGlyphHandle handle, Color32 tint)

Applies a persistent vertex tint to one current glyph-layer entry.

Parameters

Name	Type
handle	TextStudio.ThreeD.TextStudio3DGlyphHandle
tint	UnityEngine.Color32

Returns

System.Boolean

SetGlyphColorTint(TextStudio3DGlyphRange, Color32)

int SetGlyphColorTint(TextStudio3DGlyphRange range, Color32 tint)

Applies a persistent vertex tint to every generated entry selected by a current glyph range.

Parameters

Name	Type
range	TextStudio.ThreeD.TextStudio3DGlyphRange
tint	UnityEngine.Color32

Returns

System.Int32: The number of affected generated entries, or zero for a stale range.

ClearGlyphColorTint(TextStudio3DGlyphRange)

int ClearGlyphColorTint(TextStudio3DGlyphRange range)

Clears persistent vertex tints from every generated entry selected by a current glyph range.

Parameters

Name	Type
range	TextStudio.ThreeD.TextStudio3DGlyphRange

Returns

System.Int32: The number of affected generated entries, or zero for a stale range.

ClearGlyphColorTints()

void ClearGlyphColorTints()

Clears all persistent per-glyph tints and restores the resolved authored colors.

TryGetSocket(TextStudio3DGlyphHandle, TextStudio3DSocketKind, out TextStudio3DSocketPose)

bool TryGetSocket(TextStudio3DGlyphHandle handle, TextStudio3DSocketKind kind, out TextStudio3DSocketPose pose)

Resolves a world-space pose at a semantic point on a current generated glyph entry.

Parameters

Name	Type
handle	TextStudio.ThreeD.TextStudio3DGlyphHandle
kind	TextStudio.ThreeD.TextStudio3DSocketKind
pose	TextStudio.ThreeD.TextStudio3DSocketPose

Returns

System.Boolean