#include "hb.hh"#include "hb-ot.h"#include "hb-ot-color-cbdt-table.hh"#include "hb-ot-color-colr-table.hh"#include "hb-ot-color-cpal-table.hh"#include "hb-ot-color-sbix-table.hh"#include "hb-ot-color-svg-table.hh"
Go to the source code of this file.
Function Documentation
◆ hb_ot_color_glyph_get_layers()
| 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 | ||
| ) |
hb_ot_color_glyph_get_layers: @face: hb_face_t to work upon @glyph: The glyph index to query @start_offset: offset of the first layer to retrieve @layer_count: (inout) (optional): Input = the maximum number of layers to return; Output = the actual number of layers returned (may be zero) @layers: (out) (array length=layer_count) (nullable): The array of layers found
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.
Return value: Total number of layers available for the glyph index queried
Since: 2.1.0
Definition at line 222 of file hb-ot-color.cc.
◆ hb_ot_color_glyph_reference_png()
| hb_blob_t* hb_ot_color_glyph_reference_png | ( | hb_font_t * | font, |
| hb_codepoint_t | glyph | ||
| ) |
hb_ot_color_glyph_reference_png: @font: hb_font_t to work upon @glyph: a glyph index
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.
Return value: (transfer full): An hb_blob_t containing the PNG image for the glyph, if available
Since: 2.1.0
Definition at line 308 of file hb-ot-color.cc.
◆ hb_ot_color_glyph_reference_svg()
| hb_blob_t* hb_ot_color_glyph_reference_svg | ( | hb_face_t * | face, |
| hb_codepoint_t | glyph | ||
| ) |
hb_ot_color_glyph_reference_svg: @face: hb_face_t to work upon @glyph: a svg glyph index
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.
Return value: (transfer full): An hb_blob_t containing the SVG document of the glyph, if available
Since: 2.1.0
Definition at line 266 of file hb-ot-color.cc.
◆ hb_ot_color_has_layers()
hb_ot_color_has_layers: @face: hb_face_t to work upon
Tests whether a face includes any COLR color layers.
Return value: true if data found, false otherwise
Since: 2.1.0
Definition at line 200 of file hb-ot-color.cc.
◆ hb_ot_color_has_palettes()
SECTION:hb-ot-color @title: hb-ot-color @short_description: OpenType Color Fonts hb-ot.h
Functions for fetching color-font information from OpenType font faces.
HarfBuzz supports COLR/CPAL, sbix, CBDT, and SVG color fonts. hb_ot_color_has_palettes: @face: hb_face_t to work upon
Tests whether a face includes a CPAL color-palette table.
Return value: true if data found, false otherwise
Since: 2.1.0
Definition at line 69 of file hb-ot-color.cc.
◆ hb_ot_color_has_png()
hb_ot_color_has_png: @face: hb_face_t to work upon
Tests whether a face has PNG glyph images (either in CBDT or sbix tables).
Return value: true if data found, false otherwise
Since: 2.1.0
Definition at line 287 of file hb-ot-color.cc.
◆ hb_ot_color_has_svg()
hb_ot_color_has_svg: @face: hb_face_t to work upon.
Tests whether a face includes any SVG glyph images.
Return value: true if data found, false otherwise.
Since: 2.1.0
Definition at line 247 of file hb-ot-color.cc.
◆ hb_ot_color_palette_color_get_name_id()
| hb_ot_name_id_t hb_ot_color_palette_color_get_name_id | ( | hb_face_t * | face, |
| unsigned int | color_index | ||
| ) |
hb_ot_color_palette_color_get_name_id: @face: hb_face_t to work upon @color_index: The index of the color
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").
Return value: the Name ID found for the color.
Since: 2.1.0
Definition at line 129 of file hb-ot-color.cc.
◆ hb_ot_color_palette_get_colors()
| unsigned int hb_ot_color_palette_get_colors | ( | hb_face_t * | face, |
| unsigned int | palette_index, | ||
| unsigned int | start_offset, | ||
| unsigned int * | colors_count, | ||
| hb_color_t * | colors | ||
| ) |
hb_ot_color_palette_get_colors: @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: (inout) (optional): Input = the maximum number of colors to return; Output = the actual number of colors returned (may be zero) @colors: (out) (array length=color_count) (nullable): The array of hb_color_t records found
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.
Return value: the total number of colors in the palette
Since: 2.1.0
Definition at line 175 of file hb-ot-color.cc.
◆ hb_ot_color_palette_get_count()
| unsigned int hb_ot_color_palette_get_count | ( | hb_face_t * | face | ) |
hb_ot_color_palette_get_count: @face: hb_face_t to work upon
Fetches the number of color palettes in a face.
Return value: the number of palettes found
Since: 2.1.0
Definition at line 85 of file hb-ot-color.cc.
◆ hb_ot_color_palette_get_flags()
| hb_ot_color_palette_flags_t hb_ot_color_palette_get_flags | ( | hb_face_t * | face, |
| unsigned int | palette_index | ||
| ) |
hb_ot_color_palette_get_flags: @face: hb_face_t to work upon @palette_index: The index of the color palette
Fetches the flags defined for a color palette.
Return value: the hb_ot_color_palette_flags_t of the requested color palette
Since: 2.1.0
Definition at line 147 of file hb-ot-color.cc.
◆ hb_ot_color_palette_get_name_id()
| hb_ot_name_id_t hb_ot_color_palette_get_name_id | ( | hb_face_t * | face, |
| unsigned int | palette_index | ||
| ) |
hb_ot_color_palette_get_name_id: @face: hb_face_t to work upon @palette_index: The index of the color palette
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").
Return value: 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
Definition at line 107 of file hb-ot-color.cc.
