Struct GlyphCluster

pub struct GlyphCluster<'a> {
    pub source: SourceRange,
    pub info: ClusterInfo,
    pub glyphs: &'a [Glyph],
    pub components: &'a [SourceRange],
    pub data: UserData,
}

Collection of glyphs and associated metadata corresponding to one or more source clusters.

Fields

source: SourceRange

Full source range of the cluster in original units supplied to the shaper.

info: ClusterInfo

Information about the textual content of the cluster.

glyphs: &'a [Glyph]

Sequence of glyphs for the cluster. May be empty for clusters whose source consisted entirely of control characters.

components: &'a [SourceRange]

If the cluster is a ligature, this contains the source range of each ligature component. Empty otherwise.

data: UserData

Arbitrary user data– taken from the initial character of the cluster.

Implementations

impl<'a> GlyphCluster<'a>

pub fn is_empty(&self) -> bool

Returns true if the cluster is empty. Empty clusters still represent characters in the source text, but contain no glyphs. This will be true, for example, with newline sequences (\n or \r\n) as well as other control characters.

pub fn is_simple(&self) -> bool

Returns true if the cluster contains a single glyph. Note that a simple cluster can also be a ligature.

pub fn is_ligature(&self) -> bool

Returns true if the cluster corresponds to multiple source clusters. Note that a ligature cluster can also be complex.

pub fn is_complex(&self) -> bool

Returns true if the cluster is complex– that is if it contains more than one glyph. This will be true for clusters containing marks and is also commonly true for syllabic languages such as those in the Indic family.

pub fn advance(&self) -> f32

Computes the full advance width or height of the cluster.

Trait Implementations

impl<'a> Clone for GlyphCluster<'a>

fn clone(&self) -> GlyphCluster<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for GlyphCluster<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Copy for GlyphCluster<'a>