docs: Clarify 0xFFFF as palette index

Mention that a palette index of 0xFFFF means to use the foreground color.
2022-07-09 21:57:25 -04:00 · 2022-07-09 21:57:25 -04:00 · d826a5920c
parent 0cd404d0b8
commit d826a5920c
1 changed files with 4 additions and 0 deletions
--- a/src/hb-ot-color.h
+++ b/src/hb-ot-color.h
@ -102,6 +102,10 @@ hb_ot_color_has_layers (hb_face_t *face);
 *
 * Pairs of glyph and color index.
 *
+ * A color index of 0xFFFF does not refer to a palette
+ * color, but indicates that the foreground color should
+ * be used.
+ *
 * Since: 2.1.0
 **/
 typedef struct hb_ot_color_layer_t {