TextStudioVisualGlyph
public readonly struct TextStudioVisualGlyphRenderer-neutral glyph source and its semantic text-unit owner.
Constructors
Section titled “Constructors”
TextStudioVisualGlyph(ulong, uint, int, int, int, int, int, int, int, Vector2, float, float, Vector2, Vector2, Vector2, Vector4, ushort, float, float, bool, TextStudioGlyphFieldFormat, float, float, TextStudioVisualSourceKind, Vector4, float, ulong, int)
Section titled “TextStudioVisualGlyph(ulong, uint, int, int, int, int, int, int, int, Vector2, float, float, Vector2, Vector2, Vector2, Vector4, ushort, float, float, bool, TextStudioGlyphFieldFormat, float, float, TextStudioVisualSourceKind, Vector4, float, ulong, int)”public TextStudioVisualGlyph(ulong fontIdentity, uint glyphIndex, int textUnitIndex, int logicalIndex, int visualIndex, int clusterStart, int clusterLength, int lineIndex, int wordIndex, Vector2 origin, float advance, float baseline, Vector2 boundsMin, Vector2 boundsMax, Vector2 orientation, Vector4 atlasUvRect, ushort atlasPage, float distanceFieldScale, float distanceFieldBias, bool isVisible, TextStudioGlyphFieldFormat fieldFormat = TextStudioGlyphFieldFormat.SingleDistance, float fieldPixelsPerEm = 0, float fieldSafeDistanceEm = 0, TextStudioVisualSourceKind sourceKind = TextStudioVisualSourceKind.FontGlyph, Vector4 atlasToEm = null, float localEmSize = 0, ulong shapingFontIdentity = 0, int colorSourceIndex = -1)Creates a renderer-neutral glyph record with semantic mappings, geometry, atlas and field metadata, normalized orientation, and optional color-source linkage.
Parameters
| Name | Type |
|---|---|
fontIdentity |
System.UInt64 |
glyphIndex |
System.UInt32 |
textUnitIndex |
System.Int32 |
logicalIndex |
System.Int32 |
visualIndex |
System.Int32 |
clusterStart |
System.Int32 |
clusterLength |
System.Int32 |
lineIndex |
System.Int32 |
wordIndex |
System.Int32 |
origin |
UnityEngine.Vector2 |
advance |
System.Single |
baseline |
System.Single |
boundsMin |
UnityEngine.Vector2 |
boundsMax |
UnityEngine.Vector2 |
orientation |
UnityEngine.Vector2 |
atlasUvRect |
UnityEngine.Vector4 |
atlasPage |
System.UInt16 |
distanceFieldScale |
System.Single |
distanceFieldBias |
System.Single |
isVisible |
System.Boolean |
fieldFormat |
TextStudio.TextStudioGlyphFieldFormat |
fieldPixelsPerEm |
System.Single |
fieldSafeDistanceEm |
System.Single |
sourceKind |
TextStudio.TextStudioVisualSourceKind |
atlasToEm |
UnityEngine.Vector4 |
localEmSize |
System.Single |
shapingFontIdentity |
System.UInt64 |
colorSourceIndex |
System.Int32 |
Properties
Section titled “Properties”
FontIdentity
Section titled “FontIdentity”public ulong FontIdentity { get; }Returns
System.UInt64
ShapingFontIdentity
Section titled “ShapingFontIdentity”public ulong ShapingFontIdentity { get; }Persistent shaping source identity, separate from the runtime resource identity. Zero means no durable identity was supplied.
Returns
System.UInt64
GlyphIndex
Section titled “GlyphIndex”public uint GlyphIndex { get; }Returns
System.UInt32
TextUnitIndex
Section titled “TextUnitIndex”public int TextUnitIndex { get; }Returns
System.Int32
LogicalIndex
Section titled “LogicalIndex”public int LogicalIndex { get; }Returns
System.Int32
VisualIndex
Section titled “VisualIndex”public int VisualIndex { get; }Returns
System.Int32
ClusterStart
Section titled “ClusterStart”public int ClusterStart { get; }Returns
System.Int32
ClusterLength
Section titled “ClusterLength”public int ClusterLength { get; }Returns
System.Int32
LineIndex
Section titled “LineIndex”public int LineIndex { get; }Returns
System.Int32
WordIndex
Section titled “WordIndex”public int WordIndex { get; }Returns
System.Int32
Origin
Section titled “Origin”public Vector2 Origin { get; }Returns
UnityEngine.Vector2
Advance
Section titled “Advance”public float Advance { get; }Returns
System.Single
Baseline
Section titled “Baseline”public float Baseline { get; }Returns
System.Single
BoundsMin
Section titled “BoundsMin”public Vector2 BoundsMin { get; }Returns
UnityEngine.Vector2
BoundsMax
Section titled “BoundsMax”public Vector2 BoundsMax { get; }Returns
UnityEngine.Vector2
Orientation
Section titled “Orientation”public Vector2 Orientation { get; }Returns
UnityEngine.Vector2
AtlasUvRect
Section titled “AtlasUvRect”public Vector4 AtlasUvRect { get; }Returns
UnityEngine.Vector4
AtlasPage
Section titled “AtlasPage”public ushort AtlasPage { get; }Returns
System.UInt16
DistanceFieldScale
Section titled “DistanceFieldScale”public float DistanceFieldScale { get; }Returns
System.Single
DistanceFieldBias
Section titled “DistanceFieldBias”public float DistanceFieldBias { get; }Returns
System.Single
FieldFormat
Section titled “FieldFormat”public TextStudioGlyphFieldFormat FieldFormat { get; }Returns
TextStudio.TextStudioGlyphFieldFormat
FieldPixelsPerEm
Section titled “FieldPixelsPerEm”public float FieldPixelsPerEm { get; }Returns
System.Single
FieldSafeDistanceEm
Section titled “FieldSafeDistanceEm”public float FieldSafeDistanceEm { get; }Returns
System.Single
AtlasToEm
Section titled “AtlasToEm”public Vector4 AtlasToEm { get; }Native atlas UV to canonical font em: xy scale, zw offset.
Returns
UnityEngine.Vector4
LocalEmSize
Section titled “LocalEmSize”public float LocalEmSize { get; }Backend-local size of one em for this actual font glyph, before placement and animation.
Returns
System.Single
IsVisible
Section titled “IsVisible”public bool IsVisible { get; }Returns
System.Boolean
SourceKind
Section titled “SourceKind”public TextStudioVisualSourceKind SourceKind { get; }Returns
TextStudio.TextStudioVisualSourceKind
ColorSourceIndex
Section titled “ColorSourceIndex”public int ColorSourceIndex { get; }Returns
System.Int32