harfbuzz.c.types

Data type for booleans.

Data type for holding Unicode codepoints. Also used to hold glyph IDs.

Data type for holding color values. Colors are eight bits per channel RGB plus alpha transparency.

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.

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.

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.

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.

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.

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.

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.

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.

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 vertical text segments.

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.

Data type for bitmasks.

An integral type representing an OpenType 'name' table name identifier. There are predefined name IDs, as well as name IDs return from other API. These can be used to fetch name strings from a font face.

Data type for holding a single coordinate value. Contour points and other multi-dimensional data are stored as tuples of #hb_position_t's.

Data type for tag identifiers. Tags are four byte integers, each byte representing a character.

Tags are used to identify tables, design-variation axes, scripts, languages, font features, and baselines with human-readable names.

The selectors defined for specifying AAT feature settings.

The possible feature types defined for AAT shaping, from Apple Font Feature Registry.

Data type for holding HarfBuzz's clustering behavior options. The cluster level dictates one aspect of how HarfBuzz will treat non-base characters during shaping.

In @HB_BUFFER_CLUSTER_LEVEL_MONOTONE_GRAPHEMES, non-base characters are merged into the cluster of the base character that precedes them.

In @HB_BUFFER_CLUSTER_LEVEL_MONOTONE_CHARACTERS, non-base characters are initially assigned their own cluster values, which are not merged into preceding base clusters. This allows HarfBuzz to perform additional operations like reorder sequences of adjacent marks.

@HB_BUFFER_CLUSTER_LEVEL_MONOTONE_GRAPHEMES is the default, because it maintains backward compatibility with older versions of HarfBuzz. New client programs that do not need to maintain such backward compatibility are recommended to use @HB_BUFFER_CLUSTER_LEVEL_MONOTONE_CHARACTERS instead of the default.

The type of #hb_buffer_t contents.

Flags from comparing two #hb_buffer_t's.

Buffer with different #hb_buffer_content_type_t cannot be meaningfully compared in any further detail.

For buffers with differing length, the per-glyph comparison is not attempted, though we do still scan reference buffer for dotted circle and .notdef glyphs.

If the buffers have the same length, we compare them glyph-by-glyph and report which aspect(s) of the glyph info/position are different.

Flags for #hb_buffer_t.

Flags that control what glyph information are serialized in [harfbuzz.global.bufferSerializeGlyphs].

The buffer serialization and de-serialization format used in [harfbuzz.global.bufferSerializeGlyphs] and [harfbuzz.global.bufferDeserializeGlyphs].

The direction of a text segment or buffer.

A segment can also be tested for horizontal or vertical orientation (irrespective of specific direction) with HB_DIRECTION_IS_HORIZONTAL() or HB_DIRECTION_IS_VERTICAL().

Flags for #hb_glyph_info_t.

Data type holding the memory modes available to client programs.

Regarding these various memory-modes:

• In no case shall the HarfBuzz client modify memory

that is passed to HarfBuzz in a blob. If there is any such possibility, @HB_MEMORY_MODE_DUPLICATE should be used such that HarfBuzz makes a copy immediately,

• Use @HB_MEMORY_MODE_READONLY otherwise, unless you really really

really know what you are doing,

• @HB_MEMORY_MODE_WRITABLE is appropriate if you really made a

copy of data solely for the purpose of passing to HarfBuzz and doing that just once (no reuse!),

• If the font is mmap()ed, it's okay to use

@HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE, however, using that mode correctly is very tricky. Use @HB_MEMORY_MODE_READONLY instead.

Flags that describe the properties of color palette.

Baseline tags from Baseline Tags registry.

The GDEF classes defined for glyphs.

The 'MATH' table constants, refer to

For more explanations.

Flags for math glyph parts.

The math kerning-table types defined for the four corners of a glyph.

Known metadata tags from https://docs.microsoft.com/en-us/typography/opentype/spec/meta

Metric tags corresponding to MVAR Value Tags

An enum type representing the pre-defined name IDs.

For more information on these fields, see the

Flags for #hb_ot_var_axis_info_t.

The values of this enumeration describe the compositing modes that can be used when combining temporary redirected drawing with the backdrop.

See the OpenType spec COLR section for details.

