Module org.freedesktop.cairo

Package org.freedesktop.cairo

Class Glyphs

java.lang.Object

org.freedesktop.cairo.Glyphs

All Implemented Interfaces:

AutoCloseable

public class Glyphs
extends Object
implements AutoCloseable

The Glyphs class represents an array of glyphs. It will also optionally contain an array of clusters and the accompanying TextClusterFlags.

Method Summary

Modifier and Type	Method	Description
static MemorySegment	allocateClusters(int numClusters)	Allocates an array of TextClusters.
static MemorySegment	allocateGlyphs(int numGlyphs)	Allocates an array of Glyphs.
void	close()	Free the glyphs array using cairo_glyph_free and the clusters array using cairo_text_cluster_free.
TextClusterFlags	getClusterFlags()	Get the text cluster flags
MemorySegment	getClustersPointer()	Get a pointer to the clusters array
MemorySegment	getGlyphsPointer()	Get a pointer to the glyphs array
int	getNumClusters()	Get the number of text clusters in the cluster array
int	getNumGlyphs()	Get the number of glyphs in the array
void	setClusterFlags(TextClusterFlags clusterFlags)	Set the text cluster flags
void	setClustersPointer(MemorySegment clustersPointer)	Set a pointer to the clusters array
void	setGlyphsPointer(MemorySegment glyphsPointer)	Set a pointer to the glyphs array
void	setNumClusters(int numClusters)	Set the number of text clusters in the cluster array
void	setNumGlyphs(int numGlyphs)	Set the number of glyphs in the array

Methods inherited from class java.lang.Object

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

Method Details

getGlyphsPointer

public MemorySegment getGlyphsPointer()

Get a pointer to the glyphs array

The returned memory segment has zero length. It can be resized with MemorySegment.reinterpret(long)^RESTRICTED.

Returns:

a zero-length MemorySegment pointing to the glyphs array

setGlyphsPointer

public void setGlyphsPointer(MemorySegment glyphsPointer)

Set a pointer to the glyphs array

Parameters:

glyphsPointer - a MemorySegment pointing to the glyphs array

getNumGlyphs

public int getNumGlyphs()

Get the number of glyphs in the array

Returns:

the number of glyphs

setNumGlyphs

public void setNumGlyphs(int numGlyphs)

Set the number of glyphs in the array

Parameters:

numGlyphs - the number of glyphs

getClustersPointer

public MemorySegment getClustersPointer()

Get a pointer to the clusters array

The returned memory segment has zero length. It can be resized with MemorySegment.reinterpret(long)^RESTRICTED.

Returns:

a zero-length MemorySegment pointing to the clusters array

setClustersPointer

public void setClustersPointer(MemorySegment clustersPointer)

Set a pointer to the clusters array

The returned memory segment has zero length. It can be resized with MemorySegment.reinterpret(long)^RESTRICTED.

Parameters:

clustersPointer - the MemorySegment pointing to the clusters array

getNumClusters

public int getNumClusters()

Get the number of text clusters in the cluster array

Returns:

the number of text clusters

setNumClusters

public void setNumClusters(int numClusters)

Set the number of text clusters in the cluster array

Parameters:

numClusters - the number of text clusters

getClusterFlags

public TextClusterFlags getClusterFlags()

Get the text cluster flags

Returns:

the text cluster flags

setClusterFlags

public void setClusterFlags(TextClusterFlags clusterFlags)

Set the text cluster flags

Parameters:

clusterFlags - the text cluster flags

close

public void close()

Free the glyphs array using cairo_glyph_free and the clusters array using cairo_text_cluster_free.

Specified by:

close in interface AutoCloseable

allocateGlyphs

public static MemorySegment allocateGlyphs(int numGlyphs)

Allocates an array of Glyphs. This function is only useful in implementations of UserScaledFontTextToGlyphsFunc where the user needs to allocate an array of glyphs that cairo will free. For all other uses, user can use their own allocation method for glyphs.

This function returns MemorySegment.NULL if numGlyphs is not positive, or if out of memory. That means, the NULL return value signals out-of-memory only if numGlyphs was positive.

Parameters:

numGlyphs - number of glyphs to allocate

Returns:

the newly allocated array of glyphs

Since:

1.8

allocateClusters

public static MemorySegment allocateClusters(int numClusters)

Allocates an array of TextClusters. This function is only useful in implementations of UserScaledFontTextToGlyphsFunc where the user needs to allocate an array of text clusters that cairo will free. For all other uses, user can use their own allocation method for text clusters.

This function returns MemorySegment.NULL if numClusters is not positive, or if out of memory. That means, the NULL return value signals out-of-memory only if numClusters was positive.

Parameters:

numClusters - number of TextClusters to allocate

Returns:

the newly allocated array of text clusters

Since:

1.8