Skip to content

Commit 7e2ea4d

Browse files
author
CI
committed
Rebuild docs for harfbuzz/harfbuzz@68d19d6 
1 parent 27dc282 commit 7e2ea4d

40 files changed

Lines changed: 608 additions & 369 deletions

‎a-clustering-example-for-levels-0-and-1.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -54,18 +54,18 @@
5454
initial cluster values (bottom row):
5555
</p>
5656
<pre class="programlisting">
57-
A,B,C,D,E
58-
0,1,2,3,4
59-
</pre>
57+
A,B,C,D,E
58+
0,1,2,3,4
59+
</pre>
6060
<p>
6161
During shaping, HarfBuzz maps these characters to glyphs from
6262
the font. For simplicity, let us assume that each character maps
6363
to the corresponding, identical-looking glyph:
6464
</p>
6565
<pre class="programlisting">
66-
A,B,C,D,E
67-
0,1,2,3,4
68-
</pre>
66+
A,B,C,D,E
67+
0,1,2,3,4
68+
</pre>
6969
<p>
7070
Now if, for example, <code class="literal">B</code> and <code class="literal">C</code>
7171
form a ligature, then the clusters to which they belong
@@ -74,9 +74,9 @@
7474
went in to the ligature. In this case, we get:
7575
</p>
7676
<pre class="programlisting">
77-
A,BC,D,E
78-
0,1 ,3,4
79-
</pre>
77+
A,BC,D,E
78+
0,1 ,3,4
79+
</pre>
8080
<p>
8181
because 1 is the minimum of the set {1,2}, which were the
8282
cluster values of <code class="literal">B</code> and
@@ -89,18 +89,18 @@
8989
its components each inherit the cluster value of their parent:
9090
</p>
9191
<pre class="programlisting">
92-
A,BC0,BC1,BC2,D0,D1,E
93-
0,1 ,1 ,1 ,3 ,3 ,4
94-
</pre>
92+
A,BC0,BC1,BC2,D0,D1,E
93+
0,1 ,1 ,1 ,3 ,3 ,4
94+
</pre>
9595
<p>
9696
Next, if <code class="literal">BC2</code> and <code class="literal">D0</code> form a
9797
ligature, then their clusters (cluster values 1 and 3) merge into
9898
<code class="literal">min(1,3) = 1</code>:
9999
</p>
100100
<pre class="programlisting">
101-
A,BC0,BC1,BC2D0,D1,E
102-
0,1 ,1 ,1 ,1 ,4
103-
</pre>
101+
A,BC0,BC1,BC2D0,D1,E
102+
0,1 ,1 ,1 ,1 ,4
103+
</pre>
104104
<p>
105105
Note that the entirety of cluster 3 merges into cluster 1, not
106106
just the <code class="literal">D0</code> glyph. This reflects the fact

‎a-simple-shaping-example.html‎

Lines changed: 68 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -25,76 +25,90 @@
2525
<p>
2626
Below is the simplest HarfBuzz shaping example possible.
2727
</p>
28-
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><p>
28+
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
29+
<p>
2930
Create a buffer and put your text in it.
30-
</p></li></ol></div>
31+
</p>
3132
<pre class="programlisting">
32-
#include &lt;hb.h&gt;
33+
#include &lt;hb.h&gt;
3334

34-
hb_buffer_t *buf;
35-
buf = hb_buffer_create();
36-
hb_buffer_add_utf8(buf, text, -1, 0, -1);
37-
</pre>
38-
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="2"><p>
35+
hb_buffer_t *buf;
36+
buf = hb_buffer_create();
37+
hb_buffer_add_utf8(buf, text, -1, 0, -1);
38+
</pre>
39+
</li></ol></div>
40+
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="2">
41+
<p>
3942
Set the script, language and direction of the buffer.
40-
</p></li></ol></div>
43+
</p>
4144
<pre class="programlisting">
42-
// If you know the direction, script, and language
43-
hb_buffer_set_direction(buf, HB_DIRECTION_LTR);
44-
hb_buffer_set_script(buf, HB_SCRIPT_LATIN);
45-
hb_buffer_set_language(buf, hb_language_from_string("en", -1));
45+
// If you know the direction, script, and language
46+
hb_buffer_set_direction(buf, HB_DIRECTION_LTR);
47+
hb_buffer_set_script(buf, HB_SCRIPT_LATIN);
48+
hb_buffer_set_language(buf, hb_language_from_string("en", -1));
4649

