hb_font_add_glyph_origin_for_direction ()

void
hb_font_add_glyph_origin_for_direction
                               (hb_font_t *font,
                                hb_codepoint_t glyph,
                                hb_direction_t direction,
                                hb_position_t *x,
                                hb_position_t *y);

Adds the origin coordinates to an (X,Y) point coordinate, in the specified glyph ID in the specified font.

Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of direction .

Since: 0.9.2

hb_font_create ()

hb_font_t *
hb_font_create (hb_face_t *face);

Constructs a new font object from the specified face.

Since: 0.9.2

hb_font_create_sub_font ()

hb_font_t *
hb_font_create_sub_font (hb_font_t *parent);

Constructs a sub-font font object from the specified parent font, replicating the parent's properties.

Since: 0.9.2

hb_font_get_empty ()

hb_font_t *
hb_font_get_empty (void);

Fetches the empty font object.

Since: 0.9.2

hb_font_reference ()

hb_font_t *
hb_font_reference (hb_font_t *font);

Increases the reference count on the given font object.

[skip]

Since: 0.9.2

hb_font_destroy ()

void
hb_font_destroy (hb_font_t *font);

Decreases the reference count on the given font object. When the reference count reaches zero, the font is destroyed, freeing all memory.

[skip]

Since: 0.9.2

hb_font_set_user_data ()

hb_bool_t
hb_font_set_user_data (hb_font_t *font,
                       hb_user_data_key_t *key,
                       void *data,
                       hb_destroy_func_t destroy,
                       hb_bool_t replace);

Attaches a user-data key/data pair to the specified font object.

[skip]

Since: 0.9.2

hb_font_get_user_data ()

void *
hb_font_get_user_data (const hb_font_t *font,
                       hb_user_data_key_t *key);

Fetches the user-data object associated with the specified key, attached to the specified font object.

[skip]

Since: 0.9.2

hb_font_make_immutable ()

void
hb_font_make_immutable (hb_font_t *font);

Makes font immutable.

Since: 0.9.2

hb_font_is_immutable ()

hb_bool_t
hb_font_is_immutable (hb_font_t *font);

Tests whether a font object is immutable.

Since: 0.9.2

hb_font_set_face ()

void
hb_font_set_face (hb_font_t *font,
                  hb_face_t *face);

Sets face as the font-face value of font .

Since: 1.4.3

hb_font_get_face ()

hb_face_t *
hb_font_get_face (hb_font_t *font);

Fetches the face associated with the specified font object.

Since: 0.9.2

hb_font_get_glyph ()

hb_bool_t
hb_font_get_glyph (hb_font_t *font,
                   hb_codepoint_t unicode,
                   hb_codepoint_t variation_selector,
                   hb_codepoint_t *glyph);

Fetches the glyph ID for a Unicode code point in the specified font, with an optional variation selector.

If variation_selector is 0, calls hb_font_get_nominal_glyph(); otherwise calls hb_font_get_variation_glyph().

Since: 0.9.2

hb_font_get_glyph_advance_for_direction ()

void
hb_font_get_glyph_advance_for_direction
                               (hb_font_t *font,
                                hb_codepoint_t glyph,
                                hb_direction_t direction,
                                hb_position_t *x,
                                hb_position_t *y);

Fetches the advance for a glyph ID from the specified font, in a text segment of the specified direction.

Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of direction .

Since: 0.9.2

hb_font_get_glyph_advances_for_direction ()

void
hb_font_get_glyph_advances_for_direction
                               (hb_font_t *font,
                                hb_direction_t direction,
                                unsigned int count,
                                const hb_codepoint_t *first_glyph,
                                unsigned  glyph_stride,
                                hb_position_t *first_advance,
                                unsigned  advance_stride);

Fetches the advances for a sequence of glyph IDs in the specified font, in a text segment of the specified direction.

Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of direction .

Since: 1.8.6

hb_font_get_glyph_contour_point ()

hb_bool_t
hb_font_get_glyph_contour_point (hb_font_t *font,
                                 hb_codepoint_t glyph,
                                 unsigned int point_index,
                                 hb_position_t *x,
                                 hb_position_t *y);

Fetches the (x,y) coordinates of a specified contour-point index in the specified glyph, within the specified font.

Since: 0.9.2

hb_font_get_glyph_contour_point_for_origin ()

hb_bool_t
hb_font_get_glyph_contour_point_for_origin
                               (hb_font_t *font,
                                hb_codepoint_t glyph,
                                unsigned int point_index,
                                hb_direction_t direction,
                                hb_position_t *x,
                                hb_position_t *y);

Fetches the (X,Y) coordinates of a specified contour-point index in the specified glyph ID in the specified font, with respect to the origin in a text segment in the specified direction.

Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of direction .

