/** * hb_font_t: * * Data type for holding fonts. *
*/ typedefstruct hb_font_t hb_font_t;
/* * 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. *
**/ typedefstruct hb_font_funcs_t hb_font_funcs_t;
/** * hb_font_extents_t: * @ascender: The height of typographic ascenders. * @descender: The depth of typographic descenders. * @line_gap: The suggested line-spacing gap. * * Font-wide extent values, measured in font units. * * Note that typically @ascender is positive and @descender * negative, in coordinate systems that grow up.
**/ typedefstruct hb_font_extents_t {
hb_position_t ascender;
hb_position_t descender;
hb_position_t line_gap; /*< private >*/
hb_position_t reserved9;
hb_position_t reserved8;
hb_position_t reserved7;
hb_position_t reserved6;
hb_position_t reserved5;
hb_position_t reserved4;
hb_position_t reserved3;
hb_position_t reserved2;
hb_position_t reserved1;
} hb_font_extents_t;
/** * hb_glyph_extents_t: * @x_bearing: Distance from the x-origin to the left extremum of the glyph. * @y_bearing: Distance from the top extremum of the glyph to the y-origin. * @width: Distance from the left extremum of the glyph to the right extremum. * @height: Distance from the top extremum of the glyph to the bottom extremum. * * Glyph extent values, measured in font units. * * Note that @height is negative, in coordinate systems that grow up.
**/ typedefstruct hb_glyph_extents_t {
hb_position_t x_bearing;
hb_position_t y_bearing;
hb_position_t width;
hb_position_t height;
} hb_glyph_extents_t;
/* func types */
/** * hb_font_get_font_extents_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @extents: (out): The font extents retrieved * @user_data: User data pointer passed by the caller * * This method should retrieve the extents for a font. *
**/ typedef 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);
/** * 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. *
**/ typedef hb_font_get_font_extents_func_t hb_font_get_font_h_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. *
**/ typedef hb_font_get_font_extents_func_t hb_font_get_font_v_extents_func_t;
/** * hb_font_get_nominal_glyph_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @unicode: The Unicode code point to query * @glyph: (out): The glyph ID retrieved * @user_data: User data pointer passed by the caller * * 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. * * Return value: %true if data found, %false otherwise *
**/ typedef 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);
/** * hb_font_get_variation_glyph_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @unicode: The Unicode code point to query * @variation_selector: The variation-selector code point to query * @glyph: (out): The glyph ID retrieved * @user_data: User data pointer passed by the caller * * 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. * * Return value: %true if data found, %false otherwise *
**/ typedef 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);
/** * hb_font_get_nominal_glyphs_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @count: number of code points to query * @first_unicode: The first Unicode code point to query * @unicode_stride: The stride between successive code points * @first_glyph: (out): The first glyph ID retrieved * @glyph_stride: The stride between successive glyph IDs * @user_data: User data pointer passed by the caller * * 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. * * Return value: the number of code points processed *
**/ typedefunsignedint (*hb_font_get_nominal_glyphs_func_t) (hb_font_t *font, void *font_data, unsignedint count, const hb_codepoint_t *first_unicode, unsignedint unicode_stride,
hb_codepoint_t *first_glyph, unsignedint glyph_stride, void *user_data);
/** * hb_font_get_glyph_advance_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @glyph: The glyph ID to query * @user_data: User data pointer passed by the caller * * 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. * * Return value: The advance of @glyph within @font *
**/ typedef hb_position_t (*hb_font_get_glyph_advance_func_t) (hb_font_t *font, void *font_data,
hb_codepoint_t glyph, void *user_data);
/** * 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. *
**/ typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_h_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. *
**/ typedef hb_font_get_glyph_advance_func_t hb_font_get_glyph_v_advance_func_t;
/** * hb_font_get_glyph_advances_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @count: The number of glyph IDs in the sequence queried * @first_glyph: The first glyph ID to query * @glyph_stride: The stride between successive glyph IDs * @first_advance: (out): The first advance retrieved * @advance_stride: The stride between successive advances * @user_data: User data pointer passed by the caller * * 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. *
**/ typedefvoid (*hb_font_get_glyph_advances_func_t) (hb_font_t* font, void* font_data, unsignedint count, const hb_codepoint_t *first_glyph, unsigned glyph_stride,
hb_position_t *first_advance, unsigned advance_stride, void *user_data);
/** * 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. *
**/ typedef hb_font_get_glyph_advances_func_t hb_font_get_glyph_h_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. *
**/ typedef hb_font_get_glyph_advances_func_t hb_font_get_glyph_v_advances_func_t;
/** * hb_font_get_glyph_origin_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @glyph: The glyph ID to query * @x: (out): The X coordinate of the origin * @y: (out): The Y coordinate of the origin * @user_data: User data pointer passed by the caller * * 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. * * Return value: %true if data found, %false otherwise *
**/ typedef 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);
/** * 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. *
**/ typedef hb_font_get_glyph_origin_func_t hb_font_get_glyph_h_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. *
**/ typedef hb_font_get_glyph_origin_func_t hb_font_get_glyph_v_origin_func_t;
/** * hb_font_get_glyph_kerning_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @first_glyph: The glyph ID of the first glyph in the glyph pair * @second_glyph: The glyph ID of the second glyph in the glyph pair * @user_data: User data pointer passed by the caller * * This method should retrieve the kerning-adjustment value for a glyph-pair in * the specified font, for horizontal text segments. *
**/ typedef 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); /** * 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. *
**/ typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_h_kerning_func_t;
/** * hb_font_get_glyph_extents_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @glyph: The glyph ID to query * @extents: (out): The #hb_glyph_extents_t retrieved * @user_data: User data pointer passed by the caller * * 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. * * Return value: %true if data found, %false otherwise *
**/ typedef 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);
/** * hb_font_get_glyph_contour_point_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @glyph: The glyph ID to query * @point_index: The contour-point index to query * @x: (out): The X value retrieved for the contour point * @y: (out): The Y value retrieved for the contour point * @user_data: User data pointer passed by the caller * * 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. * * Return value: %true if data found, %false otherwise *
**/ typedef hb_bool_t (*hb_font_get_glyph_contour_point_func_t) (hb_font_t *font, void *font_data,
hb_codepoint_t glyph, unsignedint point_index,
hb_position_t *x, hb_position_t *y, void *user_data);
/** * hb_font_get_glyph_name_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @glyph: The glyph ID to query * @name: (out) (array length=size): Name string retrieved for the glyph ID * @size: Length of the glyph-name string retrieved * @user_data: User data pointer passed by the caller * * 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. * * Return value: %true if data found, %false otherwise *
**/ typedef hb_bool_t (*hb_font_get_glyph_name_func_t) (hb_font_t *font, void *font_data,
hb_codepoint_t glyph, char *name, unsignedint size, void *user_data);
/** * hb_font_get_glyph_from_name_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @name: (array length=len): The name string to query * @len: The length of the name queried * @glyph: (out): The glyph ID retrieved * @user_data: User data pointer passed by the caller * * 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. * * Return value: %true if data found, %false otherwise *
**/ typedef hb_bool_t (*hb_font_get_glyph_from_name_func_t) (hb_font_t *font, void *font_data, constchar *name, int len, /* -1 means nul-terminated */
hb_codepoint_t *glyph, void *user_data);
/** * hb_font_get_glyph_shape_func_t: * @font: #hb_font_t to work upon * @font_data: @font user data pointer * @glyph: The glyph ID to query * @draw_funcs: The draw functions to send the shape data to * @draw_data: The data accompanying the draw functions * @user_data: User data pointer passed by the caller * * A virtual method for the #hb_font_funcs_t of an #hb_font_t object. * * Since: 4.0.0 *
**/ typedefvoid (*hb_font_get_glyph_shape_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);
/* func setters */
/** * hb_font_funcs_set_font_h_extents_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_font_h_extents_func_t. * * Since: 1.1.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_font_v_extents_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_font_v_extents_func_t. * * Since: 1.1.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_nominal_glyph_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_nominal_glyph_func_t. * * Since: 1.2.3
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_nominal_glyphs_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_nominal_glyphs_func_t. * * Since: 2.0.0
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_variation_glyph_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_variation_glyph_func_t. * * Since: 1.2.3
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_h_advance_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_h_advance_func_t. * * Since: 0.9.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_v_advance_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_v_advance_func_t. * * Since: 0.9.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_h_advances_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_h_advances_func_t. * * Since: 1.8.6
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_v_advances_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_v_advances_func_t. * * Since: 1.8.6
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_h_origin_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_h_origin_func_t. * * Since: 0.9.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_v_origin_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_v_origin_func_t. * * Since: 0.9.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_h_kerning_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_h_kerning_func_t. * * Since: 0.9.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_extents_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_extents_func_t. * * Since: 0.9.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_contour_point_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_contour_point_func_t. * * Since: 0.9.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_name_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_name_func_t. * * Since: 0.9.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_from_name_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_from_name_func_t. * * Since: 0.9.2
**/
HB_EXTERN 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);
/** * hb_font_funcs_set_glyph_shape_func: * @ffuncs: A font-function structure * @func: (closure user_data) (destroy destroy) (scope notified): The callback function to assign * @user_data: Data to pass to @func * @destroy: (nullable): The function to call when @user_data is not needed anymore * * Sets the implementation function for #hb_font_get_glyph_shape_func_t. * * Since: 4.0.0
**/
HB_EXTERN void
hb_font_funcs_set_glyph_shape_func (hb_font_funcs_t *ffuncs,
hb_font_get_glyph_shape_func_t func, void *user_data, hb_destroy_func_t destroy);
/* * Point size per EM. Used for optical-sizing in CoreText. * A value of zero means "not set".
*/
HB_EXTERN void
hb_font_set_ptem (hb_font_t *font, float ptem);
