walkero
/
harfbuzz
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[draw] Document more

This commit is contained in:
Behdad Esfahbod 2022-02-07 18:38:00 -06:00
parent 2376230523
commit c56c13756b
3 changed files with 130 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

135
src/hb-draw.cc
View File

@ -97,57 +97,6 @@ hb_draw_funcs_set_##name##_func (hb_draw_funcs_t *dfuncs, \
HB_DRAW_FUNCS_IMPLEMENT_CALLBACKS HB_DRAW_FUNCS_IMPLEMENT_CALLBACKS
#undef HB_DRAW_FUNC_IMPLEMENT #undef HB_DRAW_FUNC_IMPLEMENT
/**
* hb_draw_funcs_set_move_to_func:
* @funcs: draw functions object
* @move_to: move-to callback
*
* Sets move-to callback to the draw functions object.
*
* Since: REPLACEME
**/
/**
* hb_draw_funcs_set_line_to_func:
* @funcs: draw functions object
* @line_to: line-to callback
*
* Sets line-to callback to the draw functions object.
*
* Since: REPLACEME
**/
/**
* hb_draw_funcs_set_quadratic_to_func:
* @funcs: draw functions object
* @move_to: quadratic-to callback
*
* Sets quadratic-to callback to the draw functions object.
*
* Since: REPLACEME
**/
/**
* hb_draw_funcs_set_cubic_to_func:
* @funcs: draw functions
* @cubic_to: cubic-to callback
*
* Sets cubic-to callback to the draw functions object.
*
* Since: REPLACEME
**/
/**
* hb_draw_funcs_set_close_path_func:
* @funcs: draw functions object
* @close_path: close-path callback
*
* Sets close-path callback to the draw functions object.
*
* Since: REPLACEME
**/
/** /**
* hb_draw_funcs_create: * hb_draw_funcs_create:
* *
@ -158,13 +107,13 @@ HB_DRAW_FUNCS_IMPLEMENT_CALLBACKS
hb_draw_funcs_t * hb_draw_funcs_t *
hb_draw_funcs_create () hb_draw_funcs_create ()
{ {
hb_draw_funcs_t *funcs; hb_draw_funcs_t *dfuncs;
if (unlikely (!(funcs = hb_object_create<hb_draw_funcs_t> ()))) if (unlikely (!(dfuncs = hb_object_create<hb_draw_funcs_t> ())))
return const_cast<hb_draw_funcs_t *> (&Null (hb_draw_funcs_t)); return const_cast<hb_draw_funcs_t *> (&Null (hb_draw_funcs_t));
funcs->func = Null (hb_draw_funcs_t).func; dfuncs->func = Null (hb_draw_funcs_t).func;
return funcs; return dfuncs;
} }
DEFINE_NULL_INSTANCE (hb_draw_funcs_t) = DEFINE_NULL_INSTANCE (hb_draw_funcs_t) =
@ -181,7 +130,7 @@ DEFINE_NULL_INSTANCE (hb_draw_funcs_t) =
/** /**
* hb_draw_funcs_reference: * hb_draw_funcs_reference:
* @funcs: draw functions * @dfuncs: draw functions
* *
* Add to callbacks object refcount. * Add to callbacks object refcount.
* *
@ -189,14 +138,14 @@ DEFINE_NULL_INSTANCE (hb_draw_funcs_t) =
* Since: REPLACEME * Since: REPLACEME
**/ **/
hb_draw_funcs_t * hb_draw_funcs_t *
hb_draw_funcs_reference (hb_draw_funcs_t *funcs) hb_draw_funcs_reference (hb_draw_funcs_t *dfuncs)
{ {
return hb_object_reference (funcs); return hb_object_reference (dfuncs);
} }
/** /**
* hb_draw_funcs_destroy: * hb_draw_funcs_destroy:
* @funcs: draw functions * @dfuncs: draw functions
* *
* Decreases refcount of callbacks object and deletes the object if it reaches * Decreases refcount of callbacks object and deletes the object if it reaches
* to zero. * to zero.
@ -204,49 +153,49 @@ hb_draw_funcs_reference (hb_draw_funcs_t *funcs)
* Since: REPLACEME * Since: REPLACEME
**/ **/
void void
hb_draw_funcs_destroy (hb_draw_funcs_t *funcs) hb_draw_funcs_destroy (hb_draw_funcs_t *dfuncs)
{ {
if (!hb_object_destroy (funcs)) return; if (!hb_object_destroy (dfuncs)) return;
hb_free (funcs); hb_free (dfuncs);
} }
/** /**
* hb_draw_funcs_make_immutable: * hb_draw_funcs_make_immutable:
* @funcs: draw functions * @dfuncs: draw functions
* *
* Makes funcs object immutable. * Makes dfuncs object immutable.
* *
* Since: REPLACEME * Since: REPLACEME
**/ **/
void void
hb_draw_funcs_make_immutable (hb_draw_funcs_t *funcs) hb_draw_funcs_make_immutable (hb_draw_funcs_t *dfuncs)
{ {
if (hb_object_is_immutable (funcs)) if (hb_object_is_immutable (dfuncs))
return; return;
hb_object_make_immutable (funcs); hb_object_make_immutable (dfuncs);
} }
/** /**
* hb_draw_funcs_is_immutable: * hb_draw_funcs_is_immutable:
* @funcs: draw functions * @dfuncs: draw functions
* *
* Checks whether funcs is immutable. * Checks whether dfuncs is immutable.
* *
* Returns: If is immutable. * Returns: If is immutable.
* Since: REPLACEME * Since: REPLACEME
**/ **/
hb_bool_t hb_bool_t
hb_draw_funcs_is_immutable (hb_draw_funcs_t *funcs) hb_draw_funcs_is_immutable (hb_draw_funcs_t *dfuncs)
{ {
return hb_object_is_immutable (funcs); return hb_object_is_immutable (dfuncs);
} }
/** /**
* hb_draw_move_to: * hb_draw_move_to:
* @funcs: draw functions * @dfuncs: draw functions
* @draw_data: associated draw data passed by the caller * @draw_data: associated draw data passed by the caller
* @st: current draw state * @st: current draw state
* @to_x: X component of target point * @to_x: X component of target point
@ -257,17 +206,17 @@ hb_draw_funcs_is_immutable (hb_draw_funcs_t *funcs)
* Since: REPLACEME * Since: REPLACEME
**/ **/
void void
hb_draw_move_to (hb_draw_funcs_t *funcs, void *draw_data, hb_draw_move_to (hb_draw_funcs_t *dfuncs, void *draw_data,
hb_draw_state_t *st, hb_draw_state_t *st,
float to_x, float to_y) float to_x, float to_y)
{ {
funcs->move_to (draw_data, *st, dfuncs->move_to (draw_data, *st,
to_x, to_y); to_x, to_y);
} }
/** /**
* hb_draw_line_to: * hb_draw_line_to:
* @funcs: draw functions * @dfuncs: draw functions
* @draw_data: associated draw data passed by the caller * @draw_data: associated draw data passed by the caller
* @st: current draw state * @st: current draw state
* @to_x: X component of target point * @to_x: X component of target point
@ -278,17 +227,17 @@ hb_draw_move_to (hb_draw_funcs_t *funcs, void *draw_data,
* Since: REPLACEME * Since: REPLACEME
**/ **/
void void
hb_draw_line_to (hb_draw_funcs_t *funcs, void *draw_data, hb_draw_line_to (hb_draw_funcs_t *dfuncs, void *draw_data,
hb_draw_state_t *st, hb_draw_state_t *st,
float to_x, float to_y) float to_x, float to_y)
{ {
funcs->line_to (draw_data, *st, dfuncs->line_to (draw_data, *st,
to_x, to_y); to_x, to_y);
} }
/** /**
* hb_draw_quadratic_to: * hb_draw_quadratic_to:
* @funcs: draw functions * @dfuncs: draw functions
* @draw_data: associated draw data passed by the caller * @draw_data: associated draw data passed by the caller
* @st: current draw state * @st: current draw state
* @control_x: X component of control point * @control_x: X component of control point
@ -301,19 +250,19 @@ hb_draw_line_to (hb_draw_funcs_t *funcs, void *draw_data,
* Since: REPLACEME * Since: REPLACEME
**/ **/
void void
hb_draw_quadratic_to (hb_draw_funcs_t *funcs, void *draw_data, hb_draw_quadratic_to (hb_draw_funcs_t *dfuncs, void *draw_data,
hb_draw_state_t *st, hb_draw_state_t *st,
float control_x, float control_y, float control_x, float control_y,
float to_x, float to_y) float to_x, float to_y)
{ {
funcs->quadratic_to (draw_data, *st, dfuncs->quadratic_to (draw_data, *st,
control_x, control_y, control_x, control_y,
to_x, to_y); to_x, to_y);
} }
/** /**
* hb_draw_cubic_to: * hb_draw_cubic_to:
* @funcs: draw functions * @dfuncs: draw functions
* @draw_data: associated draw data passed by the caller * @draw_data: associated draw data passed by the caller
* @st: current draw state * @st: current draw state
* @control1_x: X component of first control point * @control1_x: X component of first control point
@ -328,21 +277,21 @@ hb_draw_quadratic_to (hb_draw_funcs_t *funcs, void *draw_data,
* Since: REPLACEME * Since: REPLACEME
**/ **/
void void
hb_draw_cubic_to (hb_draw_funcs_t *funcs, void *draw_data, hb_draw_cubic_to (hb_draw_funcs_t *dfuncs, void *draw_data,
hb_draw_state_t *st, hb_draw_state_t *st,
float control1_x, float control1_y, float control1_x, float control1_y,
float control2_x, float control2_y, float control2_x, float control2_y,
float to_x, float to_y) float to_x, float to_y)
{ {
funcs->cubic_to (draw_data, *st, dfuncs->cubic_to (draw_data, *st,
control1_x, control1_y, control1_x, control1_y,
control2_x, control2_y, control2_x, control2_y,
to_x, to_y); to_x, to_y);
} }
/** /**
* hb_draw_close_path: * hb_draw_close_path:
* @funcs: draw functions * @dfuncs: draw functions
* @draw_data: associated draw data passed by the caller * @draw_data: associated draw data passed by the caller
* @st: current draw state * @st: current draw state
* *
@ -351,10 +300,10 @@ hb_draw_cubic_to (hb_draw_funcs_t *funcs, void *draw_data,
* Since: REPLACEME * Since: REPLACEME
**/ **/
void void
hb_draw_close_path (hb_draw_funcs_t *funcs, void *draw_data, hb_draw_close_path (hb_draw_funcs_t *dfuncs, void *draw_data,
hb_draw_state_t *st) hb_draw_state_t *st)
{ {
funcs->close_path (draw_data, *st); dfuncs->close_path (draw_data, *st);
} }