Since: 0.9.2

hb_font_get_glyph_extents ()

hb_bool_t
hb_font_get_glyph_extents (hb_font_t *font,
                           hb_codepoint_t glyph,
                           hb_glyph_extents_t *extents);

Fetches the hb_glyph_extents_t data for a glyph ID in the specified font.

Since: 0.9.2

hb_font_get_glyph_extents_for_origin ()

hb_bool_t
hb_font_get_glyph_extents_for_origin (hb_font_t *font,
                                      hb_codepoint_t glyph,
                                      hb_direction_t direction,
                                      hb_glyph_extents_t *extents);

Fetches the hb_glyph_extents_t data for a glyph ID in the specified font, with respect to the origin in a text segment in the specified direction.

Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of direction .

Since: 0.9.2

hb_font_get_glyph_from_name ()

hb_bool_t
hb_font_get_glyph_from_name (hb_font_t *font,
                             const char *name,
                             int len,
                             hb_codepoint_t *glyph);

Fetches the glyph ID that corresponds to a name string in the specified font .

Since: 0.9.2

hb_font_get_glyph_h_advance ()

hb_position_t
hb_font_get_glyph_h_advance (hb_font_t *font,
                             hb_codepoint_t glyph);

Fetches the advance for a glyph ID in the specified font, for horizontal text segments.

Since: 0.9.2

hb_font_get_glyph_v_advance ()

hb_position_t
hb_font_get_glyph_v_advance (hb_font_t *font,
                             hb_codepoint_t glyph);

Fetches the advance for a glyph ID in the specified font, for vertical text segments.

Since: 0.9.2

hb_font_get_glyph_h_advances ()

void
hb_font_get_glyph_h_advances (hb_font_t *font,
                              unsigned int count,
                              const hb_codepoint_t *first_glyph,
                              unsigned  glyph_stride,
                              hb_position_t *first_advance,
                              unsigned  advance_stride);

Fetches the advances for a sequence of glyph IDs in the specified font, for horizontal text segments.

Since: 1.8.6

hb_font_get_glyph_v_advances ()

void
hb_font_get_glyph_v_advances (hb_font_t *font,
                              unsigned int count,
                              const hb_codepoint_t *first_glyph,
                              unsigned  glyph_stride,
                              hb_position_t *first_advance,
                              unsigned  advance_stride);

Fetches the advances for a sequence of glyph IDs in the specified font, for vertical text segments.

Since: 1.8.6

hb_font_get_glyph_h_kerning ()

hb_position_t
hb_font_get_glyph_h_kerning (hb_font_t *font,
                             hb_codepoint_t left_glyph,
                             hb_codepoint_t right_glyph);

Fetches the kerning-adjustment value for a glyph-pair in the specified font, for horizontal text segments.

Since: 0.9.2

hb_font_get_glyph_kerning_for_direction ()

void
hb_font_get_glyph_kerning_for_direction
                               (hb_font_t *font,
                                hb_codepoint_t first_glyph,
                                hb_codepoint_t second_glyph,
                                hb_direction_t direction,
                                hb_position_t *x,
                                hb_position_t *y);

Fetches the kerning-adjustment value for a glyph-pair in the specified font.

Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of direction .

Since: 0.9.2

hb_font_get_glyph_h_origin ()

hb_bool_t
hb_font_get_glyph_h_origin (hb_font_t *font,
                            hb_codepoint_t glyph,
                            hb_position_t *x,
                            hb_position_t *y);

Fetches the (X,Y) coordinates of the origin for a glyph ID in the specified font, for horizontal text segments.

Since: 0.9.2

hb_font_get_glyph_v_origin ()

hb_bool_t
hb_font_get_glyph_v_origin (hb_font_t *font,
                            hb_codepoint_t glyph,
                            hb_position_t *x,
                            hb_position_t *y);

Fetches the (X,Y) coordinates of the origin for a glyph ID in the specified font, for vertical text segments.

Since: 0.9.2

hb_font_get_glyph_origin_for_direction ()

void
hb_font_get_glyph_origin_for_direction
                               (hb_font_t *font,
                                hb_codepoint_t glyph,
                                hb_direction_t direction,
                                hb_position_t *x,
                                hb_position_t *y);

Fetches the (X,Y) coordinates of the origin for a glyph in the specified font.

Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of direction .

Since: 0.9.2

hb_font_get_glyph_name ()

hb_bool_t
hb_font_get_glyph_name (hb_font_t *font,
                        hb_codepoint_t glyph,
                        char *name,
                        unsigned int size);

Fetches the glyph-name string for a glyph ID in the specified font .

According to the OpenType specification, glyph names are limited to 63 characters and can only contain (a subset of) ASCII.

Since: 0.9.2

