Top |
enum | hb_subset_flags_t |
typedef | hb_subset_input_t |
enum | hb_subset_sets_t |
typedef | hb_subset_plan_t |
Subsetting reduces the codepoint coverage of font files and removes all data that is no longer needed. A subset input describes the desired subset. The input is provided along with a font to the subsetting operation. Output is a new font file containing only the data specified in the input.
Currently most outline and bitmap tables are supported: glyf, CFF, CFF2, sbix, COLR, and CBDT/CBLC. This also includes fonts with variable outlines via OpenType variations. Notably EBDT/EBLC and SVG are not supported. Layout subsetting is supported only for OpenType Layout tables (GSUB, GPOS, GDEF). Notably subsetting of graphite or AAT tables is not yet supported.
Fonts with graphite or AAT tables may still be subsetted but will likely need to use the retain glyph ids option and configure the subset to pass through the layout tables untouched.
hb_subset_input_t *
hb_subset_input_create_or_fail (void
);
Creates a new subset input object.
New subset input, or NULL
if failed. Destroy
with hb_subset_input_destroy()
.
[transfer full]
Since: 1.8.0
hb_subset_input_t *
hb_subset_input_reference (hb_subset_input_t *input
);
Increases the reference count on input
.
[skip]
Since: 1.8.0
void
hb_subset_input_destroy (hb_subset_input_t *input
);
Decreases the reference count on input
, and if it reaches zero, destroys
input
, freeing all memory.
Since: 1.8.0
hb_bool_t hb_subset_input_set_user_data (hb_subset_input_t *input
,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 given subset input object.
[skip]
input |
a hb_subset_input_t object. |
|
key |
The user-data key to set |
|
data |
A pointer to the user data |
|
destroy |
A callback to call when |
[nullable] |
replace |
Whether to replace an existing data with the same key |
Since: 2.9.0
void * hb_subset_input_get_user_data (const hb_subset_input_t *input
,hb_user_data_key_t *key
);
Fetches the user data associated with the specified key, attached to the specified subset input object.
[skip]
Since: 2.9.0
hb_subset_flags_t
hb_subset_input_get_flags (hb_subset_input_t *input
);
Gets all of the subsetting flags in the input object.
Since: 2.9.0
void hb_subset_input_set_flags (hb_subset_input_t *input
,unsigned value
);
Sets all of the flags in the input object to the values specified by the bit field.
Since: 2.9.0
hb_set_t *
hb_subset_input_unicode_set (hb_subset_input_t *input
);
Gets the set of Unicode code points to retain, the caller should modify the set as needed.
Since: 1.8.0
hb_set_t *
hb_subset_input_glyph_set (hb_subset_input_t *input
);
Gets the set of glyph IDs to retain, the caller should modify the set as needed.
Since: 1.8.0
hb_set_t * hb_subset_input_set (hb_subset_input_t *input
,hb_subset_sets_t set_type
);
Gets the set of the specified type.
Since: 2.9.1
hb_face_t * hb_subset_or_fail (hb_face_t *source
,const hb_subset_input_t *input
);
Subsets a font according to provided input. Returns nullptr if the subset operation fails.
Since: 2.9.0
hb_subset_plan_t * hb_subset_plan_create_or_fail (hb_face_t *face
,const hb_subset_input_t *input
);
Computes a plan for subsetting the supplied face according to a provided input. The plan describes which tables and glyphs should be retained.
New subset plan. Destroy with
hb_subset_plan_destroy()
. If there is a failure creating the plan
nullptr will be returned.
[transfer full]
Since: 4.0.0
hb_subset_plan_t *
hb_subset_plan_reference (hb_subset_plan_t *plan
);
Increases the reference count on plan
.
[skip]
Since: 4.0.0
void
hb_subset_plan_destroy (hb_subset_plan_t *plan
);
Decreases the reference count on plan
, and if it reaches zero, destroys
plan
, freeing all memory.
Since: 4.0.0
hb_bool_t hb_subset_plan_set_user_data (hb_subset_plan_t *plan
,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 given subset plan object.
[skip]
plan |
a hb_subset_plan_t object. |
|
key |
The user-data key to set |
|
data |
A pointer to the user data |
|
destroy |
A callback to call when |
[nullable] |
replace |
Whether to replace an existing data with the same key |
Since: 4.0.0
void * hb_subset_plan_get_user_data (const hb_subset_plan_t *plan
,hb_user_data_key_t *key
);
Fetches the user data associated with the specified key, attached to the specified subset plan object.
[skip]
Since: 4.0.0
hb_face_t *
hb_subset_plan_execute_or_fail (hb_subset_plan_t *plan
);
Executes the provided subsetting plan
.
on success returns a reference to generated font subset. If the subsetting operation fails returns nullptr.
Since: 4.0.0
const hb_map_t *
hb_subset_plan_unicode_to_old_glyph_mapping
(const hb_subset_plan_t *plan
);
Returns the mapping between codepoints in the original font and the associated glyph id in the original font.
Since: 4.0.0
const hb_map_t *
hb_subset_plan_new_to_old_glyph_mapping
(const hb_subset_plan_t *plan
);
Returns the mapping between glyphs in the subset that will be produced by
plan
and the glyph in the original font.
Since: 4.0.0
const hb_map_t *
hb_subset_plan_old_to_new_glyph_mapping
(const hb_subset_plan_t *plan
);
Returns the mapping between glyphs in the original font to glyphs in the
subset that will be produced by plan
Since: 4.0.0
List of boolean properties that can be configured on the subset input.
all flags at their default value of false. |
||
If set hinting instructions will be dropped in the produced subset. Otherwise hinting instructions will be retained. |
||
If set glyph indices will not be modified in the produced subset. If glyphs are dropped their indices will be retained as an empty glyph. |
||
If set and subsetting a CFF font the subsetter will attempt to remove subroutines from the CFF glyphs. |
||
If set non-unicode name records will be retained in the subset. |
||
If set the subsetter will set the OVERLAP_SIMPLE flag on each simple glyph. |
||
If set the subsetter will not drop unrecognized tables and instead pass them through untouched. |
||
If set the notdef glyph outline will be retained in the final subset. |
||
If set the PS glyph names will be retained in the final subset. |
||
If set then the unicode ranges in OS/2 will not be recalculated. |
Since: 2.9.0
typedef struct hb_subset_input_t hb_subset_input_t;
Things that change based on the input. Characters to keep, etc.
List of sets that can be configured on the subset input.
the set of glyph indexes to retain in the subset. |
||
the set of unicode codepoints to retain in the subset. |
||
the set of table tags which specifies tables that should not be subsetted. |
||
the set of table tags which specifies tables which will be dropped in the subset. |
||
the set of name ids that will be retained. |
||
the set of name lang ids that will be retained. |
||
the set of layout feature tags that will be retained in the subset. |
Since: 2.9.1