Files
harfbuzz/test/api/test-gpu.cc
T
Behdad Esfahbod 4650398a07 [gpu] encode() returns extents + auto-clears; drop get_extents() (#5910)
Bring hb_gpu_draw_encode into line with the rest of the render APIs:
auto-clear on success, and return the computed glyph extents to the
caller via a new out-parameter (nullable).

  HB_EXTERN hb_blob_t *
  hb_gpu_draw_encode (hb_gpu_draw_t      *draw,
                      hb_glyph_extents_t *extents);

Consumers typically need both the encoded blob and the glyph's
extents to size the quad they'll draw into in the vertex shader;
returning them together removes a redundant trip through the draw
state and lets encode() auto-clear like hb_vector_*_render() and
hb_raster_*_render() do.

Drop hb_gpu_draw_get_extents() from the public API — its only
role was reading extents out of the draw state post-encode, which
the new encode() signature makes redundant.  The computation
stays (moved to a static _hb_gpu_draw_get_extents helper) so
encode() can call it before auto-clear wipes the state.

ABI break for anyone who had already wired up against the 14.0.0
hb_gpu_draw_encode signature or hb_gpu_draw_get_extents, but the
library is new/experimental and the two in-tree consumers
(test/api/test-gpu.cc, util/gpu/demo-font.cc, util/hb-gpu-encode-all.cc,
test/fuzzing/hb-gpu-fuzzer.cc) are updated here.

All 240 tests pass.

Assisted-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-13 00:15:54 -06:00

329 lines
9.4 KiB
C++

/*
* Copyright (C) 2026 Behdad Esfahbod
*
* 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.
*
* Author(s): Behdad Esfahbod
*/
#include "hb-test.h"
#include "hb-gpu.h"
#include <hb-ot.h>
#define FONT_FILE "fonts/Roboto-Regular.abc.ttf"
struct hb_gpu_test_texel_t
{
int16_t r, g, b, a;
};
static const hb_gpu_test_texel_t *
blob_as_texels (hb_blob_t *blob,
unsigned *texel_count)
{
unsigned length = hb_blob_get_length (blob);
g_assert_cmpuint (length % sizeof (hb_gpu_test_texel_t), ==, 0);
*texel_count = length / sizeof (hb_gpu_test_texel_t);
return (const hb_gpu_test_texel_t *) hb_blob_get_data (blob, nullptr);
}
static hb_bool_t
blob_has_texel (hb_blob_t *blob,
const hb_gpu_test_texel_t needle)
{
unsigned texel_count;
const hb_gpu_test_texel_t *texels = blob_as_texels (blob, &texel_count);
for (unsigned i = 0; i < texel_count; i++)
if (texels[i].r == needle.r &&
texels[i].g == needle.g &&
texels[i].b == needle.b &&
texels[i].a == needle.a)
return true;
return false;
}
static void
test_create_destroy (void)
{
hb_gpu_draw_t *draw = hb_gpu_draw_create_or_fail ();
g_assert_nonnull (draw);
hb_gpu_draw_t *ref = hb_gpu_draw_reference (draw);
g_assert_true (ref == draw);
hb_gpu_draw_destroy (ref);
hb_gpu_draw_destroy (draw);
}
static void
test_empty_encode (void)
{
hb_gpu_draw_t *draw = hb_gpu_draw_create_or_fail ();
g_assert_nonnull (draw);
/* Encode with no curves should return empty blob and zero extents. */
hb_glyph_extents_t ext;
hb_blob_t *blob = hb_gpu_draw_encode (draw, &ext);
g_assert_nonnull (blob);
g_assert_cmpuint (hb_blob_get_length (blob), ==, 0);
hb_blob_destroy (blob);
g_assert_cmpint (ext.x_bearing, ==, 0);
g_assert_cmpint (ext.y_bearing, ==, 0);
g_assert_cmpint (ext.width, ==, 0);
g_assert_cmpint (ext.height, ==, 0);
hb_gpu_draw_destroy (draw);
}
static void
test_encode_glyph (void)
{
hb_face_t *face = hb_test_open_font_file (FONT_FILE);
g_assert_nonnull (face);
hb_font_t *font = hb_font_create (face);
hb_gpu_draw_t *draw = hb_gpu_draw_create_or_fail ();
g_assert_nonnull (draw);
/* Draw glyph for 'a' (glyph index from cmap). */
hb_codepoint_t gid;
hb_bool_t found = hb_font_get_nominal_glyph (font, 'a', &gid);
g_assert_true (found);
hb_gpu_draw_glyph (draw, font, gid);
/* Encode should produce non-empty blob with non-zero extents. */
hb_glyph_extents_t ext;
hb_blob_t *blob = hb_gpu_draw_encode (draw, &ext);
g_assert_nonnull (blob);
g_assert_cmpuint (hb_blob_get_length (blob), >, 0);
/* Blob size should be a multiple of 8 (RGBA16I texels). */
g_assert_cmpuint (hb_blob_get_length (blob) % 8, ==, 0);
g_assert_cmpint (ext.width, >, 0);
g_assert_cmpint (ext.height, <, 0); /* height is negative (y-down) */
hb_blob_destroy (blob);
hb_gpu_draw_destroy (draw);
hb_font_destroy (font);
hb_face_destroy (face);
}
static void
test_reset (void)
{
hb_face_t *face = hb_test_open_font_file (FONT_FILE);
hb_font_t *font = hb_font_create (face);
hb_gpu_draw_t *draw = hb_gpu_draw_create_or_fail ();
g_assert_nonnull (draw);
hb_codepoint_t gid;
hb_font_get_nominal_glyph (font, 'a', &gid);
/* Draw, encode, reset, encode again — should work. */
hb_gpu_draw_glyph (draw, font, gid);
hb_blob_t *blob1 = hb_gpu_draw_encode (draw, nullptr);
g_assert_cmpuint (hb_blob_get_length (blob1), >, 0);
hb_blob_destroy (blob1);
hb_gpu_draw_reset (draw);
/* After reset, encode should be empty. */
hb_blob_t *blob2 = hb_gpu_draw_encode (draw, nullptr);
g_assert_cmpuint (hb_blob_get_length (blob2), ==, 0);
hb_blob_destroy (blob2);
/* Draw again after reset. */
hb_gpu_draw_glyph (draw, font, gid);
hb_blob_t *blob3 = hb_gpu_draw_encode (draw, nullptr);
g_assert_cmpuint (hb_blob_get_length (blob3), >, 0);
hb_blob_destroy (blob3);
hb_gpu_draw_destroy (draw);
hb_font_destroy (font);
hb_face_destroy (face);
}
static void
test_draw_funcs (void)
{
hb_draw_funcs_t *funcs = hb_gpu_draw_get_funcs ();
g_assert_nonnull (funcs);
/* Should be the same singleton each time. */
g_assert_true (funcs == hb_gpu_draw_get_funcs ());
}
static void
test_shader_sources (void)
{
g_assert_nonnull (hb_gpu_shader_fragment_source (HB_GPU_SHADER_LANG_GLSL));
g_assert_nonnull (hb_gpu_shader_vertex_source (HB_GPU_SHADER_LANG_GLSL));
}
static void
test_encode_quantizes_extents_outward (void)
{
hb_gpu_draw_t *draw = hb_gpu_draw_create_or_fail ();
g_assert_nonnull (draw);
hb_draw_funcs_t *funcs = hb_gpu_draw_get_funcs ();
hb_draw_state_t st = HB_DRAW_STATE_DEFAULT;
hb_draw_move_to (funcs, draw, &st, 0.24f, 0.24f);
hb_draw_line_to (funcs, draw, &st, 0.76f, 0.24f);
hb_draw_line_to (funcs, draw, &st, 0.76f, 0.76f);
hb_draw_close_path (funcs, draw, &st);
hb_blob_t *blob = hb_gpu_draw_encode (draw, nullptr);
g_assert_nonnull (blob);
unsigned texel_count;
const hb_gpu_test_texel_t *texels = blob_as_texels (blob, &texel_count);
g_assert_cmpuint (texel_count, >, 0);
g_assert_cmpint (texels[0].r, ==, 0);
g_assert_cmpint (texels[0].g, ==, 0);
g_assert_cmpint (texels[0].b, ==, 4);
g_assert_cmpint (texels[0].a, ==, 4);
hb_blob_destroy (blob);
hb_gpu_draw_destroy (draw);
}
static void
test_encode_preserves_touching_contours (void)
{
hb_gpu_draw_t *draw = hb_gpu_draw_create_or_fail ();
g_assert_nonnull (draw);
hb_draw_funcs_t *funcs = hb_gpu_draw_get_funcs ();
hb_draw_state_t st = HB_DRAW_STATE_DEFAULT;
hb_draw_move_to (funcs, draw, &st, 0.f, 0.f);
hb_draw_line_to (funcs, draw, &st, 1.f, 0.f);
hb_draw_line_to (funcs, draw, &st, 0.f, 1.f);
hb_draw_close_path (funcs, draw, &st);
hb_draw_move_to (funcs, draw, &st, 0.f, 0.f);
hb_draw_quadratic_to (funcs, draw, &st, -0.75f, 0.25f, -0.25f, -1.f);
hb_draw_close_path (funcs, draw, &st);
hb_blob_t *blob = hb_gpu_draw_encode (draw, nullptr);
g_assert_nonnull (blob);
g_assert_true (blob_has_texel (blob, {0, 0, -3, 1}));
hb_blob_destroy (blob);
hb_gpu_draw_destroy (draw);
}
static void
test_recycle_blob (void)
{
hb_gpu_draw_t *draw = hb_gpu_draw_create_or_fail ();
g_assert_nonnull (draw);
hb_draw_funcs_t *funcs = hb_gpu_draw_get_funcs ();
hb_draw_state_t st = HB_DRAW_STATE_DEFAULT;
hb_draw_move_to (funcs, draw, &st, 0.f, 0.f);
hb_draw_line_to (funcs, draw, &st, 1.f, 0.f);
hb_draw_line_to (funcs, draw, &st, 0.f, 1.f);
hb_draw_close_path (funcs, draw, &st);
hb_blob_t *blob = hb_gpu_draw_encode (draw, nullptr);
g_assert_nonnull (blob);
unsigned first_length = hb_blob_get_length (blob);
g_assert_cmpuint (first_length, >, 0);
hb_gpu_draw_recycle_blob (draw, blob);
hb_gpu_draw_reset (draw);
hb_draw_move_to (funcs, draw, &st, 0.f, 0.f);
hb_draw_line_to (funcs, draw, &st, 2.f, 0.f);
hb_draw_line_to (funcs, draw, &st, 2.f, 2.f);
hb_draw_line_to (funcs, draw, &st, 0.f, 2.f);
hb_draw_close_path (funcs, draw, &st);
hb_draw_move_to (funcs, draw, &st, 0.25f, 0.25f);
hb_draw_quadratic_to (funcs, draw, &st, 1.f, 1.75f, 1.75f, 0.25f);
hb_draw_quadratic_to (funcs, draw, &st, 1.f, -0.5f, 0.25f, 0.25f);
hb_draw_close_path (funcs, draw, &st);
hb_blob_t *blob2 = hb_gpu_draw_encode (draw, nullptr);
g_assert_nonnull (blob2);
g_assert_cmpuint (hb_blob_get_length (blob2), >, first_length);
hb_blob_destroy (blob2);
hb_gpu_draw_destroy (draw);
}
static void
test_extents_saturate_overflow (void)
{
hb_gpu_draw_t *draw = hb_gpu_draw_create_or_fail ();
g_assert_nonnull (draw);
hb_draw_funcs_t *funcs = hb_gpu_draw_get_funcs ();
hb_draw_state_t st = HB_DRAW_STATE_DEFAULT;
hb_draw_move_to (funcs, draw, &st, -0x1p31f, 0.f);
hb_draw_line_to (funcs, draw, &st, 821.f, 0.f);
hb_draw_line_to (funcs, draw, &st, 821.f, 1.f);
hb_draw_close_path (funcs, draw, &st);
hb_glyph_extents_t ext;
hb_blob_t *blob = hb_gpu_draw_encode (draw, &ext);
hb_blob_destroy (blob);
g_assert_cmpint (ext.x_bearing, ==, G_MININT32);
g_assert_cmpint (ext.y_bearing, ==, 1);
g_assert_cmpint (ext.width, ==, G_MAXINT32);
g_assert_cmpint (ext.height, ==, -1);
hb_gpu_draw_destroy (draw);
}
int
main (int argc, char **argv)
{
hb_test_init (&argc, &argv);
hb_test_add (test_create_destroy);
hb_test_add (test_empty_encode);
hb_test_add (test_encode_glyph);
hb_test_add (test_reset);
hb_test_add (test_draw_funcs);
hb_test_add (test_shader_sources);
hb_test_add (test_encode_quantizes_extents_outward);
hb_test_add (test_encode_preserves_touching_contours);
hb_test_add (test_recycle_blob);
hb_test_add (test_extents_saturate_overflow);
return hb_test_run ();
}