105
src/hb-draw.h
View File

@ -34,6 +34,18 @@
HB_BEGIN_DECLS HB_BEGIN_DECLS
/**
* hb_draw_state_t
* @path_open: Whether there is an open path
* @path_start_x: X component of the start of current path
* @path_start_y: Y component of the start of current path
* @current_x: X component of current point
* @current_y: Y component of current point
*
* Current drawing state.
*
* Since: REPLACEME
**/
typedef struct hb_draw_state_t { typedef struct hb_draw_state_t {
hb_bool_t path_open; hb_bool_t path_open;
@ -93,29 +105,84 @@ typedef void (*hb_draw_close_path_func_t) (hb_draw_funcs_t *dfuncs, void *draw_d
hb_draw_state_t *st, hb_draw_state_t *st,
void *user_data); void *user_data);
/**
* hb_draw_funcs_set_move_to_func:
* @dfuncs: draw functions object
* @func: move-to callback
* @user_data: Data to pass to @func
* @destroy: (nullable): The function to call when @user_data is not needed anymore
*
* Sets move-to callback to the draw functions object.
*
* Since: REPLACEME
**/
HB_EXTERN void HB_EXTERN void
hb_draw_funcs_set_move_to_func (hb_draw_funcs_t *funcs, hb_draw_funcs_set_move_to_func (hb_draw_funcs_t *dfuncs,
hb_draw_move_to_func_t move_to, hb_draw_move_to_func_t func,
void *user_data, hb_destroy_func_t destroy); void *user_data, hb_destroy_func_t destroy);
/**
* hb_draw_funcs_set_line_to_func:
* @dfuncs: draw functions object
* @func: line-to callback
* @user_data: Data to pass to @func
* @destroy: (nullable): The function to call when @user_data is not needed anymore
*
* Sets line-to callback to the draw functions object.
*
* Since: REPLACEME
**/
HB_EXTERN void HB_EXTERN void
hb_draw_funcs_set_line_to_func (hb_draw_funcs_t *funcs, hb_draw_funcs_set_line_to_func (hb_draw_funcs_t *dfuncs,
hb_draw_line_to_func_t line_to, hb_draw_line_to_func_t func,
void *user_data, hb_destroy_func_t destroy); void *user_data, hb_destroy_func_t destroy);
/**
* hb_draw_funcs_set_quadratic_to_func:
* @dfuncs: draw functions object
* @func: quadratic-to callback
* @user_data: Data to pass to @func
* @destroy: (nullable): The function to call when @user_data is not needed anymore
*
* Sets quadratic-to callback to the draw functions object.
*
* Since: REPLACEME
**/
HB_EXTERN void HB_EXTERN void
hb_draw_funcs_set_quadratic_to_func (hb_draw_funcs_t *funcs, hb_draw_funcs_set_quadratic_to_func (hb_draw_funcs_t *dfuncs,
hb_draw_quadratic_to_func_t quadratic_to, hb_draw_quadratic_to_func_t func,
void *user_data, hb_destroy_func_t destroy); void *user_data, hb_destroy_func_t destroy);
/**
* hb_draw_funcs_set_cubic_to_func:
* @dfuncs: draw functions
* @func: cubic-to callback
* @user_data: Data to pass to @func
* @destroy: (nullable): The function to call when @user_data is not needed anymore
*
* Sets cubic-to callback to the draw functions object.
*
* Since: REPLACEME
**/
HB_EXTERN void HB_EXTERN void
hb_draw_funcs_set_cubic_to_func (hb_draw_funcs_t *funcs, hb_draw_funcs_set_cubic_to_func (hb_draw_funcs_t *dfuncs,
hb_draw_cubic_to_func_t cubic_to, hb_draw_cubic_to_func_t func,
void *user_data, hb_destroy_func_t destroy); void *user_data, hb_destroy_func_t destroy);
/**
* hb_draw_funcs_set_close_path_func:
* @dfuncs: draw functions object
* @func: close-path callback
* @user_data: Data to pass to @func
* @destroy: (nullable): The function to call when @user_data is not needed anymore
*
* Sets close-path callback to the draw functions object.
*
* Since: REPLACEME
**/
HB_EXTERN void HB_EXTERN void
hb_draw_funcs_set_close_path_func (hb_draw_funcs_t *funcs, hb_draw_funcs_set_close_path_func (hb_draw_funcs_t *dfuncs,
hb_draw_close_path_func_t close_path, hb_draw_close_path_func_t func,
void *user_data, hb_destroy_func_t destroy); void *user_data, hb_destroy_func_t destroy);
@ -123,43 +190,43 @@ HB_EXTERN hb_draw_funcs_t *
hb_draw_funcs_create (void); hb_draw_funcs_create (void);
HB_EXTERN hb_draw_funcs_t * HB_EXTERN hb_draw_funcs_t *
hb_draw_funcs_reference (hb_draw_funcs_t *funcs); hb_draw_funcs_reference (hb_draw_funcs_t *dfuncs);
HB_EXTERN void HB_EXTERN void
hb_draw_funcs_destroy (hb_draw_funcs_t *funcs); hb_draw_funcs_destroy (hb_draw_funcs_t *dfuncs);
HB_EXTERN void HB_EXTERN void
hb_draw_funcs_make_immutable (hb_draw_funcs_t *funcs); hb_draw_funcs_make_immutable (hb_draw_funcs_t *dfuncs);
HB_EXTERN hb_bool_t HB_EXTERN hb_bool_t
hb_draw_funcs_is_immutable (hb_draw_funcs_t *funcs); hb_draw_funcs_is_immutable (hb_draw_funcs_t *dfuncs);
HB_EXTERN void HB_EXTERN void
hb_draw_move_to (hb_draw_funcs_t *funcs, void *draw_data, hb_draw_move_to (hb_draw_funcs_t *dfuncs, void *draw_data,
hb_draw_state_t *st, hb_draw_state_t *st,
float to_x, float to_y); float to_x, float to_y);
HB_EXTERN void HB_EXTERN void
hb_draw_line_to (hb_draw_funcs_t *funcs, void *draw_data, hb_draw_line_to (hb_draw_funcs_t *dfuncs, void *draw_data,
hb_draw_state_t *st, hb_draw_state_t *st,
float to_x, float to_y); float to_x, float to_y);
HB_EXTERN void HB_EXTERN void
hb_draw_quadratic_to (hb_draw_funcs_t *funcs, void *draw_data, hb_draw_quadratic_to (hb_draw_funcs_t *dfuncs, void *draw_data,
hb_draw_state_t *st, hb_draw_state_t *st,
float control_x, float control_y, float control_x, float control_y,
float to_x, float to_y); float to_x, float to_y);
HB_EXTERN void HB_EXTERN void
hb_draw_cubic_to (hb_draw_funcs_t *funcs, void *draw_data, hb_draw_cubic_to (hb_draw_funcs_t *dfuncs, void *draw_data,
hb_draw_state_t *st, hb_draw_state_t *st,
float control1_x, float control1_y, float control1_x, float control1_y,
float control2_x, float control2_y, float control2_x, float control2_y,
float to_x, float to_y); float to_x, float to_y);
HB_EXTERN void HB_EXTERN void
hb_draw_close_path (hb_draw_funcs_t *funcs, void *draw_data, hb_draw_close_path (hb_draw_funcs_t *dfuncs, void *draw_data,
hb_draw_state_t *st); hb_draw_state_t *st);

4
src/hb-font.cc
View File

@ -1306,8 +1306,8 @@ hb_font_get_glyph_from_name (hb_font_t *font,
* hb_font_get_glyph_shape: * hb_font_get_glyph_shape:
* @font: #hb_font_t to work upon * @font: #hb_font_t to work upon
* @glyph: : The glyph ID * @glyph: : The glyph ID
* @dfuncs: * @dfuncs: #hb_draw_funcs_t to draw to
* @draw_data: * @draw_data: User data to pass to draw callbacks
* *
* Fetches the glyph shape that corresponds to a glyph in the specified @font. * Fetches the glyph shape that corresponds to a glyph in the specified @font.
* The shape is returned by way of calls to the callsbacks of the @dfuncs * The shape is returned by way of calls to the callsbacks of the @dfuncs