[colr] Add more docs

State explicitly that palette entries are unpremultipled, and link to the spec.
2022-12-23 00:18:40 -05:00 · 2022-12-23 00:18:40 -05:00 · a634f6b486
parent a02c2a911c
commit a634f6b486
1 changed files with 4 additions and 0 deletions
--- a/src/hb-ot-color.cc
+++ b/src/hb-ot-color.cc
@ -167,6 +167,10 @@ hb_ot_color_palette_get_flags (hb_face_t *face,
 * for allocating a buffer of suitable size before calling
 * hb_ot_color_palette_get_colors() a second time.
 *
+ * The RGBA values in the palette are unpremultiplied. See the
+ * OpenType spec [CPAL](https://learn.microsoft.com/en-us/typography/opentype/spec/cpal)
+ * section for details.
+ *
 * Return value: the total number of colors in the palette
 *
 * Since: 2.1.0