The values of this enumeration determine how color values outside the minimum and maximum defined offset on a #hb_color_line_t are determined.

See the OpenType spec COLR section for details.

Data type for scripts. Each #hb_script_t's value is an #hb_tag_t corresponding to the four-letter values defined by ISO 15924.

See also the Script (sc) property of the Unicode Character Database.

Defined by OpenType Design-Variation Axis Tag Registry.

Data type for the Canonical_Combining_Class (ccc) property from the Unicode Character Database.

Data type for the "General_Category" (gc) property from the Unicode Character Database.

Structure representing a setting for an #hb_aat_layout_feature_type_t.

Data type for blobs. A blob wraps a chunk of binary data and facilitates its lifecycle management between a client program and HarfBuzz.

The main structure holding the input text and its properties before shaping, and output glyphs and their information after shaping.

A struct containing color information for a gradient.

Information about a color stop on a color line.

Color lines typically have offsets ranging between 0 and 1, but that is not required.

Glyph draw callbacks.

#hb_draw_move_to_func_t, #hb_draw_line_to_func_t and #hb_draw_cubic_to_func_t calls are necessary to be defined but we translate #hb_draw_quadratic_to_func_t calls to #hb_draw_cubic_to_func_t if the callback isn't defined.

Data type for holding font faces.

The #hb_feature_t is the structure that holds information about requested feature application. The feature will be applied with the given value to all glyphs which are in clusters between @start (inclusive) and @end (exclusive). Setting start to #HB_FEATURE_GLOBAL_START and end to #HB_FEATURE_GLOBAL_END specifies that the feature always applies to the entire buffer.

Data type for holding fonts.

Font-wide extent values, measured in font units.

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

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.

Glyph extent values, measured in font units.

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

Data type for languages. Each #hb_language_t corresponds to a BCP 47 language tag.

Data type for holding integer-to-integer hash maps.

Pairs of glyph and color index.

A color index of 0xFFFF does not refer to a palette color, but indicates that the foreground color should be used.

Data type to hold information for a "part" component of a math-variant glyph. Large variants for stretchable math glyphs (such as parentheses) can be constructed on the fly from parts.

Data type to hold math-variant information for a glyph.

Data type to hold math kerning (cut-in) information for a glyph.

Structure representing a name ID in a particular language.

Use #hb_ot_var_axis_info_t instead.

Data type for holding variation-axis values.

The minimum, default, and maximum values are in un-normalized, user scales.

Glyph paint callbacks.

The callbacks assume that the caller maintains a stack of current transforms, clips and intermediate surfaces, as evidenced by the pairs of push/pop callbacks. The push/pop calls will be properly nested, so it is fine to store the different kinds of object on a single stack.

Not all callbacks are required for all kinds of glyphs. For rendering COLRv0 or non-color outline glyphs, the gradient callbacks are not needed, and the composite callback only needs to handle simple alpha compositing (#HB_PAINT_COMPOSITE_MODE_SRC_OVER).

The paint-image callback is only needed for glyphs with image blobs in the CBDT, sbix or SVG tables.

The custom-palette-color callback is only necessary if you want to override colors from the font palette with custom colors.

The structure that holds various text properties of an #hb_buffer_t. Can be set and retrieved using [harfbuzz.global.bufferSetSegmentProperties] and [harfbuzz.global.bufferGetSegmentProperties], respectively.

Data type for holding a set of integers. #hb_set_t's are used to gather and contain glyph IDs, Unicode code points, and various other collections of discrete values.

Data type for holding a shaping plan.

Shape plans contain information about how HarfBuzz will shape a particular text segment, based on the segment's properties and the capabilities in the font face in use.

Shape plans can be queried about how shaping will perform, given a set of specific input parameters (script, language, direction, features, etc.).

Data type containing a set of virtual methods used for accessing various Unicode character properties.

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

Data structure for holding user-data keys.

Data type for holding variation data. Registered OpenType variation-axis tags are listed in

Current drawing state.

The #hb_glyph_info_t is the structure that holds information about the glyphs and their relation to input text.

The #hb_glyph_position_t is the structure that holds the positions of the glyph in both horizontal and vertical directions. All positions in #hb_glyph_position_t are relative to the current point.