hb_font_draw_glyph ()

void
hb_font_draw_glyph (hb_font_t *font,
                    hb_codepoint_t glyph,
                    hb_draw_funcs_t *dfuncs,
                    void *draw_data);

Draws the outline that corresponds to a glyph in the specified font .

The outline is returned by way of calls to the callbacks of the dfuncs objects, with draw_data passed to them.

Since: 7.0.0

hb_font_paint_glyph ()

void
hb_font_paint_glyph (hb_font_t *font,
                     hb_codepoint_t glyph,
                     hb_paint_funcs_t *pfuncs,
                     void *paint_data,
                     unsigned int palette_index,
                     hb_color_t foreground);

Paints the glyph.

The painting instructions are returned by way of calls to the callbacks of the funcs object, with paint_data passed to them.

If the font has color palettes (see hb_ot_color_has_palettes()), then palette_index selects the palette to use. If the font only has one palette, this will be 0.

Since: 7.0.0

hb_font_get_nominal_glyph ()

hb_bool_t
hb_font_get_nominal_glyph (hb_font_t *font,
                           hb_codepoint_t unicode,
                           hb_codepoint_t *glyph);

Fetches the nominal glyph ID for a Unicode code point in the specified font.

This version of the function should not be used to fetch glyph IDs for code points modified by variation selectors. For variation-selector support, user hb_font_get_variation_glyph() or use hb_font_get_glyph().

Since: 1.2.3

hb_font_get_nominal_glyphs ()

unsigned int
hb_font_get_nominal_glyphs (hb_font_t *font,
                            unsigned int count,
                            const hb_codepoint_t *first_unicode,
                            unsigned int unicode_stride,
                            hb_codepoint_t *first_glyph,
                            unsigned int glyph_stride);

Fetches the nominal glyph IDs for a sequence of Unicode code points. Glyph IDs must be returned in a hb_codepoint_t output parameter. Stops at the first unsupported glyph ID.

Since: 2.6.3

hb_font_get_variation_glyph ()

hb_bool_t
hb_font_get_variation_glyph (hb_font_t *font,
                             hb_codepoint_t unicode,
                             hb_codepoint_t variation_selector,
                             hb_codepoint_t *glyph);

Fetches the glyph ID for a Unicode code point when followed by by the specified variation-selector code point, in the specified font.

Since: 1.2.3

hb_font_set_parent ()

void
hb_font_set_parent (hb_font_t *font,
                    hb_font_t *parent);

Sets the parent font of font .

Since: 1.0.5

hb_font_get_parent ()

hb_font_t *
hb_font_get_parent (hb_font_t *font);

Fetches the parent font of font .

Since: 0.9.2

hb_font_set_ppem ()

void
hb_font_set_ppem (hb_font_t *font,
                  unsigned int x_ppem,
                  unsigned int y_ppem);

Sets the horizontal and vertical pixels-per-em (PPEM) of a font.

These values are used for pixel-size-specific adjustment to shaping and draw results, though for the most part they are unused and can be left unset.

Since: 0.9.2

hb_font_get_ppem ()

void
hb_font_get_ppem (hb_font_t *font,
                  unsigned int *x_ppem,
                  unsigned int *y_ppem);

Fetches the horizontal and vertical points-per-em (ppem) of a font.

Since: 0.9.2

hb_font_set_ptem ()

void
hb_font_set_ptem (hb_font_t *font,
                  float ptem);

Sets the "point size" of a font. Set to zero to unset. Used in CoreText to implement optical sizing.

Since: 1.6.0

hb_font_get_ptem ()

float
hb_font_get_ptem (hb_font_t *font);

Fetches the "point size" of a font. Used in CoreText to implement optical sizing.

Since: 1.6.0

hb_font_set_scale ()

void
hb_font_set_scale (hb_font_t *font,
                   int x_scale,
                   int y_scale);

Sets the horizontal and vertical scale of a font.

The font scale is a number related to, but not the same as, font size. Typically the client establishes a scale factor to be used between the two. For example, 64, or 256, which would be the fractional-precision part of the font scale. This is necessary because hb_position_t values are integer types and you need to leave room for fractional values in there.

For example, to set the font size to 20, with 64 levels of fractional precision you would call hb_font_set_scale(font, 20 * 64, 20 * 64).

In the example above, even what font size 20 means is up to you. It might be 20 pixels, or 20 points, or 20 millimeters. HarfBuzz does not care about that. You can set the point size of the font using hb_font_set_ptem(), and the pixel size using hb_font_set_ppem().

The choice of scale is yours but needs to be consistent between what you set here, and what you expect out of hb_position_t as well has draw / paint API output values.

Fonts default to a scale equal to the UPEM value of their face. A font with this setting is sometimes called an "unscaled" font.

