2 * Copyright © 2016 Google, Inc.
3 * Copyright © 2018 Khaled Hosny
4 * Copyright © 2018 Ebrahim Byagowi
6 * This is part of HarfBuzz, a text shaping library.
8 * Permission is hereby granted, without written agreement and without
9 * license or royalty fees, to use, copy, modify, and distribute this
10 * software and its documentation for any purpose, provided that the
11 * above copyright notice and the following two paragraphs appear in
12 * all copies of this software.
14 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
15 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
16 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
17 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
20 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
21 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
22 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
23 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
24 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
26 * Google Author(s): Sascha Brawer, Behdad Esfahbod
29 #if !defined(HB_OT_H_IN) && !defined(HB_NO_SINGLE_HEADER_ERROR)
30 #error "Include <hb-ot.h> instead."
37 #include "hb-ot-name.h"
47 hb_ot_color_has_palettes (hb_face_t *face);
49 HB_EXTERN unsigned int
50 hb_ot_color_palette_get_count (hb_face_t *face);
52 HB_EXTERN hb_ot_name_id_t
53 hb_ot_color_palette_get_name_id (hb_face_t *face,
54 unsigned int palette_index);
56 HB_EXTERN hb_ot_name_id_t
57 hb_ot_color_palette_color_get_name_id (hb_face_t *face,
58 unsigned int color_index);
61 * hb_ot_color_palette_flags_t:
62 * @HB_OT_COLOR_PALETTE_FLAG_DEFAULT: Default indicating that there is nothing special
63 * to note about a color palette.
64 * @HB_OT_COLOR_PALETTE_FLAG_USABLE_WITH_LIGHT_BACKGROUND: Flag indicating that the color
65 * palette is appropriate to use when displaying the font on a light background such as white.
66 * @HB_OT_COLOR_PALETTE_FLAG_USABLE_WITH_DARK_BACKGROUND: Flag indicating that the color
67 * palette is appropriate to use when displaying the font on a dark background such as black.
69 * Flags that describe the properties of color palette.
73 typedef enum { /*< flags >*/
74 HB_OT_COLOR_PALETTE_FLAG_DEFAULT = 0x00000000u,
75 HB_OT_COLOR_PALETTE_FLAG_USABLE_WITH_LIGHT_BACKGROUND = 0x00000001u,
76 HB_OT_COLOR_PALETTE_FLAG_USABLE_WITH_DARK_BACKGROUND = 0x00000002u
77 } hb_ot_color_palette_flags_t;
79 HB_EXTERN hb_ot_color_palette_flags_t
80 hb_ot_color_palette_get_flags (hb_face_t *face,
81 unsigned int palette_index);
83 HB_EXTERN unsigned int
84 hb_ot_color_palette_get_colors (hb_face_t *face,
85 unsigned int palette_index,
86 unsigned int start_offset,
87 unsigned int *color_count, /* IN/OUT. May be NULL. */
88 hb_color_t *colors /* OUT. May be NULL. */);
96 hb_ot_color_has_layers (hb_face_t *face);
99 * hb_ot_color_layer_t:
100 * @glyph: the glyph ID of the layer
101 * @color_index: the palette color index of the layer
103 * Pairs of glyph and color index.
107 typedef struct hb_ot_color_layer_t {
108 hb_codepoint_t glyph;
109 unsigned int color_index;
110 } hb_ot_color_layer_t;
112 HB_EXTERN unsigned int
113 hb_ot_color_glyph_get_layers (hb_face_t *face,
114 hb_codepoint_t glyph,
115 unsigned int start_offset,
116 unsigned int *layer_count, /* IN/OUT. May be NULL. */
117 hb_ot_color_layer_t *layers /* OUT. May be NULL. */);
124 hb_ot_color_has_svg (hb_face_t *face);
126 HB_EXTERN hb_blob_t *
127 hb_ot_color_glyph_reference_svg (hb_face_t *face, hb_codepoint_t glyph);
134 hb_ot_color_has_png (hb_face_t *face);
136 HB_EXTERN hb_blob_t *
137 hb_ot_color_glyph_reference_png (hb_font_t *font, hb_codepoint_t glyph);
142 #endif /* HB_OT_COLOR_H */