47-
// If you don't know the direction, script, and language
48-
hb_buffer_guess_segment_properties(buf);
49-
</pre>
50-
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="3"><p>
50+
// If you don't know the direction, script, and language
51+
hb_buffer_guess_segment_properties(buf);
52+
</pre>
53+
</li></ol></div>
54+
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="3">
55+
<p>
5156
Create a face and a font from a font file.
52-
</p></li></ol></div>
57+
</p>
5358
<pre class="programlisting">
54-
hb_blob_t *blob = hb_blob_create_from_file(filename); /* or hb_blob_create_from_file_or_fail() */
55-
hb_face_t *face = hb_face_create(blob, 0);
56-
hb_font_t *font = hb_font_create(face);
57-
</pre>
58-
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="4"><p>
59+
hb_blob_t *blob = hb_blob_create_from_file(filename); /* or hb_blob_create_from_file_or_fail() */
60+
hb_face_t *face = hb_face_create(blob, 0);
61+
hb_font_t *font = hb_font_create(face);
62+
</pre>
63+
</li></ol></div>
64+
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="4">
65+
<p>
5966
Shape!
60-
</p></li></ol></div>
67+
</p>
6168
<pre class="programlisting">
62-
hb_shape(font, buf, NULL, 0);
63-
</pre>
64-
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="5"><p>
69+
hb_shape(font, buf, NULL, 0);
70+
</pre>
71+
</li></ol></div>
72+
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="5">
73+
<p>
6574
Get the glyph and position information.
66-
</p></li></ol></div>
75+
</p>
6776
<pre class="programlisting">
68-
unsigned int glyph_count;
69-
hb_glyph_info_t *glyph_info = hb_buffer_get_glyph_infos(buf, &amp;glyph_count);
70-
hb_glyph_position_t *glyph_pos = hb_buffer_get_glyph_positions(buf, &amp;glyph_count);
71-
</pre>
72-
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="6"><p>
77+
unsigned int glyph_count;
78+
hb_glyph_info_t *glyph_info = hb_buffer_get_glyph_infos(buf, &amp;glyph_count);
79+
hb_glyph_position_t *glyph_pos = hb_buffer_get_glyph_positions(buf, &amp;glyph_count);
80+
</pre>
81+
</li></ol></div>
82+
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="6">
83+
<p>
7384
Iterate over each glyph.
74-
</p></li></ol></div>
85+
</p>
7586
<pre class="programlisting">
76-
hb_position_t cursor_x = 0;
77-
hb_position_t cursor_y = 0;
78-
for (unsigned int i = 0; i &lt; glyph_count; i++) {
79-
hb_codepoint_t glyphid = glyph_info[i].codepoint;
80-
hb_position_t x_offset = glyph_pos[i].x_offset;
81-
hb_position_t y_offset = glyph_pos[i].y_offset;
82-
hb_position_t x_advance = glyph_pos[i].x_advance;
83-
hb_position_t y_advance = glyph_pos[i].y_advance;
84-
/* draw_glyph(glyphid, cursor_x + x_offset, cursor_y + y_offset); */
85-
cursor_x += x_advance;
86-
cursor_y += y_advance;
87-
}
88-
</pre>
89-
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="7"><p>
87+
hb_position_t cursor_x = 0;
88+
hb_position_t cursor_y = 0;
89+
for (unsigned int i = 0; i &lt; glyph_count; i++) {
90+
hb_codepoint_t glyphid = glyph_info[i].codepoint;
91+
hb_position_t x_offset = glyph_pos[i].x_offset;
92+
hb_position_t y_offset = glyph_pos[i].y_offset;
93+
hb_position_t x_advance = glyph_pos[i].x_advance;
94+
hb_position_t y_advance = glyph_pos[i].y_advance;
95+
/* draw_glyph(glyphid, cursor_x + x_offset, cursor_y + y_offset); */
96+
cursor_x += x_advance;
97+
cursor_y += y_advance;
98+
}
99+
</pre>
100+
</li></ol></div>
101+
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem" value="7">
102+
<p>
90103
Tidy up.
91-
</p></li></ol></div>
104+
</p>
92105
<pre class="programlisting">
93-
hb_buffer_destroy(buf);
94-
hb_font_destroy(font);
95-
hb_face_destroy(face);
96-
hb_blob_destroy(blob);
97-
</pre>
106+
hb_buffer_destroy(buf);
107+
hb_font_destroy(font);
108+
hb_face_destroy(face);
109+
hb_blob_destroy(blob);
110+
</pre>
111+
</li></ol></div>
98112
<p>
99113
This example shows enough to get us started using HarfBuzz. In
100114
the sections that follow, we will use the remainder of