Since: 0.9.2

hb_font_get_scale ()

void
hb_font_get_scale (hb_font_t *font,
                   int *x_scale,
                   int *y_scale);

Fetches the horizontal and vertical scale of a font.

Since: 0.9.2

hb_font_get_synthetic_bold ()

void
hb_font_get_synthetic_bold (hb_font_t *font,
                            float *x_embolden,
                            float *y_embolden,
                            hb_bool_t *in_place);

Fetches the "synthetic boldness" parameters of a font.

Since: 7.0.0

hb_font_set_synthetic_bold ()

void
hb_font_set_synthetic_bold (hb_font_t *font,
                            float x_embolden,
                            float y_embolden,
                            hb_bool_t in_place);

Sets the "synthetic boldness" of a font.

Positive values for x_embolden / y_embolden make a font bolder, negative values thinner. Typical values are in the 0.01 to 0.05 range. The default value is zero.

Synthetic boldness is applied by offsetting the contour points of the glyph shape.

Synthetic boldness is applied when rendering a glyph via hb_font_draw_glyph().

If in_place is false, then glyph advance-widths are also adjusted, otherwise they are not. The in-place mode is useful for simulating font grading.

Since: 7.0.0

hb_font_set_synthetic_slant ()

void
hb_font_set_synthetic_slant (hb_font_t *font,
                             float slant);

Sets the "synthetic slant" of a font. By default is zero. Synthetic slant is the graphical skew applied to the font at rendering time.

HarfBuzz needs to know this value to adjust shaping results, metrics, and style values to match the slanted rendering.

Since: 3.3.0

hb_font_get_synthetic_slant ()

float
hb_font_get_synthetic_slant (hb_font_t *font);

Fetches the "synthetic slant" of a font.

Since: 3.3.0

hb_font_set_variations ()

void
hb_font_set_variations (hb_font_t *font,
                        const hb_variation_t *variations,
                        unsigned int variations_length);

Applies a list of font-variation settings to a font.

Note that this overrides all existing variations set on font . Axes not included in variations will be effectively set to their default values.

Since: 1.4.2

hb_font_set_variation ()

void
hb_font_set_variation (hb_font_t *font,
                       hb_tag_t tag,
                       float value);

Change the value of one variation axis on the font.

Note: This function is expensive to be called repeatedly. If you want to set multiple variation axes at the same time, use hb_font_set_variations() instead.

Since: 7.1.0

hb_font_set_var_named_instance ()

void
hb_font_set_var_named_instance (hb_font_t *font,
                                unsigned int instance_index);

Sets design coords of a font from a named-instance index.

Since: 2.6.0

hb_font_get_var_named_instance ()

unsigned int
hb_font_get_var_named_instance (hb_font_t *font);

Returns the currently-set named-instance index of the font.

Since: 7.0.0

hb_font_set_var_coords_design ()

void
hb_font_set_var_coords_design (hb_font_t *font,
                               const float *coords,
                               unsigned int coords_length);

Applies a list of variation coordinates (in design-space units) to a font.

Note that this overrides all existing variations set on font . Axes not included in coords will be effectively set to their default values.

Since: 1.4.2

hb_font_get_var_coords_design ()

const float *
hb_font_get_var_coords_design (hb_font_t *font,
                               unsigned int *length);

Fetches the list of variation coordinates (in design-space units) currently set on a font.

Note that this returned array may only contain values for some (or none) of the axes; omitted axes effectively have their default values.

Return value is valid as long as variation coordinates of the font are not modified.

Since: 3.3.0

hb_font_set_var_coords_normalized ()

void
hb_font_set_var_coords_normalized (hb_font_t *font,
                                   const int *coords,
                                   unsigned int coords_length);

Applies a list of variation coordinates (in normalized units) to a font.

Note that this overrides all existing variations set on font . Axes not included in coords will be effectively set to their default values.

Since: 1.4.2

hb_font_get_var_coords_normalized ()

const int *
hb_font_get_var_coords_normalized (hb_font_t *font,
                                   unsigned int *length);

Fetches the list of normalized variation coordinates currently set on a font.

Note that this returned array may only contain values for some (or none) of the axes; omitted axes effectively have zero values.

Return value is valid as long as variation coordinates of the font are not modified.

Since: 1.4.2

hb_font_glyph_from_string ()

hb_bool_t
hb_font_glyph_from_string (hb_font_t *font,
                           const char *s,
                           int len,
                           hb_codepoint_t *glyph);

Fetches the glyph ID from font that matches the specified string. Strings of the format gidDDD or uniUUUU are parsed automatically.

Since: 0.9.2

hb_font_glyph_to_string ()

void
hb_font_glyph_to_string (hb_font_t *font,
                         hb_codepoint_t glyph,
                         char *s,
                         unsigned int size);

