Source code
Revision control
Copy as Markdown
Other Tools
/*
* Copyright © 2022 Matthias Clasen
*
* This is part of HarfBuzz, a text shaping library.
*
* Permission is hereby granted, without written agreement and without
* license or royalty fees, to use, copy, modify, and distribute this
* software and its documentation for any purpose, provided that the
* above copyright notice and the following two paragraphs appear in
* all copies of this software.
*
* IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
* DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
* ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
* IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
* THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
* ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
* PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
*/
#include "hb.hh"
#ifndef HB_NO_PAINT
#include "hb-paint.hh"
/**
* SECTION: hb-paint
* @title: hb-paint
* @short_description: Glyph painting
* @include: hb.h
*
* Functions for painting glyphs.
*
* The main purpose of these functions is to paint (extract) color glyph layers
* from the COLRv1 table, but the API works for drawing ordinary outlines and
* images as well.
*
* The #hb_paint_funcs_t struct can be used with hb_font_paint_glyph().
**/
static void
hb_paint_push_transform_nil (hb_paint_funcs_t *funcs, void *paint_data,
float xx, float yx,
float xy, float yy,
float dx, float dy,
void *user_data) {}
static void
hb_paint_pop_transform_nil (hb_paint_funcs_t *funcs, void *paint_data,
void *user_data) {}
static hb_bool_t
hb_paint_color_glyph_nil (hb_paint_funcs_t *funcs, void *paint_data,
hb_codepoint_t glyph,
hb_font_t *font,
void *user_data) { return false; }
static void
hb_paint_push_clip_glyph_nil (hb_paint_funcs_t *funcs, void *paint_data,
hb_codepoint_t glyph,
hb_font_t *font,
void *user_data) {}
static void
hb_paint_push_clip_rectangle_nil (hb_paint_funcs_t *funcs, void *paint_data,
float xmin, float ymin, float xmax, float ymax,
void *user_data) {}
static void
hb_paint_pop_clip_nil (hb_paint_funcs_t *funcs, void *paint_data,
void *user_data) {}
static void
hb_paint_color_nil (hb_paint_funcs_t *funcs, void *paint_data,
hb_bool_t is_foreground,
hb_color_t color,
void *user_data) {}
static hb_bool_t
hb_paint_image_nil (hb_paint_funcs_t *funcs, void *paint_data,
hb_blob_t *image,
unsigned int width,
unsigned int height,
hb_tag_t format,
float slant_xy,
hb_glyph_extents_t *extents,
void *user_data) { return false; }
static void
hb_paint_linear_gradient_nil (hb_paint_funcs_t *funcs, void *paint_data,
hb_color_line_t *color_line,
float x0, float y0,
float x1, float y1,
float x2, float y2,
void *user_data) {}
static void
hb_paint_radial_gradient_nil (hb_paint_funcs_t *funcs, void *paint_data,
hb_color_line_t *color_line,
float x0, float y0, float r0,
float x1, float y1, float r1,
void *user_data) {}
static void
hb_paint_sweep_gradient_nil (hb_paint_funcs_t *funcs, void *paint_data,
hb_color_line_t *color_line,
float x0, float y0,
float start_angle,
float end_angle,
void *user_data) {}
static void
hb_paint_push_group_nil (hb_paint_funcs_t *funcs, void *paint_data,
void *user_data) {}
static void
hb_paint_pop_group_nil (hb_paint_funcs_t *funcs, void *paint_data,
hb_paint_composite_mode_t mode,
void *user_data) {}
static hb_bool_t
hb_paint_custom_palette_color_nil (hb_paint_funcs_t *funcs, void *paint_data,
unsigned int color_index,
hb_color_t *color,
void *user_data) { return false; }
static bool
_hb_paint_funcs_set_preamble (hb_paint_funcs_t *funcs,
bool func_is_null,
void **user_data,
hb_destroy_func_t *destroy)
{
if (hb_object_is_immutable (funcs))
{
if (*destroy)
(*destroy) (*user_data);
return false;
}
if (func_is_null)
{
if (*destroy)
(*destroy) (*user_data);
*destroy = nullptr;
*user_data = nullptr;
}
return true;
}
static bool
_hb_paint_funcs_set_middle (hb_paint_funcs_t *funcs,
void *user_data,
hb_destroy_func_t destroy)
{
if (user_data && !funcs->user_data)
{
funcs->user_data = (decltype (funcs->user_data)) hb_calloc (1, sizeof (*funcs->user_data));
if (unlikely (!funcs->user_data))
goto fail;
}
if (destroy && !funcs->destroy)
{
funcs->destroy = (decltype (funcs->destroy)) hb_calloc (1, sizeof (*funcs->destroy));
if (unlikely (!funcs->destroy))
goto fail;
}
return true;
fail:
if (destroy)
(destroy) (user_data);
return false;
}
#define HB_PAINT_FUNC_IMPLEMENT(name) \
\
void \
hb_paint_funcs_set_##name##_func (hb_paint_funcs_t *funcs, \
hb_paint_##name##_func_t func, \
void *user_data, \
hb_destroy_func_t destroy) \
{ \
if (!_hb_paint_funcs_set_preamble (funcs, !func, &user_data, &destroy)) \
return; \
\
if (funcs->destroy && funcs->destroy->name) \
funcs->destroy->name (!funcs->user_data ? nullptr : funcs->user_data->name);\
\
if (!_hb_paint_funcs_set_middle (funcs, user_data, destroy)) \
return; \
\
if (func) \
funcs->func.name = func; \
else \
funcs->func.name = hb_paint_##name##_nil; \
\
if (funcs->user_data) \
funcs->user_data->name = user_data; \
if (funcs->destroy) \
funcs->destroy->name = destroy; \
}
HB_PAINT_FUNCS_IMPLEMENT_CALLBACKS
#undef HB_PAINT_FUNC_IMPLEMENT
/**
* hb_paint_funcs_create:
*
* Creates a new #hb_paint_funcs_t structure of paint functions.
*
* The initial reference count of 1 should be released with hb_paint_funcs_destroy()
* when you are done using the #hb_paint_funcs_t. This function never returns
* `NULL`. If memory cannot be allocated, a special singleton #hb_paint_funcs_t
* object will be returned.
*
* Returns value: (transfer full): the paint-functions structure
*
* Since: 7.0.0
*/
hb_paint_funcs_t *
hb_paint_funcs_create ()
{
hb_paint_funcs_t *funcs;
if (unlikely (!(funcs = hb_object_create<hb_paint_funcs_t> ())))
return const_cast<hb_paint_funcs_t *> (&Null (hb_paint_funcs_t));
funcs->func = Null (hb_paint_funcs_t).func;
return funcs;
}
DEFINE_NULL_INSTANCE (hb_paint_funcs_t) =
{
HB_OBJECT_HEADER_STATIC,
{
#define HB_PAINT_FUNC_IMPLEMENT(name) hb_paint_##name##_nil,
HB_PAINT_FUNCS_IMPLEMENT_CALLBACKS
#undef HB_PAINT_FUNC_IMPLEMENT
}
};
/**
* hb_paint_funcs_get_empty:
*
* Fetches the singleton empty paint-functions structure.
*
* Return value: (transfer full): The empty paint-functions structure
*
* Since: 7.0.0
**/
hb_paint_funcs_t *
hb_paint_funcs_get_empty ()
{
return const_cast<hb_paint_funcs_t *> (&Null (hb_paint_funcs_t));
}
/**
* hb_paint_funcs_reference: (skip)
* @funcs: The paint-functions structure
*
* Increases the reference count on a paint-functions structure.
*
* This prevents @funcs from being destroyed until a matching
* call to hb_paint_funcs_destroy() is made.
*
* Return value: The paint-functions structure
*
* Since: 7.0.0
*/
hb_paint_funcs_t *
hb_paint_funcs_reference (hb_paint_funcs_t *funcs)
{
return hb_object_reference (funcs);
}
/**
* hb_paint_funcs_destroy: (skip)
* @funcs: The paint-functions structure
*
* Decreases the reference count on a paint-functions structure.
*
* When the reference count reaches zero, the structure
* is destroyed, freeing all memory.
*
* Since: 7.0.0
*/
void
hb_paint_funcs_destroy (hb_paint_funcs_t *funcs)
{
if (!hb_object_destroy (funcs)) return;
if (funcs->destroy)
{
#define HB_PAINT_FUNC_IMPLEMENT(name) \
if (funcs->destroy->name) funcs->destroy->name (!funcs->user_data ? nullptr : funcs->user_data->name);
HB_PAINT_FUNCS_IMPLEMENT_CALLBACKS
#undef HB_PAINT_FUNC_IMPLEMENT
}
hb_free (funcs->destroy);
hb_free (funcs->user_data);
hb_free (funcs);
}
/**
* hb_paint_funcs_set_user_data: (skip)
* @funcs: The paint-functions structure
* @key: The user-data key
* @data: A pointer to the user data
* @destroy: (nullable): A callback to call when @data is not needed anymore
* @replace: Whether to replace an existing data with the same key
*
* Attaches a user-data key/data pair to the specified paint-functions structure.
*
* Return value: `true` if success, `false` otherwise
*
* Since: 7.0.0
**/
hb_bool_t
hb_paint_funcs_set_user_data (hb_paint_funcs_t *funcs,
hb_user_data_key_t *key,
void * data,
hb_destroy_func_t destroy,
hb_bool_t replace)
{
return hb_object_set_user_data (funcs, key, data, destroy, replace);
}
/**
* hb_paint_funcs_get_user_data: (skip)
* @funcs: The paint-functions structure
* @key: The user-data key to query
*
* Fetches the user-data associated with the specified key,
* attached to the specified paint-functions structure.
*
* Return value: (transfer none): A pointer to the user data
*
* Since: 7.0.0
**/
void *
hb_paint_funcs_get_user_data (const hb_paint_funcs_t *funcs,
hb_user_data_key_t *key)
{
return hb_object_get_user_data (funcs, key);
}
/**
* hb_paint_funcs_make_immutable:
* @funcs: The paint-functions structure
*
* Makes a paint-functions structure immutable.
*
* After this call, all attempts to set one of the callbacks
* on @funcs will fail.
*
* Since: 7.0.0
*/
void
hb_paint_funcs_make_immutable (hb_paint_funcs_t *funcs)
{
if (hb_object_is_immutable (funcs))
return;
hb_object_make_immutable (funcs);
}
/**
* hb_paint_funcs_is_immutable:
* @funcs: The paint-functions structure
*
* Tests whether a paint-functions structure is immutable.
*
* Return value: `true` if @funcs is immutable, `false` otherwise
*
* Since: 7.0.0
*/
hb_bool_t
hb_paint_funcs_is_immutable (hb_paint_funcs_t *funcs)
{
return hb_object_is_immutable (funcs);
}
/**
* hb_color_line_get_color_stops:
* @color_line: a #hb_color_line_t object
* @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
*
* Fetches a list of color stops from the given color line object.
*
* Note that due to variations being applied, the returned color stops
* may be out of order. It is the callers responsibility to ensure that
* color stops are sorted by their offset before they are used.
*
* Return value: the total number of color stops in @color_line
*
* Since: 7.0.0
*/
unsigned int
hb_color_line_get_color_stops (hb_color_line_t *color_line,
unsigned int start,
unsigned int *count,
hb_color_stop_t *color_stops)
{
return color_line->get_color_stops (color_line,
color_line->data,
start, count,
color_stops,
color_line->get_color_stops_user_data);
}
/**
* hb_color_line_get_extend:
* @color_line: a #hb_color_line_t object
*
* Fetches the extend mode of the color line object.
*
* Return value: the extend mode of @color_line
*
* Since: 7.0.0
*/
hb_paint_extend_t
hb_color_line_get_extend (hb_color_line_t *color_line)
{
return color_line->get_extend (color_line,
color_line->data,
color_line->get_extend_user_data);
}
/**
* hb_paint_push_transform:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @xx: xx component of the transform matrix
* @yx: yx component of the transform matrix
* @xy: xy component of the transform matrix
* @yy: yy component of the transform matrix
* @dx: dx component of the transform matrix
* @dy: dy component of the transform matrix
*
* Perform a "push-transform" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_push_transform (hb_paint_funcs_t *funcs, void *paint_data,
float xx, float yx,
float xy, float yy,
float dx, float dy)
{
funcs->push_transform (paint_data, xx, yx, xy, yy, dx, dy);
}
/**
* hb_paint_pop_transform:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
*
* Perform a "pop-transform" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_pop_transform (hb_paint_funcs_t *funcs, void *paint_data)
{
funcs->pop_transform (paint_data);
}
/**
* hb_paint_color_glyph:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @glyph: the glyph ID
* @font: the font
*
* Perform a "color-glyph" paint operation.
*
* Since: 8.2.0
*/
hb_bool_t
hb_paint_color_glyph (hb_paint_funcs_t *funcs, void *paint_data,
hb_codepoint_t glyph,
hb_font_t *font)
{
return funcs->color_glyph (paint_data, glyph, font);
}
/**
* hb_paint_push_clip_glyph:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @glyph: the glyph ID
* @font: the font
*
* Perform a "push-clip-glyph" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_push_clip_glyph (hb_paint_funcs_t *funcs, void *paint_data,
hb_codepoint_t glyph,
hb_font_t *font)
{
funcs->push_clip_glyph (paint_data, glyph, font);
}
/**
* hb_paint_push_clip_rectangle:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @xmin: min X for the rectangle
* @ymin: min Y for the rectangle
* @xmax: max X for the rectangle
* @ymax: max Y for the rectangle
*
* Perform a "push-clip-rect" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_push_clip_rectangle (hb_paint_funcs_t *funcs, void *paint_data,
float xmin, float ymin, float xmax, float ymax)
{
funcs->push_clip_rectangle (paint_data, xmin, ymin, xmax, ymax);
}
/**
* hb_paint_pop_clip:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
*
* Perform a "pop-clip" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_pop_clip (hb_paint_funcs_t *funcs, void *paint_data)
{
funcs->pop_clip (paint_data);
}
/**
* hb_paint_color:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @is_foreground: whether the color is the foreground
* @color: The color to use
*
* Perform a "color" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_color (hb_paint_funcs_t *funcs, void *paint_data,
hb_bool_t is_foreground,
hb_color_t color)
{
funcs->color (paint_data, is_foreground, color);
}
/**
* hb_paint_image:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @image: image data
* @width: width of the raster image in pixels, or 0
* @height: height of the raster image in pixels, or 0
* @format: the image format as a tag
* @slant: the synthetic slant ratio to be applied to the image during rendering
* @extents: (nullable): the extents of the glyph
*
* Perform a "image" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_image (hb_paint_funcs_t *funcs, void *paint_data,
hb_blob_t *image,
unsigned int width,
unsigned int height,
hb_tag_t format,
float slant,
hb_glyph_extents_t *extents)
{
funcs->image (paint_data, image, width, height, format, slant, extents);
}
/**
* hb_paint_linear_gradient:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @color_line: Color information for the gradient
* @x0: X coordinate of the first point
* @y0: Y coordinate of the first point
* @x1: X coordinate of the second point
* @y1: Y coordinate of the second point
* @x2: X coordinate of the third point
* @y2: Y coordinate of the third point
*
* Perform a "linear-gradient" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_linear_gradient (hb_paint_funcs_t *funcs, void *paint_data,
hb_color_line_t *color_line,
float x0, float y0,
float x1, float y1,
float x2, float y2)
{
funcs->linear_gradient (paint_data, color_line, x0, y0, x1, y1, x2, y2);
}
/**
* hb_paint_radial_gradient:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @color_line: Color information for the gradient
* @x0: X coordinate of the first circle's center
* @y0: Y coordinate of the first circle's center
* @r0: radius of the first circle
* @x1: X coordinate of the second circle's center
* @y1: Y coordinate of the second circle's center
* @r1: radius of the second circle
*
* Perform a "radial-gradient" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_radial_gradient (hb_paint_funcs_t *funcs, void *paint_data,
hb_color_line_t *color_line,
float x0, float y0, float r0,
float x1, float y1, float r1)
{
funcs->radial_gradient (paint_data, color_line, x0, y0, r0, y1, x1, r1);
}
/**
* hb_paint_sweep_gradient:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @color_line: Color information for the gradient
* @x0: X coordinate of the circle's center
* @y0: Y coordinate of the circle's center
* @start_angle: the start angle
* @end_angle: the end angle
*
* Perform a "sweep-gradient" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_sweep_gradient (hb_paint_funcs_t *funcs, void *paint_data,
hb_color_line_t *color_line,
float x0, float y0,
float start_angle, float end_angle)
{
funcs->sweep_gradient (paint_data, color_line, x0, y0, start_angle, end_angle);
}
/**
* hb_paint_push_group:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
*
* Perform a "push-group" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_push_group (hb_paint_funcs_t *funcs, void *paint_data)
{
funcs->push_group (paint_data);
}
/**
* hb_paint_pop_group:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @mode: the compositing mode to use
*
* Perform a "pop-group" paint operation.
*
* Since: 7.0.0
*/
void
hb_paint_pop_group (hb_paint_funcs_t *funcs, void *paint_data,
hb_paint_composite_mode_t mode)
{
funcs->pop_group (paint_data, mode);
}
/**
* hb_paint_custom_palette_color:
* @funcs: paint functions
* @paint_data: associated data passed by the caller
* @color_index: color index
* @color: (out): fetched color
*
* Gets the custom palette color for @color_index.
*
* Return value: `true` if found, `false` otherwise
*
* Since: 7.0.0
*/
hb_bool_t
hb_paint_custom_palette_color (hb_paint_funcs_t *funcs, void *paint_data,
unsigned int color_index,
hb_color_t *color)
{
return funcs->custom_palette_color (paint_data, color_index, color);
}
#endif