[paint] Document hb_font_paint_glyph_func_t

2 years ago · 3a2634e27c
parent 0f287e75ec
commit 3a2634e27c
2 changed files with 15 additions and 0 deletions
--- a/docs/harfbuzz-sections.txt
+++ b/docs/harfbuzz-sections.txt
@ -450,6 +450,8 @@ hb_font_get_glyph_name_func_t
 hb_font_funcs_set_glyph_name_func
 hb_font_get_glyph_shape_func_t
 hb_font_funcs_set_glyph_shape_func
+hb_font_paint_glyph_func_t
+hb_font_funcs_set_paint_glyph_func
 hb_font_get_nominal_glyph_func_t
 hb_font_funcs_set_nominal_glyph_func
 hb_font_get_nominal_glyphs_func_t
--- a/src/hb-font.h
+++ b/src/hb-font.h
@ -513,6 +513,19 @@ typedef void (*hb_font_get_glyph_shape_func_t) (hb_font_t *font, void *font_data
 						hb_draw_funcs_t *draw_funcs, void *draw_data,
 						void *user_data);

+/**
+ * hb_font_paint_glyph_func_t:
+ * @font: #hb_font_t to work upon
+ * @font_data: @font user data pointer
+ * @glyph: The glyph ID to query
+ * @paint_funcs: The paint functions to use
+ * @paint_data: The data accompanying the paint functions
+ * @user_data: User data pointer passed by the caller
+ *
+ * A virtual method for the #hb_font_funcs_t of an #hb_font_t object.
+ *
+ * Since: REPLACEME
+ */
 typedef void (*hb_font_paint_glyph_func_t) (hb_font_t *font, void *font_data,
                                            hb_codepoint_t glyph,
                                            hb_paint_funcs_t *paint_funcs, void *paint_data,