[paint] More docs

This commit is contained in:
Behdad Esfahbod 2022-12-26 15:38:24 -07:00
parent 5f168db884
commit c3a8c6bb8b
2 changed files with 31 additions and 1 deletions

View File

@ -392,7 +392,7 @@ hb_paint_funcs_is_immutable (hb_paint_funcs_t *funcs)
* may be out of order. It is the callers responsibility to ensure that * may be out of order. It is the callers responsibility to ensure that
* color stops are sorted by their offset before they are used. * color stops are sorted by their offset before they are used.
* *
* Return value: the total number of color stops in @cl * Return value: the total number of color stops in @color_line
* *
* Since: REPLACEME * Since: REPLACEME
*/ */
@ -415,6 +415,8 @@ hb_color_line_get_color_stops (hb_color_line_t *color_line,
* *
* Fetches the extend mode of the color line object. * Fetches the extend mode of the color line object.
* *
* Return value: the extend mode of @color_line
*
* Since: REPLACEME * Since: REPLACEME
*/ */
hb_paint_extend_t hb_paint_extend_t

View File

@ -326,6 +326,22 @@ typedef enum {
typedef struct hb_color_line_t hb_color_line_t; typedef struct hb_color_line_t hb_color_line_t;
/**
* hb_color_line_get_color_stops_func_t:
* @color_line: a #hb_color_line_t object
* @color_line_data: the data accompanying @color_line
* @start: the index of the first color stop to return
* @count: (inout) (optional): Input = the maximum number of feature tags to return;
* Output = the actual number of feature tags returned (may be zero)
* @color_stops: (out) (array length=count) (optional): Array of #hb_color_stop_t to populate
* @user_data: the data accompanying this method
*
* A virtual method for the #hb_color_line_t to fetch color stops.
*
* Return value: the total number of color stops in @color_line
*
* Since: REPLACEME
*/
typedef unsigned int (*hb_color_line_get_color_stops_func_t) (hb_color_line_t *color_line, typedef unsigned int (*hb_color_line_get_color_stops_func_t) (hb_color_line_t *color_line,
void *color_line_data, void *color_line_data,
unsigned int start, unsigned int start,
@ -333,6 +349,18 @@ typedef unsigned int (*hb_color_line_get_color_stops_func_t) (hb_color_line_t *c
hb_color_stop_t *color_stops, hb_color_stop_t *color_stops,
void *user_data); void *user_data);
/**
* hb_color_line_get_extend_func_t:
* @color_line: a #hb_color_line_t object
* @color_line_data: the data accompanying @color_line
* @user_data: the data accompanying this method
*
* A virtual method for the @hb_color_line_t to fetches the extend mode.
*
* Return value: the extend mode of @color_line
*
* Since: REPLACEME
*/
typedef hb_paint_extend_t (*hb_color_line_get_extend_func_t) (hb_color_line_t *color_line, typedef hb_paint_extend_t (*hb_color_line_get_extend_func_t) (hb_color_line_t *color_line,
void *color_line_data, void *color_line_data,
void *user_data); void *user_data);