‎adding-text-to-the-buffer.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,18 @@
4040
character to add, and the length of the segment to add:
4141
</p>
4242
<pre class="programlisting">
43-
hb_buffer_add_utf8 (hb_buffer_t *buf,
44-
const char *text,
45-
int text_length,
46-
unsigned int item_offset,
47-
int item_length)
48-
</pre>
43+
hb_buffer_add_utf8 (hb_buffer_t *buf,
44+
const char *text,
45+
int text_length,
46+
unsigned int item_offset,
47+
int item_length)
48+
</pre>
4949
<p>
5050
So, in practice, you can say:
5151
</p>
5252
<pre class="programlisting">
53-
hb_buffer_add_utf8(buf, text, strlen(text), 0, strlen(text));
54-
</pre>
53+
hb_buffer_add_utf8(buf, text, strlen(text), 0, strlen(text));
54+
</pre>
5555
<p>
5656
This will append your new characters to
5757
<em class="parameter"><code>buf</code></em>, not replace its existing

‎api-index-13-0-0.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
77
<link rel="home" href="index.html" title="HarfBuzz Manual">
88
<link rel="up" href="reference-manual.html" title="Part II. Reference manual">
9-
<link rel="prev" href="deprecated-api-index.html" title="Index of deprecated API">
9+
<link rel="prev" href="api-index-13-1-0.html" title="Index of new symbols in 13.1.0">
1010
<link rel="next" href="api-index-12-1-0.html" title="Index of new symbols in 12.1.0">
1111
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
1212
<link rel="stylesheet" href="style.css" type="text/css">
@@ -22,7 +22,7 @@
2222
<a class="shortcut" href="#idxV">V</a></span></td>
2323
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
2424
<td><a accesskey="u" href="reference-manual.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25-
<td><a accesskey="p" href="deprecated-api-index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25+
<td><a accesskey="p" href="api-index-13-1-0.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
2626
<td><a accesskey="n" href="api-index-12-1-0.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
2727
</tr></table>
2828
<div class="index">

‎api-index-13-1-0.html‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2+
<html>
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5+
<title>Index of new symbols in 13.1.0: HarfBuzz Manual</title>
6+
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7+
<link rel="home" href="index.html" title="HarfBuzz Manual">
8+
<link rel="up" href="reference-manual.html" title="Part II. Reference manual">
9+
<link rel="prev" href="deprecated-api-index.html" title="Index of deprecated API">
10+
<link rel="next" href="api-index-13-0-0.html" title="Index of new symbols in 13.0.0">
11+
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
12+
<link rel="stylesheet" href="style.css" type="text/css">
13+
</head>
14+
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15+
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16+
<td width="100%" align="left" class="shortcuts"><span id="nav_index"><a class="shortcut" href="#idxR">R</a></span></td>
17+
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
18+
<td><a accesskey="u" href="reference-manual.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
19+
<td><a accesskey="p" href="deprecated-api-index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
20+
<td><a accesskey="n" href="api-index-13-0-0.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
21+
</tr></table>
22+
<div class="index">
23+
<div class="titlepage"><div><div><h2 class="title">
24+
<a name="api-index-13-1-0"></a>Index of new symbols in 13.1.0</h2></div></div></div>
25+
<a name="idx"></a><a name="idxR"></a><h3 class="title">R</h3>
26+
<dt>
27+
<a class="link" href="harfbuzz-hb-raster.html#hb-raster-image-deserialize-from-png-or-fail" title="hb_raster_image_deserialize_from_png_or_fail ()">hb_raster_image_deserialize_from_png_or_fail</a>, function in <a class="link" href="harfbuzz-hb-raster.html" title="hb-raster">hb-raster</a>
28+
</dt>
29+
<dd></dd>
30+
<dt>
31+
<a class="link" href="harfbuzz-hb-raster.html#hb-raster-image-serialize-to-png-or-fail" title="hb_raster_image_serialize_to_png_or_fail ()">hb_raster_image_serialize_to_png_or_fail</a>, function in <a class="link" href="harfbuzz-hb-raster.html" title="hb-raster">hb-raster</a>
32+
</dt>
33+
<dd></dd>
34+
</div>
35+
<div class="footer">
36+
<hr>Generated by GTK-Doc V1.34.0</div>
37+
</body>
38+
</html>

