hb-deprecated

hb-deprecated — Deprecated API

Functions

Types and Values

Includes

#include <hb.h>

Description

These API have been deprecated in favor of newer API, or because they were deemed unnecessary.

Functions

hb_font_get_glyph_func_t ()

hb_bool_t
(*hb_font_get_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_glyph_func_t has been deprecated since version 1.2.3 and should not be used in newly-written code.

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 font, with an optional variation selector.

Parameters

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

The glyph ID retrieved.

[out]

user_data

User data pointer passed by the caller

 

Returns

true if data found, false otherwise


hb_ot_layout_table_find_script ()

hb_bool_t
hb_ot_layout_table_find_script (hb_face_t *face,
                                hb_tag_t table_tag,
                                hb_tag_t script_tag,
                                unsigned int *script_index);

Fetches the index if a given script tag in the specified face's GSUB table or GPOS table.

Parameters

face

hb_face_t to work upon

 

table_tag

HB_OT_TAG_GSUB or HB_OT_TAG_GPOS

 

script_tag

hb_tag_t of the script tag requested

 

script_index

The index of the requested script tag.

[out]

Returns

true if the script is found, false otherwise


hb_unicode_eastasian_width_func_t ()

unsigned int
(*hb_unicode_eastasian_width_func_t) (hb_unicode_funcs_t *ufuncs,
                                      hb_codepoint_t unicode,
                                      void *user_data);

hb_unicode_eastasian_width_func_t has been deprecated since version 2.0.0 and should not be used in newly-written code.

A virtual method for the hb_unicode_funcs_t structure.

Parameters

ufuncs

A Unicode-functions structure

 

unicode

The code point to query

 

user_data

User data pointer passed by the caller

 

hb_unicode_eastasian_width ()

unsigned int
hb_unicode_eastasian_width (hb_unicode_funcs_t *ufuncs,
                            hb_codepoint_t unicode);

hb_unicode_eastasian_width has been deprecated since version 2.0.0 and should not be used in newly-written code.

Don't use. Not used by HarfBuzz.

Parameters

ufuncs

a Unicode-function structure

 

unicode

The code point to query

 

Since: 0.9.2


hb_unicode_funcs_set_eastasian_width_func ()

void
hb_unicode_funcs_set_eastasian_width_func
                               (hb_unicode_funcs_t *ufuncs,
                                hb_unicode_eastasian_width_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

hb_unicode_funcs_set_eastasian_width_func has been deprecated since version 2.0.0 and should not be used in newly-written code.

Sets the implementation function for hb_unicode_eastasian_width_func_t.

Parameters

ufuncs

a Unicode-function structure

 

func

The callback function to assign.

[closure user_data][destroy destroy][scope notified]

user_data

Data to pass to func

 

destroy

The function to call when user_data is not needed anymore.

[nullable]

Since: 0.9.2


hb_unicode_decompose_compatibility_func_t ()

unsigned int
(*hb_unicode_decompose_compatibility_func_t)
                               (hb_unicode_funcs_t *ufuncs,
                                hb_codepoint_t u,
                                hb_codepoint_t *decomposed,
                                void *user_data);

hb_unicode_decompose_compatibility_func_t has been deprecated since version 2.0.0 and should not be used in newly-written code.

Fully decompose u to its Unicode compatibility decomposition. The codepoints of the decomposition will be written to decomposed . The complete length of the decomposition will be returned.

If u has no compatibility decomposition, zero should be returned.

The Unicode standard guarantees that a buffer of length HB_UNICODE_MAX_DECOMPOSITION_LEN codepoints will always be sufficient for any compatibility decomposition plus an terminating value of 0. Consequently, decompose must be allocated by the caller to be at least this length. Implementations of this function type must ensure that they do not write past the provided array.

Parameters

ufuncs

a Unicode function structure

 

u

codepoint to decompose

 

decomposed

address of codepoint array (of length HB_UNICODE_MAX_DECOMPOSITION_LEN) to write decomposition into

 

user_data

user data pointer as passed to hb_unicode_funcs_set_decompose_compatibility_func()

 

Returns

number of codepoints in the full compatibility decomposition of u , or 0 if no decomposition available.


hb_unicode_decompose_compatibility ()

unsigned int
hb_unicode_decompose_compatibility (hb_unicode_funcs_t *ufuncs,
                                    hb_codepoint_t u,
                                    hb_codepoint_t *decomposed);

hb_unicode_decompose_compatibility has been deprecated since version 2.0.0 and should not be used in newly-written code.

Fetches the compatibility decomposition of a Unicode code point. Deprecated.

Parameters

ufuncs

The Unicode-functions structure

 

u

Code point to decompose

 

decomposed

Compatibility decomposition of u .

[out]

Returns

length of decomposed .

Since: 0.9.2


hb_unicode_funcs_set_decompose_compatibility_func ()

void
hb_unicode_funcs_set_decompose_compatibility_func
                               (hb_unicode_funcs_t *ufuncs,
                                hb_unicode_decompose_compatibility_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

hb_unicode_funcs_set_decompose_compatibility_func has been deprecated since version 2.0.0 and should not be used in newly-written code.

Sets the implementation function for hb_unicode_decompose_compatibility_func_t.

Parameters

ufuncs

A Unicode-functions structure

 

func

The callback function to assign.

[closure user_data][destroy destroy][scope notified]

user_data

Data to pass to func

 

destroy

The function to call when user_data is not needed anymore.

[nullable]

Since: 0.9.2


hb_font_funcs_set_glyph_v_kerning_func ()

void
hb_font_funcs_set_glyph_v_kerning_func
                               (hb_font_funcs_t *ffuncs,
                                hb_font_get_glyph_v_kerning_func_t func,
                                void *user_data,
                                hb_destroy_func_t destroy);

hb_font_funcs_set_glyph_v_kerning_func has been deprecated since version 2.0.0 and should not be used in newly-written code.

Sets the implementation function for hb_font_get_glyph_v_kerning_func_t.

Parameters

ffuncs

A font-function structure

 

func

The callback function to assign.

[closure user_data][destroy destroy][scope notified]

user_data

Data to pass to func

 

destroy

The function to call when user_data is not needed anymore.

[nullable]

Since: 0.9.2


hb_font_get_glyph_v_kerning ()

hb_position_t
hb_font_get_glyph_v_kerning (hb_font_t *font,
                             hb_codepoint_t top_glyph,
                             hb_codepoint_t bottom_glyph);

hb_font_get_glyph_v_kerning has been deprecated since version 2.0.0 and should not be used in newly-written code.

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

It handles legacy kerning only (as returned by the corresponding hb_font_funcs_t function).

Parameters

font

hb_font_t to work upon

 

top_glyph

The glyph ID of the top glyph in the glyph pair

 

bottom_glyph

The glyph ID of the bottom glyph in the glyph pair

 

Returns

The kerning adjustment value

Since: 0.9.2

Types and Values

HB_BUFFER_FLAGS_DEFAULT

#define HB_BUFFER_FLAGS_DEFAULT			HB_BUFFER_FLAG_DEFAULT

HB_BUFFER_FLAGS_DEFAULT has been deprecated since version 0.9.20 and should not be used in newly-written code.

Use HB_BUFFER_FLAG_DEFAULT instead.


HB_BUFFER_SERIALIZE_FLAGS_DEFAULT

#define HB_BUFFER_SERIALIZE_FLAGS_DEFAULT HB_BUFFER_SERIALIZE_FLAG_DEFAULT

HB_BUFFER_SERIALIZE_FLAGS_DEFAULT has been deprecated since version 0.9.20 and should not be used in newly-written code.

Use HB_BUFFER_SERIALIZE_FLAG_DEFAULT instead.


HB_SCRIPT_CANADIAN_ABORIGINAL

#define HB_SCRIPT_CANADIAN_ABORIGINAL		HB_SCRIPT_CANADIAN_SYLLABICS

HB_SCRIPT_CANADIAN_ABORIGINAL has been deprecated since version 0.9.20 and should not be used in newly-written code.

Use HB_SCRIPT_CANADIAN_SYLLABICS instead:


HB_MATH_GLYPH_PART_FLAG_EXTENDER

#define HB_MATH_GLYPH_PART_FLAG_EXTENDER HB_OT_MATH_GLYPH_PART_FLAG_EXTENDER

HB_MATH_GLYPH_PART_FLAG_EXTENDER has been deprecated since version 2.5.1 and should not be used in newly-written code.

Use HB_OT_MATH_GLYPH_PART_FLAG_EXTENDER instead.


HB_OT_MATH_SCRIPT

#define HB_OT_MATH_SCRIPT HB_OT_TAG_MATH_SCRIPT

HB_OT_MATH_SCRIPT has been deprecated since version 3.4.0 and should not be used in newly-written code.

Use HB_SCRIPT_MATH or HB_OT_TAG_MATH_SCRIPT instead.

Previous versions of this documentation recommended passing HB_OT_MATH_SCRIPT to hb_buffer_set_script() to enable math shaping, but this usage is no longer supported. Use HB_SCRIPT_MATH instead.

Since: 1.3.3


HB_OT_VAR_NO_AXIS_INDEX

#define HB_OT_VAR_NO_AXIS_INDEX		0xFFFFFFFFu

HB_OT_VAR_NO_AXIS_INDEX has been deprecated since version 2.2.0 and should not be used in newly-written code.

Do not use.

Since: 1.4.2


hb_ot_var_axis_t

typedef struct {
  hb_tag_t tag;
  hb_ot_name_id_t name_id;
  float min_value;
  float default_value;
  float max_value;
} hb_ot_var_axis_t;

hb_ot_var_axis_t has been deprecated since version 2.2.0 and should not be used in newly-written code.

Use hb_ot_var_axis_info_t instead.

Members

hb_tag_t tag;

axis tag

 

hb_ot_name_id_t name_id;

axis name identifier

 

float min_value;

minimum value of the axis

 

float default_value;

default value of the axis

 

float max_value;

maximum value of the axis

 

Since: 1.4.2


HB_UNICODE_MAX_DECOMPOSITION_LEN

#define HB_UNICODE_MAX_DECOMPOSITION_LEN (18+1) /* codepoints */

HB_UNICODE_MAX_DECOMPOSITION_LEN has been deprecated since version 2.0.0 and should not be used in newly-written code.

See Unicode 6.1 for details on the maximum decomposition length.


hb_font_get_glyph_v_kerning_func_t

typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_v_kerning_func_t;

hb_font_get_glyph_v_kerning_func_t is deprecated and should not be used in newly-written code.

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.