Top |
#define | HB_COLOR() |
uint8_t | hb_color_get_alpha () |
uint8_t | hb_color_get_blue () |
uint8_t | hb_color_get_green () |
uint8_t | hb_color_get_red () |
unsigned int | hb_ot_color_glyph_get_layers () |
hb_blob_t * | hb_ot_color_glyph_reference_png () |
hb_blob_t * | hb_ot_color_glyph_reference_svg () |
hb_bool_t | hb_ot_color_has_layers () |
hb_bool_t | hb_ot_color_has_palettes () |
hb_bool_t | hb_ot_color_has_png () |
hb_bool_t | hb_ot_color_has_svg () |
hb_ot_name_id_t | hb_ot_color_palette_color_get_name_id () |
unsigned int | hb_ot_color_palette_get_colors () |
unsigned int | hb_ot_color_palette_get_count () |
hb_ot_color_palette_flags_t | hb_ot_color_palette_get_flags () |
hb_ot_name_id_t | hb_ot_color_palette_get_name_id () |
Functions for fetching color-font information from OpenType font faces.
HarfBuzz supports COLR
/CPAL
, sbix
, CBDT
, and SVG
color fonts.
#define HB_COLOR(b,g,r,a) ((hb_color_t) HB_TAG ((b),(g),(r),(a)))
Constructs an hb_color_t from four integers.
Since: 2.1.0
uint8_t
hb_color_get_alpha (hb_color_t color
);
Fetches the alpha channel of the given color
.
Since: 2.1.0
uint8_t
hb_color_get_blue (hb_color_t color
);
Fetches the blue channel of the given color
.
Since: 2.1.0
uint8_t
hb_color_get_green (hb_color_t color
);
Fetches the green channel of the given color
.
Since: 2.1.0
uint8_t
hb_color_get_red (hb_color_t color
);
Fetches the red channel of the given color
.
Since: 2.1.0
unsigned int hb_ot_color_glyph_get_layers (hb_face_t *face
,hb_codepoint_t glyph
,unsigned int start_offset
,unsigned int *layer_count
,hb_ot_color_layer_t *layers
);
Fetches a list of all color layers for the specified glyph index in the specified face. The list returned will begin at the offset provided.
face |
hb_face_t to work upon |
|
glyph |
The glyph index to query |
|
start_offset |
offset of the first layer to retrieve |
|
layer_count |
Input = the maximum number of layers to return; Output = the actual number of layers returned (may be zero). |
[inout][optional] |
layers |
The array of layers found. |
[out][array length=layer_count][nullable] |
Since: 2.1.0
hb_blob_t * hb_ot_color_glyph_reference_png (hb_font_t *font
,hb_codepoint_t glyph
);
Fetches the PNG image for a glyph. This function takes a font object, not a face object,
as input. To get an optimally sized PNG blob, the UPEM value must be set on the font
object. If UPEM is unset, the blob returned will be the largest PNG available.
If the glyph has no PNG image, the singleton empty blob is returned.
Since: 2.1.0
hb_blob_t * hb_ot_color_glyph_reference_svg (hb_face_t *face
,hb_codepoint_t glyph
);
Fetches the SVG document for a glyph. The blob may be either plain text or gzip-encoded.
If the glyph has no SVG document, the singleton empty blob is returned.
Since: 2.1.0
hb_bool_t
hb_ot_color_has_layers (hb_face_t *face
);
Tests whether a face includes any COLR
color layers.
Since: 2.1.0
hb_bool_t
hb_ot_color_has_palettes (hb_face_t *face
);
Tests whether a face includes a CPAL
color-palette table.
Since: 2.1.0
hb_bool_t
hb_ot_color_has_png (hb_face_t *face
);
Tests whether a face has PNG glyph images (either in CBDT
or sbix
tables).
Since: 2.1.0
hb_bool_t
hb_ot_color_has_svg (hb_face_t *face
);
Tests whether a face includes any SVG
glyph images.
Since: 2.1.0
hb_ot_name_id_t hb_ot_color_palette_color_get_name_id (hb_face_t *face
,unsigned int color_index
);
Fetches the name
table Name ID that provides display names for
the specified color in a face's CPAL
color palette.
Display names can be generic (e.g., "Background") or specific (e.g., "Eye color").
Since: 2.1.0
unsigned int hb_ot_color_palette_get_colors (hb_face_t *face
,unsigned int palette_index
,unsigned int start_offset
,unsigned int *color_count
,hb_color_t *colors
);
Fetches a list of the colors in a color palette.
After calling this function, colors
will be filled with the palette
colors. If colors
is NULL, the function will just return the number
of total colors without storing any actual colors; this can be used
for allocating a buffer of suitable size before calling
hb_ot_color_palette_get_colors()
a second time.
face |
hb_face_t to work upon |
|
palette_index |
the index of the color palette to query |
|
start_offset |
offset of the first color to retrieve |
|
color_count |
Input = the maximum number of colors to return; Output = the actual number of colors returned (may be zero). |
[inout][optional] |
colors |
The array of hb_color_t records found. |
[out][array length=color_count][nullable] |
Since: 2.1.0
unsigned int
hb_ot_color_palette_get_count (hb_face_t *face
);
Fetches the number of color palettes in a face.
Since: 2.1.0
hb_ot_color_palette_flags_t hb_ot_color_palette_get_flags (hb_face_t *face
,unsigned int palette_index
);
Fetches the flags defined for a color palette.
Since: 2.1.0
hb_ot_name_id_t hb_ot_color_palette_get_name_id (hb_face_t *face
,unsigned int palette_index
);
Fetches the name
table Name ID that provides display names for
a CPAL
color palette.
Palette display names can be generic (e.g., "Default") or provide specific, themed names (e.g., "Spring", "Summer", "Fall", and "Winter").
the Named ID found for the palette. If the requested palette has no name the result is HB_OT_NAME_ID_INVALID.
Since: 2.1.0
typedef uint32_t hb_color_t;
Data type for holding color values. Colors are eight bits per channel RGB plus alpha transparency.
Since: 2.1.0
typedef struct { hb_codepoint_t glyph; unsigned int color_index; } hb_ot_color_layer_t;
Pairs of glyph and color index.
Since: 2.1.0
Flags that describe the properties of color palette.
Default indicating that there is nothing special to note about a color palette. |
||
Flag indicating that the color palette is appropriate to use when displaying the font on a light background such as white. |
||
Flag indicating that the color palette is appropriate to use when displaying the font on a dark background such as black. |
Since: 2.1.0