[colr] Add more docs

State explicitly that palette entries are
unpremultipled, and link to the spec.
This commit is contained in:
Matthias Clasen 2022-12-23 00:18:40 -05:00 committed by Behdad Esfahbod
parent 7a2dc5cf5b
commit b6e98cf758
1 changed files with 8 additions and 7 deletions

View File

@ -1429,17 +1429,18 @@ hb_font_draw_glyph (hb_font_t *font,
* @glyph: The glyph ID
* @pfuncs: #hb_paint_funcs_t to paint with
* @paint_data: User data to pass to paint callbacks
* @palette: The palette index to use
* @foreground: The foreground color
* @palette: The index of the font's color palette to use
* @foreground: The foreground color, unpremultipled
*
* Paints the glyph.
*
* The painting instructions are returned by way of
* calls to the callbacks of the @funcs objects,
* with @paint_data passed to them.
* The painting instructions are returned by way of calls to
* the callbacks of the @funcs object, with @paint_data passed
* to them.
*
* Note that this function applies the the scale and synthetic
* slant of the font as outermost transform.
* If the font has color palettes (see hb_ot_color_has_palettes()),
* then @palette selects the palette to use. If the font doesn't
* have palettes, passing 0 is fine.
*
* Since: REPLACEME
*/