Module org.freedesktop.cairo

Package org.freedesktop.cairo

Class TextCluster

java.lang.Object

io.github.jwharm.cairobindings.Proxy

org.freedesktop.cairo.TextCluster

public class TextCluster
extends Proxy

The TextCluster structure holds information about a single text cluster. A text cluster is a minimal mapping of some glyphs corresponding to some UTF-8 text.

For a cluster to be valid, both numBytes and numGlyphs should be non-negative, and at least one should be non-zero. Note that clusters with zero glyphs are not as well supported as normal clusters. For example, PDF rendering applications typically ignore those clusters when PDF text is being selected.

See cairo_show_text_glyphs() for how clusters are used in advanced text operations.

Since:

1.8

Constructor Summary

Constructors

Constructor	Description
TextCluster(MemorySegment address)	Constructor used internally to instantiate a java TextCluster object for a native cairo_text_cluster_t instance

Method Summary

Modifier and Type	Method	Description
int	numBytes()	The number of bytes of UTF-8 text covered by the cluster
int	numGlyphs()	The number of glyphs covered by cluster

Methods inherited from class io.github.jwharm.cairobindings.Proxy

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TextCluster

public TextCluster(MemorySegment address)

Constructor used internally to instantiate a java TextCluster object for a native cairo_text_cluster_t instance

Parameters:

address - the memory address of the native cairo_text_cluster_t instance

Method Details

numBytes

public int numBytes()

The number of bytes of UTF-8 text covered by the cluster

Returns:

the number of bytes of UTF-8 text

numGlyphs

public int numGlyphs()

The number of glyphs covered by cluster

Returns:

the number of glyphs covered by cluster