‎api-index-full.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2752,6 +2752,10 @@
27522752
</dt>
27532753
<dd></dd>
27542754
<dt>
2755+
<a class="link" href="harfbuzz-hb-raster.html#hb-raster-image-deserialize-from-png-or-fail" title="hb_raster_image_deserialize_from_png_or_fail ()">hb_raster_image_deserialize_from_png_or_fail</a>, function in <a class="link" href="harfbuzz-hb-raster.html" title="hb-raster">hb-raster</a>
2756+
</dt>
2757+
<dd></dd>
2758+
<dt>
27552759
<a class="link" href="harfbuzz-hb-raster.html#hb-raster-image-destroy" title="hb_raster_image_destroy ()">hb_raster_image_destroy</a>, function in <a class="link" href="harfbuzz-hb-raster.html" title="hb-raster">hb-raster</a>
27562760
</dt>
27572761
<dd></dd>
@@ -2776,6 +2780,10 @@
27762780
</dt>
27772781
<dd></dd>
27782782
<dt>
2783+
<a class="link" href="harfbuzz-hb-raster.html#hb-raster-image-serialize-to-png-or-fail" title="hb_raster_image_serialize_to_png_or_fail ()">hb_raster_image_serialize_to_png_or_fail</a>, function in <a class="link" href="harfbuzz-hb-raster.html" title="hb-raster">hb-raster</a>
2784+
</dt>
2785+
<dd></dd>
2786+
<dt>
27792787
<a class="link" href="harfbuzz-hb-raster.html#hb-raster-image-set-user-data" title="hb_raster_image_set_user_data ()">hb_raster_image_set_user_data</a>, function in <a class="link" href="harfbuzz-hb-raster.html" title="hb-raster">hb-raster</a>
27802788
</dt>
27812789
<dd></dd>

‎buffers-language-script-and-direction.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,10 @@
5858
a buffer, you can call <code class="function">hb_buffer_destroy()</code>:
5959
</p>
6060
<pre class="programlisting">
61-
hb_buffer_t *buf = hb_buffer_create();
62-
...
63-
hb_buffer_destroy(buf);
64-
</pre>
61+
hb_buffer_t *buf = hb_buffer_create();
62+
...
63+
hb_buffer_destroy(buf);
64+
</pre>
6565
<p>
6666
This will destroy the object and free its associated memory -
6767
unless some other part of the program holds a reference to this
@@ -70,17 +70,17 @@
7070
else destroying it, you should increase its reference count:
7171
</p>
7272
<pre class="programlisting">
73-
void somefunc(hb_buffer_t *buf) {
74-
buf = hb_buffer_reference(buf);
75-
...
76-
</pre>
73+
void somefunc(hb_buffer_t *buf) {
74+
buf = hb_buffer_reference(buf);
75+
...
76+
</pre>
7777
<p>
7878
And then decrease it once you're done with it:
7979
</p>
8080
<pre class="programlisting">
81-
hb_buffer_destroy(buf);
82-
}
83-
</pre>
81+
hb_buffer_destroy(buf);
82+
}
83+
</pre>
8484
<p>
8585
While we are on the subject of reference-counting buffers, it is
8686
worth noting that an individual buffer can only meaningfully be

‎customizing-unicode-functions.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@
7272
your buffer by calling <code class="function">hb_buffer_get_unicode_funcs()</code>:
7373
</p>
7474
<pre class="programlisting">
75-
hb_unicode_funcs_t *ufunctions;
76-
ufunctions = hb_buffer_get_unicode_funcs(buf);
77-
</pre>
75+
hb_unicode_funcs_t *ufunctions;
76+
ufunctions = hb_buffer_get_unicode_funcs(buf);
77+
</pre>
7878
<p>
7979
The current version of <code class="literal">unicode_funcs</code> uses six functions:
8080
</p>
@@ -115,8 +115,8 @@
115115
<code class="function">hb_unicode_general_category_func_t</code>, you can call
116116
</p>
117117
<pre class="programlisting">
118-
hb_unicode_funcs_set_general_category_func (*ufuncs, func, *user_data, destroy)
119-
</pre>
118+
hb_unicode_funcs_set_general_category_func (*ufuncs, func, *user_data, destroy)
119+
</pre>
120120
<p>
121121
Virtualizing this set of Unicode functions is primarily intended
122122
to improve portability. There is no need for every client

‎deprecated-api-index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<link rel="home" href="index.html" title="HarfBuzz Manual">
88
<link rel="up" href="reference-manual.html" title="Part II. Reference manual">
99
<link rel="prev" href="api-index-full.html" title="API Index">
10-
<link rel="next" href="api-index-13-0-0.html" title="Index of new symbols in 13.0.0">
10+
<link rel="next" href="api-index-13-1-0.html" title="Index of new symbols in 13.1.0">
1111
<meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
1212
<link rel="stylesheet" href="style.css" type="text/css">
1313
</head>
@@ -33,7 +33,7 @@
3333
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
3434
<td><a accesskey="u" href="reference-manual.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
3535
<td><a accesskey="p" href="api-index-full.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
36-
<td><a accesskey="n" href="api-index-13-0-0.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
36+
<td><a accesskey="n" href="api-index-13-1-0.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
3737
</tr></table>
3838
<div class="index">
3939
<div class="titlepage"><div><div><h2 class="title">

0 commit comments

Comments
 (0)