Fetches the name of the specified glyph ID in font and returns it in string s .

If the glyph ID has no name in font , a string of the form gidDDD is generated, with DDD being the glyph ID.

According to the OpenType specification, glyph names are limited to 63 characters and can only contain (a subset of) ASCII.

Since: 0.9.2

hb_font_get_serial ()

unsigned int
hb_font_get_serial (hb_font_t *font);

Returns the internal serial number of the font. The serial number is increased every time a setting on the font is changed, using a setter function.

Since: 4.4.0

hb_font_changed ()

void
hb_font_changed (hb_font_t *font);

Notifies the font that underlying font data has changed. This has the effect of increasing the serial as returned by hb_font_get_serial(), which invalidates internal caches.

Since: 4.4.0

hb_font_set_funcs ()

void
hb_font_set_funcs (hb_font_t *font,
                   hb_font_funcs_t *klass,
                   void *font_data,
                   hb_destroy_func_t destroy);

Replaces the font-functions structure attached to a font, updating the font's user-data with font -data and the destroy callback.

Since: 0.9.2

hb_font_set_funcs_data ()

void
hb_font_set_funcs_data (hb_font_t *font,
                        void *font_data,
                        hb_destroy_func_t destroy);

Replaces the user data attached to a font, updating the font's destroy callback.

Since: 0.9.2

hb_font_subtract_glyph_origin_for_direction ()

void
hb_font_subtract_glyph_origin_for_direction
                               (hb_font_t *font,
                                hb_codepoint_t glyph,
                                hb_direction_t direction,
                                hb_position_t *x,
                                hb_position_t *y);

Subtracts the origin coordinates from an (X,Y) point coordinate, in the specified glyph ID in the specified font.

Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of direction .

Since: 0.9.2

hb_font_funcs_create ()

hb_font_funcs_t *
hb_font_funcs_create (void);

Creates a new hb_font_funcs_t structure of font functions.

Since: 0.9.2

hb_font_funcs_get_empty ()

hb_font_funcs_t *
hb_font_funcs_get_empty (void);

Fetches an empty font-functions structure.

Since: 0.9.2

hb_font_funcs_reference ()

hb_font_funcs_t *
hb_font_funcs_reference (hb_font_funcs_t *ffuncs);

Increases the reference count on a font-functions structure.

[skip]

Since: 0.9.2

hb_font_funcs_destroy ()

void
hb_font_funcs_destroy (hb_font_funcs_t *ffuncs);

Decreases the reference count on a font-functions structure. When the reference count reaches zero, the font-functions structure is destroyed, freeing all memory.

[skip]

Since: 0.9.2

hb_font_funcs_set_user_data ()

hb_bool_t
hb_font_funcs_set_user_data (hb_font_funcs_t *ffuncs,
                             hb_user_data_key_t *key,
                             void *data,
                             hb_destroy_func_t destroy,
                             hb_bool_t replace);

Attaches a user-data key/data pair to the specified font-functions structure.

[skip]

Since: 0.9.2

hb_font_funcs_get_user_data ()

void *
hb_font_funcs_get_user_data (const hb_font_funcs_t *ffuncs,
                             hb_user_data_key_t *key);

Fetches the user data associated with the specified key, attached to the specified font-functions structure.

[skip]

Since: 0.9.2

hb_font_funcs_make_immutable ()

void
hb_font_funcs_make_immutable (hb_font_funcs_t *ffuncs);

Makes a font-functions structure immutable.

Since: 0.9.2

hb_font_funcs_is_immutable ()

hb_bool_t
hb_font_funcs_is_immutable (hb_font_funcs_t *ffuncs);

Tests whether a font-functions structure is immutable.

Since: 0.9.2

hb_font_get_glyph_contour_point_func_t ()

