[layout] Document hb_ot_layout_lookup_get_optical_bound()

This commit is contained in:
Behdad Esfahbod 2022-09-01 13:47:12 -06:00
parent 71c6cba097
commit 752060a49c
1 changed files with 14 additions and 0 deletions

View File

@ -2396,6 +2396,20 @@ struct hb_position_single_dispatch_t :
( _dispatch (obj, hb_prioritize, std::forward<Ts> (ds)...) )
};
/**
* hb_ot_layout_lookup_get_optical_bound:
* @face: a font.
* @lookup_index: index of the feature lookup to query.
* @direction: edge of the glyph to query.
* @glyph: a glyph id.
*
* Fetches the optical bound of a glyph positioned at the margin of text.
* The direction identifies which edge of the glyph to query.
*
* Return value: Adjustment value. Negative values mean the glyph will stick out of the margin.
*
* Since: REPLACEME
**/
hb_position_t
hb_ot_layout_lookup_get_optical_bound (hb_font_t *font,
unsigned lookup_index,