Struct PlannedGlyphCluster

Namespace

DocWright.Fonts

Assembly

DocWright.Fonts.dll

One cluster of a GlyphRun, resolved to the glyphs that draw it.

public readonly struct PlannedGlyphCluster

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

PlannedGlyphCluster(ushort[], string, Twips, Twips)

Initializes a planned cluster.

Properties

DesiredAdvance

Gets the advance layout assigned to this cluster.

FromClusterMap

Gets whether the cluster came from a shaper's cluster map rather than from a code-point fallback.

GlyphIds

Gets the glyphs that realize this cluster, in visual order.

GlyphPlacements

Each glyph's shaped advance and offsets, one per glyph id, when the cluster came from a shaped run that positioned its glyphs (marks over their base, kerned pairs); null when every glyph sits at its nominal advance. A renderer draws a placed glyph at pen + offset and moves the pen by its advance, then charges the difference between DesiredAdvance and the placements' sum after the cluster.

NominalAdvance

Gets the advance the font's own glyph widths produce for this cluster.

OmittedGlyphCount

Gets the number of glyphs the planner dropped from this cluster because the face has no glyph for them and the caller asked for undrawable glyphs to be omitted.

UnicodeText

Gets the text this cluster represents.