[paint] Docs

This commit is contained in:
Behdad Esfahbod 2023-01-20 13:55:13 -07:00
parent f21b15dcc3
commit eb00088bcf
3 changed files with 5 additions and 4 deletions

View File

@ -225,8 +225,6 @@ hb_draw_state_t
<SECTION> <SECTION>
<FILE>hb-paint</FILE> <FILE>hb-paint</FILE>
HB_PAINT_PALETTE_INDEX_CUSTOM
hb_paint_funcs_t hb_paint_funcs_t
hb_paint_funcs_create hb_paint_funcs_create
hb_paint_funcs_get_empty hb_paint_funcs_get_empty

View File

@ -684,10 +684,11 @@ hb_paint_pop_group (hb_paint_funcs_t *funcs, void *paint_data,
* @funcs: paint functions * @funcs: paint functions
* @paint_data: associated data passed by the caller * @paint_data: associated data passed by the caller
* @color_index: color index * @color_index: color index
* @color: (out): fetched color
* *
* Gets the custom palette color for @color_index. * Gets the custom palette color for @color_index.
* *
* Return value: the custom color * Return value: `true` if found, `false` otherwise
* *
* Since: REPLACEME * Since: REPLACEME
*/ */

View File

@ -661,12 +661,14 @@ typedef void (*hb_paint_pop_group_func_t) (hb_paint_funcs_t *funcs,
* @funcs: paint functions object * @funcs: paint functions object
* @paint_data: The data accompanying the paint functions in hb_font_paint_glyph() * @paint_data: The data accompanying the paint functions in hb_font_paint_glyph()
* @color_index: the color index * @color_index: the color index
* @color: (out): fetched color
* @user_data: User data pointer passed to hb_paint_funcs_set_pop_group_func() * @user_data: User data pointer passed to hb_paint_funcs_set_pop_group_func()
* *
* A virtual method for the #hb_paint_funcs_t to fetch a color from the custom * A virtual method for the #hb_paint_funcs_t to fetch a color from the custom
* color palette. * color palette.
* *
* Return value: the color * Return value: `true` if found, `false` otherwise
*
* Since: REPLACEME * Since: REPLACEME
*/ */
typedef hb_bool_t (*hb_paint_custom_palette_color_func_t) (hb_paint_funcs_t *funcs, typedef hb_bool_t (*hb_paint_custom_palette_color_func_t) (hb_paint_funcs_t *funcs,