Module org.freedesktop.cairo

Package org.freedesktop.cairo

Class FTScaledFont

java.lang.Object

io.github.jwharm.cairobindings.Proxy

org.freedesktop.cairo.ScaledFont

org.freedesktop.cairo.FTScaledFont

public class FTScaledFont
extends ScaledFont

Provides a ScaledFont from the FreeType font backend.

The FreeType font backend is primarily used to render text on GNU/Linux systems, but can be used on other platforms too.

Since:

1.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static FTScaledFont	create(FTFontFace fontFace, Matrix fontMatrix, Matrix ctm, FontOptions options)	Creates a FTScaledFont object from a FreeType font face and matrices that describe the size of the font and the environment in which it will be used.
Face	lockFace()	Gets the FT_Face object from a FreeType backend font and scales it appropriately for the font and applies OpenType font variations if applicable.
void	unlockFace()	Releases a face obtained with lockFace().

Methods inherited from class org.freedesktop.cairo.ScaledFont

create, destroy, extents, getCTM, getFontFace, getFontMatrix, getFontOptions, getFontType, getScaleMatrix, getType, getUserData, glyphExtents, setUserData, status, textExtents, textToGlyphs

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

FTScaledFont

public FTScaledFont(MemorySegment address)

Constructor used internally to instantiate a java FTScaledFont object for a native cairo_scaled_font_t instance

Parameters:

address - the memory address of the native cairo_scaled_font_t instance

Method Details

create

public static FTScaledFont create(FTFontFace fontFace,
 Matrix fontMatrix,
 Matrix ctm,
 FontOptions options)

Creates a FTScaledFont object from a FreeType font face and matrices that describe the size of the font and the environment in which it will be used.

Parameters:

fontFace - a FTFontFace

fontMatrix - font space to user space transformation matrix for the font. In the simplest case of a N point font, this matrix is just a scale by N, but it can also be used to shear the font or stretch it unequally along the two axes. See Context.setFontMatrix(Matrix).

ctm - user to device transformation matrix with which the font will be used.

options - options to use when getting metrics for the font and rendering with it.

Returns:

a newly created FTScaledFont

Since:

1.0

lockFace

public Face lockFace()

Gets the FT_Face object from a FreeType backend font and scales it appropriately for the font and applies OpenType font variations if applicable. You must release the face with unlockFace() when you are done using it. Since the Face object can be shared between multiple FTScaledFont objects, you must not lock any other font objects until you unlock this one. A count is kept of the number of times lockFace() is called. unlockFace() must be called the same number of times.

You must be careful when using this function in a library or in a threaded application, because freetype's design makes it unsafe to call freetype functions simultaneously from multiple threads, (even if using distinct FT_Face objects). Because of this, application code that acquires an FT_Face object with this call must add its own locking to protect any use of that object, (and which also must protect any other calls into cairo as almost any cairo function might result in a call into the freetype library).

Returns:

The FT_Face object for this font, scaled appropriately, or null if this font is in an error state (see ScaledFont.status()) or there is insufficient memory.

Since:

1.0

unlockFace

public void unlockFace()

Releases a face obtained with lockFace().

Since:

1.0