[subset] link to preprocessing doc from api comment.

This commit is contained in:
Garret Rieger 2022-12-07 22:53:44 +00:00
parent c097abab52
commit 13b0388351
2 changed files with 6 additions and 2 deletions

View File

@ -22,8 +22,10 @@ hb_face_t* subset = hb_subset_or_fail (preprocessed, subset_input);
things up.
* The preprocessing operation may take longer then the time it takes to produce a subset from the
source font. Thus the main performance gains are made when a preprocessed face is reused for multiple
subsetting operations.
source font. Thus the main performance gains are made when a preprocessed face is reused for
multiple subsetting operations.
* Currently the largest performance gains are seen when using a preprocessed face for CFF subsetting.
* The preprocessed face may contain references to the memory backing the source face. If this memory
is fully owned by a harfbuzz hb_blob_t* then it will automatically be kept alive for the lifetime

View File

@ -456,6 +456,8 @@ hb_subset_input_pin_axis_location (hb_subset_input_t *input,
* subsetter. Future subsetting operations can then use the precomputed data
* to speed up the subsetting operation. Returns a new hb_face_t*.
*
* See docs/subset-preprocessing.md for more information.
*
* Note: the preprocessed face may contain sub-blobs that reference the memory
* backing the source hb_face_t*. Therefore in the case that this memory is not
* owned by the source face you will need to ensure that memory lives