hb_bool_t
(*hb_font_get_glyph_contour_point_func_t)
                               (hb_font_t *font,
                                void *font_data,
                                hb_codepoint_t glyph,
                                unsigned int point_index,
                                hb_position_t *x,
                                hb_position_t *y,
                                void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the (X,Y) coordinates (in font units) for a specified contour point in a glyph. Each coordinate must be returned as an hb_position_t output parameter.

hb_font_funcs_set_glyph_contour_point_func ()

void
hb_font_funcs_set_glyph_contour_point_func
                               (hb_font_funcs_t *ffuncs,
                                hb_font_get_glyph_contour_point_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_contour_point_func_t.

Since: 0.9.2

hb_font_get_glyph_extents_func_t ()

hb_bool_t
(*hb_font_get_glyph_extents_func_t) (hb_font_t *font,
                                     void *font_data,
                                     hb_codepoint_t glyph,
                                     hb_glyph_extents_t *extents,
                                     void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the extents for a specified glyph. Extents must be returned in an hb_glyph_extents output parameter.

hb_font_funcs_set_glyph_extents_func ()

void
hb_font_funcs_set_glyph_extents_func (hb_font_funcs_t *ffuncs,
                                      hb_font_get_glyph_extents_func_t func,
                                      void *user_data,
                                      hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_extents_func_t.

Since: 0.9.2

hb_font_get_glyph_from_name_func_t ()

hb_bool_t
(*hb_font_get_glyph_from_name_func_t) (hb_font_t *font,
                                       void *font_data,
                                       const char *name,
                                       int len,
                                       hb_codepoint_t *glyph,
                                       void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the glyph ID that corresponds to a glyph-name string.

hb_font_funcs_set_glyph_from_name_func ()

void
hb_font_funcs_set_glyph_from_name_func
                               (hb_font_funcs_t *ffuncs,
                                hb_font_get_glyph_from_name_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_from_name_func_t.

Since: 0.9.2

hb_font_get_glyph_advance_func_t ()

hb_position_t
(*hb_font_get_glyph_advance_func_t) (hb_font_t *font,
                                     void *font_data,
                                     hb_codepoint_t glyph,
                                     void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the advance for a specified glyph. The method must return an hb_position_t.

hb_font_funcs_set_glyph_h_advance_func ()

void
hb_font_funcs_set_glyph_h_advance_func
                               (hb_font_funcs_t *ffuncs,
                                hb_font_get_glyph_h_advance_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_h_advance_func_t.

Since: 0.9.2

hb_font_funcs_set_glyph_v_advance_func ()

void
hb_font_funcs_set_glyph_v_advance_func
                               (hb_font_funcs_t *ffuncs,
                                hb_font_get_glyph_v_advance_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_v_advance_func_t.

Since: 0.9.2

hb_font_get_glyph_advances_func_t ()

void
(*hb_font_get_glyph_advances_func_t) (hb_font_t *font,
                                      void *font_data,
                                      unsigned int count,
                                      const hb_codepoint_t *first_glyph,
                                      unsigned  glyph_stride,
                                      hb_position_t *first_advance,
                                      unsigned  advance_stride,
                                      void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the advances for a sequence of glyphs.

hb_font_funcs_set_glyph_h_advances_func ()

void
hb_font_funcs_set_glyph_h_advances_func
                               (hb_font_funcs_t *ffuncs,
                                hb_font_get_glyph_h_advances_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_h_advances_func_t.

Since: 1.8.6

hb_font_funcs_set_glyph_v_advances_func ()

void
hb_font_funcs_set_glyph_v_advances_func
                               (hb_font_funcs_t *ffuncs,
                                hb_font_get_glyph_v_advances_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_v_advances_func_t.

Since: 1.8.6

hb_font_get_glyph_kerning_func_t ()

hb_position_t
(*hb_font_get_glyph_kerning_func_t) (hb_font_t *font,
                                     void *font_data,
                                     hb_codepoint_t first_glyph,
                                     hb_codepoint_t second_glyph,
                                     void *user_data);

This method should retrieve the kerning-adjustment value for a glyph-pair in the specified font, for horizontal text segments.

hb_font_funcs_set_glyph_h_kerning_func ()

void
hb_font_funcs_set_glyph_h_kerning_func
                               (hb_font_funcs_t *ffuncs,
                                hb_font_get_glyph_h_kerning_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_h_kerning_func_t.

Since: 0.9.2

hb_font_get_glyph_origin_func_t ()

hb_bool_t
(*hb_font_get_glyph_origin_func_t) (hb_font_t *font,
                                    void *font_data,
                                    hb_codepoint_t glyph,
                                    hb_position_t *x,
                                    hb_position_t *y,
                                    void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the (X,Y) coordinates (in font units) of the origin for a glyph. Each coordinate must be returned in an hb_position_t output parameter.

hb_font_funcs_set_glyph_h_origin_func ()

void
hb_font_funcs_set_glyph_h_origin_func (hb_font_funcs_t *ffuncs,
                                       hb_font_get_glyph_h_origin_func_t func,
                                       void *user_data,
                                       hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_h_origin_func_t.

Since: 0.9.2

hb_font_funcs_set_glyph_v_origin_func ()

void
hb_font_funcs_set_glyph_v_origin_func (hb_font_funcs_t *ffuncs,
                                       hb_font_get_glyph_v_origin_func_t func,
                                       void *user_data,
                                       hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_v_origin_func_t.

Since: 0.9.2

hb_font_get_glyph_name_func_t ()

hb_bool_t
(*hb_font_get_glyph_name_func_t) (hb_font_t *font,
                                  void *font_data,
                                  hb_codepoint_t glyph,
                                  char *name,
                                  unsigned int size,
                                  void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the glyph name that corresponds to a glyph ID. The name should be returned in a string output parameter.

hb_font_funcs_set_glyph_name_func ()

void
hb_font_funcs_set_glyph_name_func (hb_font_funcs_t *ffuncs,
                                   hb_font_get_glyph_name_func_t func,
                                   void *user_data,
                                   hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_glyph_name_func_t.

Since: 0.9.2

hb_font_draw_glyph_func_t ()

void
(*hb_font_draw_glyph_func_t) (hb_font_t *font,
                              void *font_data,
                              hb_codepoint_t glyph,
                              hb_draw_funcs_t *draw_funcs,
                              void *draw_data,
                              void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

Since: 7.0.0

hb_font_funcs_set_draw_glyph_func ()

void
hb_font_funcs_set_draw_glyph_func (hb_font_funcs_t *ffuncs,
                                   hb_font_draw_glyph_func_t func,
                                   void *user_data,
                                   hb_destroy_func_t destroy);

Sets the implementation function for hb_font_draw_glyph_func_t.

Since: 7.0.0

hb_font_paint_glyph_func_t ()

void
(*hb_font_paint_glyph_func_t) (hb_font_t *font,
                               void *font_data,
                               hb_codepoint_t glyph,
                               hb_paint_funcs_t *paint_funcs,
                               void *paint_data,
                               unsigned int palette_index,
                               hb_color_t foreground,
                               void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

Since: 7.0.0

hb_font_funcs_set_paint_glyph_func ()

void
hb_font_funcs_set_paint_glyph_func (hb_font_funcs_t *ffuncs,
                                    hb_font_paint_glyph_func_t func,
                                    void *user_data,
                                    hb_destroy_func_t destroy);

Sets the implementation function for hb_font_paint_glyph_func_t.

Since: 7.0.0

hb_font_get_nominal_glyph_func_t ()

hb_bool_t
(*hb_font_get_nominal_glyph_func_t) (hb_font_t *font,
                                     void *font_data,
                                     hb_codepoint_t unicode,
                                     hb_codepoint_t *glyph,
                                     void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the nominal glyph ID for a specified Unicode code point. Glyph IDs must be returned in a hb_codepoint_t output parameter.

hb_font_funcs_set_nominal_glyph_func ()

void
hb_font_funcs_set_nominal_glyph_func (hb_font_funcs_t *ffuncs,
                                      hb_font_get_nominal_glyph_func_t func,
                                      void *user_data,
                                      hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_nominal_glyph_func_t.

Since: 1.2.3

hb_font_get_nominal_glyphs_func_t ()

unsigned int
(*hb_font_get_nominal_glyphs_func_t) (hb_font_t *font,
                                      void *font_data,
                                      unsigned int count,
                                      const hb_codepoint_t *first_unicode,
                                      unsigned int unicode_stride,
                                      hb_codepoint_t *first_glyph,
                                      unsigned int glyph_stride,
                                      void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the nominal glyph IDs for a sequence of Unicode code points. Glyph IDs must be returned in a hb_codepoint_t output parameter.

hb_font_funcs_set_nominal_glyphs_func ()

void
hb_font_funcs_set_nominal_glyphs_func (hb_font_funcs_t *ffuncs,
                                       hb_font_get_nominal_glyphs_func_t func,
                                       void *user_data,
                                       hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_nominal_glyphs_func_t.

Since: 2.0.0

hb_font_get_variation_glyph_func_t ()

hb_bool_t
(*hb_font_get_variation_glyph_func_t) (hb_font_t *font,
                                       void *font_data,
                                       hb_codepoint_t unicode,
                                       hb_codepoint_t variation_selector,
                                       hb_codepoint_t *glyph,
                                       void *user_data);

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the glyph ID for a specified Unicode code point followed by a specified Variation Selector code point. Glyph IDs must be returned in a hb_codepoint_t output parameter.

hb_font_funcs_set_variation_glyph_func ()

void
hb_font_funcs_set_variation_glyph_func
                               (hb_font_funcs_t *ffuncs,
                                hb_font_get_variation_glyph_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_variation_glyph_func_t.

Since: 1.2.3

hb_font_get_font_extents_func_t ()

hb_bool_t
(*hb_font_get_font_extents_func_t) (hb_font_t *font,
                                    void *font_data,
                                    hb_font_extents_t *extents,
                                    void *user_data);

This method should retrieve the extents for a font.

hb_font_funcs_set_font_h_extents_func ()

void
hb_font_funcs_set_font_h_extents_func (hb_font_funcs_t *ffuncs,
                                       hb_font_get_font_h_extents_func_t func,
                                       void *user_data,
                                       hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_font_h_extents_func_t.

Since: 1.1.2

hb_font_funcs_set_font_v_extents_func ()

void
hb_font_funcs_set_font_v_extents_func (hb_font_funcs_t *ffuncs,
                                       hb_font_get_font_v_extents_func_t func,
                                       void *user_data,
                                       hb_destroy_func_t destroy);

Sets the implementation function for hb_font_get_font_v_extents_func_t.

Since: 1.1.2

hb_font_get_h_extents ()

hb_bool_t
hb_font_get_h_extents (hb_font_t *font,
                       hb_font_extents_t *extents);

Fetches the extents for a specified font, for horizontal text segments.

Since: 1.1.3

hb_font_get_v_extents ()

hb_bool_t
hb_font_get_v_extents (hb_font_t *font,
                       hb_font_extents_t *extents);

Fetches the extents for a specified font, for vertical text segments.

Since: 1.1.3

hb_font_get_extents_for_direction ()

void
hb_font_get_extents_for_direction (hb_font_t *font,
                                   hb_direction_t direction,
                                   hb_font_extents_t *extents);

Fetches the extents for a font in a text segment of the specified direction.

Calls the appropriate direction-specific variant (horizontal or vertical) depending on the value of direction .

Since: 1.1.3

HB_FONT_NO_VAR_NAMED_INSTANCE

#define HB_FONT_NO_VAR_NAMED_INSTANCE 0xFFFFFFFF

Constant signifying that a font does not have any named-instance index set. This is the default of a font.

Since: 7.0.0

hb_font_get_glyph_h_advance_func_t

typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_h_advance_func_t;

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the advance for a specified glyph, in horizontal-direction text segments. Advances must be returned in an hb_position_t output parameter.

hb_font_get_glyph_v_advance_func_t

typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_v_advance_func_t;

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the advance for a specified glyph, in vertical-direction text segments. Advances must be returned in an hb_position_t output parameter.

hb_font_get_glyph_h_advances_func_t

typedef hb_font_get_glyph_advances_func_t hb_font_get_glyph_h_advances_func_t;

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the advances for a sequence of glyphs, in horizontal-direction text segments.

hb_font_get_glyph_v_advances_func_t

typedef hb_font_get_glyph_advances_func_t hb_font_get_glyph_v_advances_func_t;

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the advances for a sequence of glyphs, in vertical-direction text segments.

hb_font_get_glyph_h_kerning_func_t

typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_h_kerning_func_t;

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the kerning-adjustment value for a glyph-pair in the specified font, for horizontal text segments.

hb_font_get_glyph_h_origin_func_t

typedef hb_font_get_glyph_origin_func_t hb_font_get_glyph_h_origin_func_t;

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the (X,Y) coordinates (in font units) of the origin for a glyph, for horizontal-direction text segments. Each coordinate must be returned in an hb_position_t output parameter.

hb_font_get_glyph_v_origin_func_t

typedef hb_font_get_glyph_origin_func_t hb_font_get_glyph_v_origin_func_t;

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the (X,Y) coordinates (in font units) of the origin for a glyph, for vertical-direction text segments. Each coordinate must be returned in an hb_position_t output parameter.

hb_font_funcs_t

typedef struct hb_font_funcs_t hb_font_funcs_t;

Data type containing a set of virtual methods used for working on hb_font_t font objects.

HarfBuzz provides a lightweight default function for each of the methods in hb_font_funcs_t. Client programs can implement their own replacements for the individual font functions, as needed, and replace the default by calling the setter for a method.

hb_font_t

typedef struct hb_font_t hb_font_t;

Data type for holding fonts.

hb_font_get_font_h_extents_func_t

typedef hb_font_get_font_extents_func_t hb_font_get_font_h_extents_func_t;

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the extents for a font, for horizontal-direction text segments. Extents must be returned in an hb_glyph_extents output parameter.

hb_font_get_font_v_extents_func_t

typedef hb_font_get_font_extents_func_t hb_font_get_font_v_extents_func_t;

A virtual method for the hb_font_funcs_t of an hb_font_t object.

This method should retrieve the extents for a font, for vertical-direction text segments. Extents must be returned in an hb_glyph_extents output parameter.

hb_font_extents_t

typedef struct {
  hb_position_t ascender;
  hb_position_t descender;
  hb_position_t line_gap;
} hb_font_extents_t;

Font-wide extent values, measured in font units.

Note that typically ascender is positive and descender negative, in coordinate systems that grow up.

hb_glyph_extents_t

typedef struct {
  hb_position_t x_bearing;
  hb_position_t y_bearing;
  hb_position_t width;
  hb_position_t height;
} hb_glyph_extents_t;

Glyph extent values, measured in font units.

Note that height is negative, in coordinate systems that grow up.