true to perform the shaping step, false to skip it.D types for harfbuzz0 library
A callback method for #hb_buffer_t. The method gets called with the #hb_buffer_t it was set on, the #hb_font_t the buffer is shaped with and a message describing what step of the shaping process will be performed. Returning false from this method will skip this shaping step and move to the next one.
buffer | An #hb_buffer_t to work upon |
font | The #hb_font_t the buffer is shaped with |
message | NULL-terminated message passed to the function |
true to perform the shaping step, false to skip it.A virtual method for the #hb_color_line_t to fetch color stops.
colorLine | a #hb_color_line_t object |
colorLineData | the data accompanying color_line |
start | the index of the first color stop to return |
colorStops | Array of #hb_color_stop_t to populate |
A virtual method for the hb_color_line_t to fetches the extend mode.
colorLine | a #hb_color_line_t object |
colorLineData | the data accompanying color_line |
A virtual method for destroy user-data callbacks.
A virtual method for the #hb_draw_funcs_t to perform a "close-path" draw operation.
dfuncs | draw functions object |
drawData | The data accompanying the draw functions in [harfbuzz.global.fontDrawGlyph] |
st | current draw state |
A virtual method for the #hb_draw_funcs_t to perform a "cubic-to" draw operation.
dfuncs | draw functions object |
drawData | The data accompanying the draw functions in [harfbuzz.global.fontDrawGlyph] |
st | current draw state |
control1X | X component of first control point |
control1Y | Y component of first control point |
control2X | X component of second control point |
control2Y | Y component of second control point |
toX | X component of target point |
toY | Y component of target point |
A virtual method for the #hb_draw_funcs_t to perform a "line-to" draw operation.
dfuncs | draw functions object |
drawData | The data accompanying the draw functions in [harfbuzz.global.fontDrawGlyph] |
st | current draw state |
toX | X component of target point |
toY | Y component of target point |
A virtual method for the #hb_draw_funcs_t to perform a "move-to" draw operation.
dfuncs | draw functions object |
drawData | The data accompanying the draw functions in [harfbuzz.global.fontDrawGlyph] |
st | current draw state |
toX | X component of target point |
toY | Y component of target point |
A virtual method for the #hb_draw_funcs_t to perform a "quadratic-to" draw operation.
dfuncs | draw functions object |
drawData | The data accompanying the draw functions in [harfbuzz.global.fontDrawGlyph] |
st | current draw state |
controlX | X component of control point |
controlY | Y component of control point |
toX | X component of target point |
toY | Y component of target point |
A virtual method for the #hb_font_funcs_t of an #hb_font_t object.
font | #hb_font_t to work upon |
fontData | font user data pointer |
glyph | The glyph ID to query |
drawFuncs | The draw functions to send the shape data to |
drawData | The data accompanying the draw functions |
This method should retrieve the extents for a font.
font | #hb_font_t to work upon |
fontData | font user data pointer |
extents | The font extents retrieved |
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.
font | #hb_font_t to work upon |
fontData | font user data pointer |
glyph | The glyph ID to query |
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.
font | #hb_font_t to work upon |
fontData | font user data pointer |
glyph | The glyph ID to query |
pointIndex | The contour-point index to query |
x | The X value retrieved for the contour point |
y | The Y value retrieved for the contour point |
true if data found, false otherwiseA 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.
font | #hb_font_t to work upon |
fontData | font user data pointer |
glyph | The glyph ID to query |
extents | The #hb_glyph_extents_t retrieved |
true if data found, false otherwiseA 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.
font | #hb_font_t to work upon |
fontData | font user data pointer |
name | The name string to query |
glyph | The glyph ID retrieved |
true if data found, false otherwiseA 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 font, with an optional variation selector.
font | #hb_font_t to work upon |
fontData | font user data pointer |
unicode | The Unicode code point to query |
variationSelector | The variation-selector code point to query |
glyph | The glyph ID retrieved |
true if data found, false otherwiseThis method should retrieve the kerning-adjustment value for a glyph-pair in the specified font, for horizontal text segments.
font | #hb_font_t to work upon |
fontData | font user data pointer |
firstGlyph | The glyph ID of the first glyph in the glyph pair |
secondGlyph | The glyph ID of the second glyph in the glyph pair |
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.
font | #hb_font_t to work upon |
fontData | font user data pointer |
glyph | The glyph ID to query |
name | Name string retrieved for the glyph ID |
true if data found, false otherwiseA 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.
font | #hb_font_t to work upon |
fontData | font user data pointer |
glyph | The glyph ID to query |
x | The X coordinate of the origin |
y | The Y coordinate of the origin |
true if data found, false otherwiseA virtual method for the #hb_font_funcs_t of an #hb_font_t object.
font | #hb_font_t to work upon |
fontData | font user data pointer |
glyph | The glyph ID to query |
drawFuncs | The draw functions to send the shape data to |
drawData | The data accompanying the draw functions |
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.
font | #hb_font_t to work upon |
fontData | font user data pointer |
unicode | The Unicode code point to query |
glyph | The glyph ID retrieved |
true if data found, false otherwiseA 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.
font | #hb_font_t to work upon |
fontData | font user data pointer |
unicode | The Unicode code point to query |
variationSelector | The variation-selector code point to query |
glyph | The glyph ID retrieved |
true if data found, false otherwiseA virtual method for the #hb_font_funcs_t of an #hb_font_t object.
font | #hb_font_t to work upon |
fontData | font user data pointer |
glyph | The glyph ID to query |
paintFuncs | The paint functions to use |
paintData | The data accompanying the paint functions |
paletteIndex | The color palette to use |
foreground | The foreground color |
A virtual method for the #hb_paint_funcs_t to paint a color everywhere within the current clip.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
isForeground | whether the color is the foreground |
color | The color to use, unpremultiplied |
A virtual method for the #hb_paint_funcs_t to render a color glyph by glyph index.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
glyph | the glyph ID |
font | the font |
A virtual method for the #hb_paint_funcs_t to fetch a color from the custom color palette.
Custom palette colors override the colors from the fonts selected color palette. It is not necessary to override all palette entries; for entries that should be taken from the font palette, return false.
This function might get called multiple times, but the custom palette is expected to remain unchanged for duration of a [harfbuzz.global.fontPaintGlyph] call.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
colorIndex | the color index |
color | fetched color |
true if found, false otherwiseA virtual method for the #hb_paint_funcs_t to paint a glyph image.
This method is called for glyphs with image blobs in the CBDT, sbix or SVG tables. The format identifies the kind of data that is contained in image. Possible values include #HB_PAINT_IMAGE_FORMAT_PNG, #HB_PAINT_IMAGE_FORMAT_SVG and #HB_PAINT_IMAGE_FORMAT_BGRA.
The image dimensions and glyph extents are provided if available, and should be used to size and position the image.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
image | the image data |
width | width of the raster image in pixels, or 0 |
height | height of the raster image in pixels, or 0 |
format | the image format as a tag |
slant | the synthetic slant ratio to be applied to the image during rendering |
extents | glyph extents for desired rendering |
A virtual method for the #hb_paint_funcs_t to paint a linear gradient everywhere within the current clip.
The color_line object contains information about the colors of the gradients. It is only valid for the duration of the callback, you cannot keep it around.
The coordinates of the points are interpreted according to the current transform.
See the OpenType spec COLR section for details on how the points define the direction of the gradient, and how to interpret the color_line.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
colorLine | Color information for the gradient |
x0 | X coordinate of the first point |
y0 | Y coordinate of the first point |
x1 | X coordinate of the second point |
y1 | Y coordinate of the second point |
x2 | X coordinate of the third point |
y2 | Y coordinate of the third point |
A virtual method for the #hb_paint_funcs_t to undo the effect of a prior call to the #hb_paint_funcs_push_clip_glyph_func_t or #hb_paint_funcs_push_clip_rectangle_func_t vfuncs.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
A virtual method for the #hb_paint_funcs_t to undo the effect of a prior call to the #hb_paint_funcs_push_group_func_t vfunc.
This call stops the redirection to the intermediate surface, and then composites it on the previous surface, using the compositing mode passed to this call.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
mode | the compositing mode to use |
A virtual method for the #hb_paint_funcs_t to undo the effect of a prior call to the #hb_paint_funcs_push_transform_func_t vfunc.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
A virtual method for the #hb_paint_funcs_t to clip subsequent paint calls to the outline of a glyph.
The coordinates of the glyph outline are interpreted according to the current transform.
This clip is applied in addition to the current clip, and remains in effect until a matching call to the #hb_paint_funcs_pop_clip_func_t vfunc.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
glyph | the glyph ID |
font | the font |
A virtual method for the #hb_paint_funcs_t to clip subsequent paint calls to a rectangle.
The coordinates of the rectangle are interpreted according to the current transform.
This clip is applied in addition to the current clip, and remains in effect until a matching call to the #hb_paint_funcs_pop_clip_func_t vfunc.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
xmin | min X for the rectangle |
ymin | min Y for the rectangle |
xmax | max X for the rectangle |
ymax | max Y for the rectangle |
A virtual method for the #hb_paint_funcs_t to use an intermediate surface for subsequent paint calls.
The drawing will be redirected to an intermediate surface until a matching call to the #hb_paint_funcs_pop_group_func_t vfunc.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
A virtual method for the #hb_paint_funcs_t to apply a transform to subsequent paint calls.
This transform is applied after the current transform, and remains in effect until a matching call to the #hb_paint_funcs_pop_transform_func_t vfunc.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
xx | xx component of the transform matrix |
yx | yx component of the transform matrix |
xy | xy component of the transform matrix |
yy | yy component of the transform matrix |
dx | dx component of the transform matrix |
dy | dy component of the transform matrix |
A virtual method for the #hb_paint_funcs_t to paint a radial gradient everywhere within the current clip.
The color_line object contains information about the colors of the gradients. It is only valid for the duration of the callback, you cannot keep it around.
The coordinates of the points are interpreted according to the current transform.
See the OpenType spec COLR section for details on how the points define the direction of the gradient, and how to interpret the color_line.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
colorLine | Color information for the gradient |
x0 | X coordinate of the first circle's center |
y0 | Y coordinate of the first circle's center |
r0 | radius of the first circle |
x1 | X coordinate of the second circle's center |
y1 | Y coordinate of the second circle's center |
r1 | radius of the second circle |
A virtual method for the #hb_paint_funcs_t to paint a sweep gradient everywhere within the current clip.
The color_line object contains information about the colors of the gradients. It is only valid for the duration of the callback, you cannot keep it around.
The coordinates of the points are interpreted according to the current transform.
See the OpenType spec COLR section for details on how the points define the direction of the gradient, and how to interpret the color_line.
funcs | paint functions object |
paintData | The data accompanying the paint functions in [harfbuzz.global.fontPaintGlyph] |
colorLine | Color information for the gradient |
x0 | X coordinate of the circle's center |
y0 | Y coordinate of the circle's center |
startAngle | the start angle, in radians |
endAngle | the end angle, in radians |
Callback function for [harfbuzz.global.faceCreateForTables].
face | an #hb_face_t to reference table for |
tag | the tag of the table to reference |
A virtual method for the #hb_unicode_funcs_t structure.
This method should retrieve the Canonical Combining Class (ccc) property for a specified Unicode code point.
ufuncs | A Unicode-functions structure |
unicode | The code point to query |
A virtual method for the #hb_unicode_funcs_t structure.
This method should compose a sequence of two input Unicode code points by canonical equivalence, returning the composed code point in a #hb_codepoint_t output parameter (if successful). The method must return an #hb_bool_t indicating the success of the composition.
ufuncs | A Unicode-functions structure |
a | The first code point to compose |
b | The second code point to compose |
ab | The composed code point |
true is a,b composed, false otherwiseA virtual method for the #hb_unicode_funcs_t structure.
This method should decompose an input Unicode code point, returning the two decomposed code points in #hb_codepoint_t output parameters (if successful). The method must return an #hb_bool_t indicating the success of the composition.
ufuncs | A Unicode-functions structure |
ab | The code point to decompose |
a | The first decomposed code point |
b | The second decomposed code point |
true if ab decomposed, false otherwiseA virtual method for the #hb_unicode_funcs_t structure.
ufuncs | A Unicode-functions structure |
unicode | The code point to query |
A virtual method for the #hb_unicode_funcs_t structure.
This method should retrieve the General Category property for a specified Unicode code point.
ufuncs | A Unicode-functions structure |
unicode | The code point to query |
A virtual method for the #hb_unicode_funcs_t structure.
This method should retrieve the Bi-Directional Mirroring Glyph code point for a specified Unicode code point.
<note>Bi-Directional Mirroring Glyph defined, the method should return the original code point.</note>
ufuncs | A Unicode-functions structure |
unicode | The code point to query |
A virtual method for the #hb_unicode_funcs_t structure.
This method should retrieve the Script property for a specified Unicode code point.
ufuncs | A Unicode-functions structure |
unicode | The code point to query |
AAT_LAYOUT_NO_SELECTOR_INDEX = 65535Used when getting or setting AAT feature selectors. Indicates that there is no selector index corresponding to the selector of interest.
BUFFER_REPLACEMENT_CODEPOINT_DEFAULT = 65533The default code point for replacing invalid characters in a given encoding. Set to U+FFFD REPLACEMENT CHARACTER.
CODEPOINT_INVALID = 4294967295Unused #hb_codepoint_t value.
FEATURE_GLOBAL_START = 0Special setting for #hb_feature_t.start to apply the feature from the start of the buffer.
FONT_NO_VAR_NAMED_INSTANCE = 4294967295Constant signifying that a font does not have any named-instance index set. This is the default of a font.
LANGUAGE_INVALID = 0An unset #hb_language_t.
OT_LAYOUT_DEFAULT_LANGUAGE_INDEX = 65535Special value for language index indicating default or unsupported language.
OT_LAYOUT_NO_FEATURE_INDEX = 65535Special value for feature index indicating unsupported feature.
OT_LAYOUT_NO_SCRIPT_INDEX = 65535Special value for script index indicating unsupported script.
OT_LAYOUT_NO_VARIATIONS_INDEX = 4294967295Special value for variations index indicating unsupported variation.
OT_MAX_TAGS_PER_LANGUAGE = 3Maximum number of OpenType tags that can correspond to a give #hb_language_t.
OT_MAX_TAGS_PER_SCRIPT = 3Maximum number of OpenType tags that can correspond to a give #hb_script_t.
OT_VAR_NO_AXIS_INDEX = 4294967295Do not use.
UNICODE_COMBINING_CLASS_CCC133 = 133[Tibetan]
UNICODE_MAX = 1114111Maximum valid Unicode code point.
UNICODE_MAX_DECOMPOSITION_LEN = 19See Unicode 6.1 for details on the maximum decomposition length.
VERSION_MAJOR = 8VERSION_MICRO = 0VERSION_MINOR = 3VERSION_STRING = "8.3.0"