walkero
/
harfbuzz
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve docs for hb_ot_layout_get_ligature_carets 

Add some relevant details to the documentation
for this function.

Fixes: #3168
This commit is contained in:
Matthias Clasen 2022-02-15 18:02:09 -06:00 committed by Behdad Esfahbod
parent a396543ae1
commit 9909e33268
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/hb-ot-layout.cc
View File

@ -361,6 +361,13 @@ hb_ot_layout_get_attach_points (hb_face_t *face,
* Fetches a list of the caret positions defined for a ligature glyph in the GDEF
* table of the font. The list returned will begin at the offset provided.
*
* Note that a ligature that is formed from n characters will have n-1
* caret positions. The first character is not represented in the array,
* since its caret position is the glyph position.
*
* The positions returned by this function are 'unshaped', and will have to
* be fixed up for kerning that may be applied to the ligature glyph.
*
* Return value: Total number of ligature caret positions for @glyph.
*
**/