docs/html/harfbuzz-Buffers.html

   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>Buffers: HarfBuzz Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="index.html" title="HarfBuzz Manual">
   8 <link rel="up" href="ch08.html" title="HarfBuzz API">
   9 <link rel="prev" href="harfbuzz-hb-unicode.html" title="hb-unicode">
  10 <link rel="next" href="harfbuzz-hb-blob.html" title="hb-blob">
  11 <meta name="generator" content="GTK-Doc V1.27.1 (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">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
  18                   <a href="#harfbuzz-Buffers.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
  19                   <a href="#harfbuzz-Buffers.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch08.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="harfbuzz-hb-unicode.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="harfbuzz-hb-blob.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="harfbuzz-Buffers"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="harfbuzz-Buffers.top_of_page"></a>Buffers</span></h2>
  31 <p>Buffers — Input and output buffers</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="harfbuzz-Buffers.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="function_type">
  45 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="returnvalue">hb_buffer_t</span></a> *
  46 </td>
  47 <td class="function_name">
  48 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-create" title="hb_buffer_create ()">hb_buffer_create</a> <span class="c_punctuation">()</span>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="returnvalue">hb_buffer_t</span></a> *
  54 </td>
  55 <td class="function_name">
  56 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-reference" title="hb_buffer_reference ()">hb_buffer_reference</a> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">
  61 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="returnvalue">hb_buffer_t</span></a> *
  62 </td>
  63 <td class="function_name">
  64 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-empty" title="hb_buffer_get_empty ()">hb_buffer_get_empty</a> <span class="c_punctuation">()</span>
  65 </td>
  66 </tr>
  67 <tr>
  68 <td class="function_type">
  69 <span class="returnvalue">void</span>
  70 </td>
  71 <td class="function_name">
  72 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-destroy" title="hb_buffer_destroy ()">hb_buffer_destroy</a> <span class="c_punctuation">()</span>
  73 </td>
  74 </tr>
  75 <tr>
  76 <td class="function_type">
  77 <span class="returnvalue">void</span>
  78 </td>
  79 <td class="function_name">
  80 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-reset" title="hb_buffer_reset ()">hb_buffer_reset</a> <span class="c_punctuation">()</span>
  81 </td>
  82 </tr>
  83 <tr>
  84 <td class="function_type">
  85 <span class="returnvalue">void</span>
  86 </td>
  87 <td class="function_name">
  88 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-clear-contents" title="hb_buffer_clear_contents ()">hb_buffer_clear_contents</a> <span class="c_punctuation">()</span>
  89 </td>
  90 </tr>
  91 <tr>
  92 <td class="function_type">
  93 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
  94 </td>
  95 <td class="function_name">
  96 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-pre-allocate" title="hb_buffer_pre_allocate ()">hb_buffer_pre_allocate</a> <span class="c_punctuation">()</span>
  97 </td>
  98 </tr>
  99 <tr>
 100 <td class="function_type">
 101 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
 102 </td>
 103 <td class="function_name">
 104 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-allocation-successful" title="hb_buffer_allocation_successful ()">hb_buffer_allocation_successful</a> <span class="c_punctuation">()</span>
 105 </td>
 106 </tr>
 107 <tr>
 108 <td class="function_type">
 109 <span class="returnvalue">void</span>
 110 </td>
 111 <td class="function_name">
 112 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add" title="hb_buffer_add ()">hb_buffer_add</a> <span class="c_punctuation">()</span>
 113 </td>
 114 </tr>
 115 <tr>
 116 <td class="function_type">
 117 <span class="returnvalue">void</span>
 118 </td>
 119 <td class="function_name">
 120 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add-codepoints" title="hb_buffer_add_codepoints ()">hb_buffer_add_codepoints</a> <span class="c_punctuation">()</span>
 121 </td>
 122 </tr>
 123 <tr>
 124 <td class="function_type">
 125 <span class="returnvalue">void</span>
 126 </td>
 127 <td class="function_name">
 128 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add-utf32" title="hb_buffer_add_utf32 ()">hb_buffer_add_utf32</a> <span class="c_punctuation">()</span>
 129 </td>
 130 </tr>
 131 <tr>
 132 <td class="function_type">
 133 <span class="returnvalue">void</span>
 134 </td>
 135 <td class="function_name">
 136 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add-utf16" title="hb_buffer_add_utf16 ()">hb_buffer_add_utf16</a> <span class="c_punctuation">()</span>
 137 </td>
 138 </tr>
 139 <tr>
 140 <td class="function_type">
 141 <span class="returnvalue">void</span>
 142 </td>
 143 <td class="function_name">
 144 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add-utf8" title="hb_buffer_add_utf8 ()">hb_buffer_add_utf8</a> <span class="c_punctuation">()</span>
 145 </td>
 146 </tr>
 147 <tr>
 148 <td class="function_type">
 149 <span class="returnvalue">void</span>
 150 </td>
 151 <td class="function_name">
 152 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add-latin1" title="hb_buffer_add_latin1 ()">hb_buffer_add_latin1</a> <span class="c_punctuation">()</span>
 153 </td>
 154 </tr>
 155 <tr>
 156 <td class="function_type">
 157 <span class="returnvalue">void</span>
 158 </td>
 159 <td class="function_name">
 160 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-append" title="hb_buffer_append ()">hb_buffer_append</a> <span class="c_punctuation">()</span>
 161 </td>
 162 </tr>
 163 <tr>
 164 <td class="function_type">
 165 <span class="returnvalue">void</span>
 166 </td>
 167 <td class="function_name">
 168 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-content-type" title="hb_buffer_set_content_type ()">hb_buffer_set_content_type</a> <span class="c_punctuation">()</span>
 169 </td>
 170 </tr>
 171 <tr>
 172 <td class="function_type">
 173 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-content-type-t" title="enum hb_buffer_content_type_t"><span class="returnvalue">hb_buffer_content_type_t</span></a>
 174 </td>
 175 <td class="function_name">
 176 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-content-type" title="hb_buffer_get_content_type ()">hb_buffer_get_content_type</a> <span class="c_punctuation">()</span>
 177 </td>
 178 </tr>
 179 <tr>
 180 <td class="function_type">
 181 <span class="returnvalue">void</span>
 182 </td>
 183 <td class="function_name">
 184 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-direction" title="hb_buffer_set_direction ()">hb_buffer_set_direction</a> <span class="c_punctuation">()</span>
 185 </td>
 186 </tr>
 187 <tr>
 188 <td class="function_type">
 189 <a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="returnvalue">hb_direction_t</span></a>
 190 </td>
 191 <td class="function_name">
 192 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-direction" title="hb_buffer_get_direction ()">hb_buffer_get_direction</a> <span class="c_punctuation">()</span>
 193 </td>
 194 </tr>
 195 <tr>
 196 <td class="function_type">
 197 <span class="returnvalue">void</span>
 198 </td>
 199 <td class="function_name">
 200 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-script" title="hb_buffer_set_script ()">hb_buffer_set_script</a> <span class="c_punctuation">()</span>
 201 </td>
 202 </tr>
 203 <tr>
 204 <td class="function_type">
 205 <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="returnvalue">hb_script_t</span></a>
 206 </td>
 207 <td class="function_name">
 208 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-script" title="hb_buffer_get_script ()">hb_buffer_get_script</a> <span class="c_punctuation">()</span>
 209 </td>
 210 </tr>
 211 <tr>
 212 <td class="function_type">
 213 <span class="returnvalue">void</span>
 214 </td>
 215 <td class="function_name">
 216 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-language" title="hb_buffer_set_language ()">hb_buffer_set_language</a> <span class="c_punctuation">()</span>
 217 </td>
 218 </tr>
 219 <tr>
 220 <td class="function_type">
 221 <a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="returnvalue">hb_language_t</span></a>
 222 </td>
 223 <td class="function_name">
 224 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-language" title="hb_buffer_get_language ()">hb_buffer_get_language</a> <span class="c_punctuation">()</span>
 225 </td>
 226 </tr>
 227 <tr>
 228 <td class="function_type">
 229 <span class="returnvalue">void</span>
 230 </td>
 231 <td class="function_name">
 232 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-flags" title="hb_buffer_set_flags ()">hb_buffer_set_flags</a> <span class="c_punctuation">()</span>
 233 </td>
 234 </tr>
 235 <tr>
 236 <td class="function_type">
 237 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-flags-t" title="enum hb_buffer_flags_t"><span class="returnvalue">hb_buffer_flags_t</span></a>
 238 </td>
 239 <td class="function_name">
 240 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-flags" title="hb_buffer_get_flags ()">hb_buffer_get_flags</a> <span class="c_punctuation">()</span>
 241 </td>
 242 </tr>
 243 <tr>
 244 <td class="function_type">
 245 <span class="returnvalue">void</span>
 246 </td>
 247 <td class="function_name">
 248 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-cluster-level" title="hb_buffer_set_cluster_level ()">hb_buffer_set_cluster_level</a> <span class="c_punctuation">()</span>
 249 </td>
 250 </tr>
 251 <tr>
 252 <td class="function_type">
 253 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-cluster-level-t" title="enum hb_buffer_cluster_level_t"><span class="returnvalue">hb_buffer_cluster_level_t</span></a>
 254 </td>
 255 <td class="function_name">
 256 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-cluster-level" title="hb_buffer_get_cluster_level ()">hb_buffer_get_cluster_level</a> <span class="c_punctuation">()</span>
 257 </td>
 258 </tr>
 259 <tr>
 260 <td class="function_type">
 261 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
 262 </td>
 263 <td class="function_name">
 264 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-length" title="hb_buffer_set_length ()">hb_buffer_set_length</a> <span class="c_punctuation">()</span>
 265 </td>
 266 </tr>
 267 <tr>
 268 <td class="function_type">unsigned <span class="returnvalue">int</span>
 269 </td>
 270 <td class="function_name">
 271 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-length" title="hb_buffer_get_length ()">hb_buffer_get_length</a> <span class="c_punctuation">()</span>
 272 </td>
 273 </tr>
 274 <tr>
 275 <td class="function_type">
 276 <span class="returnvalue">void</span>
 277 </td>
 278 <td class="function_name">
 279 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-segment-properties" title="hb_buffer_set_segment_properties ()">hb_buffer_set_segment_properties</a> <span class="c_punctuation">()</span>
 280 </td>
 281 </tr>
 282 <tr>
 283 <td class="function_type">
 284 <span class="returnvalue">void</span>
 285 </td>
 286 <td class="function_name">
 287 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-segment-properties" title="hb_buffer_get_segment_properties ()">hb_buffer_get_segment_properties</a> <span class="c_punctuation">()</span>
 288 </td>
 289 </tr>
 290 <tr>
 291 <td class="function_type">
 292 <span class="returnvalue">void</span>
 293 </td>
 294 <td class="function_name">
 295 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-guess-segment-properties" title="hb_buffer_guess_segment_properties ()">hb_buffer_guess_segment_properties</a> <span class="c_punctuation">()</span>
 296 </td>
 297 </tr>
 298 <tr>
 299 <td class="function_type">
 300 <span class="returnvalue">void</span>
 301 </td>
 302 <td class="function_name">
 303 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-unicode-funcs" title="hb_buffer_set_unicode_funcs ()">hb_buffer_set_unicode_funcs</a> <span class="c_punctuation">()</span>
 304 </td>
 305 </tr>
 306 <tr>
 307 <td class="function_type">
 308 <a class="link" href="harfbuzz-hb-unicode.html#hb-unicode-funcs-t"><span class="returnvalue">hb_unicode_funcs_t</span></a> *
 309 </td>
 310 <td class="function_name">
 311 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-unicode-funcs" title="hb_buffer_get_unicode_funcs ()">hb_buffer_get_unicode_funcs</a> <span class="c_punctuation">()</span>
 312 </td>
 313 </tr>
 314 <tr>
 315 <td class="function_type">
 316 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
 317 </td>
 318 <td class="function_name">
 319 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-user-data" title="hb_buffer_set_user_data ()">hb_buffer_set_user_data</a> <span class="c_punctuation">()</span>
 320 </td>
 321 </tr>
 322 <tr>
 323 <td class="function_type">
 324 <span class="returnvalue">void</span> *
 325 </td>
 326 <td class="function_name">
 327 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-user-data" title="hb_buffer_get_user_data ()">hb_buffer_get_user_data</a> <span class="c_punctuation">()</span>
 328 </td>
 329 </tr>
 330 <tr>
 331 <td class="function_type">
 332 <a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-t"><span class="returnvalue">hb_glyph_info_t</span></a> *
 333 </td>
 334 <td class="function_name">
 335 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-glyph-infos" title="hb_buffer_get_glyph_infos ()">hb_buffer_get_glyph_infos</a> <span class="c_punctuation">()</span>
 336 </td>
 337 </tr>
 338 <tr>
 339 <td class="function_type">
 340 <a class="link" href="harfbuzz-Buffers.html#hb-glyph-position-t"><span class="returnvalue">hb_glyph_position_t</span></a> *
 341 </td>
 342 <td class="function_name">
 343 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-glyph-positions" title="hb_buffer_get_glyph_positions ()">hb_buffer_get_glyph_positions</a> <span class="c_punctuation">()</span>
 344 </td>
 345 </tr>
 346 <tr>
 347 <td class="function_type">
 348 <span class="returnvalue">void</span>
 349 </td>
 350 <td class="function_name">
 351 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-replacement-codepoint" title="hb_buffer_set_replacement_codepoint ()">hb_buffer_set_replacement_codepoint</a> <span class="c_punctuation">()</span>
 352 </td>
 353 </tr>
 354 <tr>
 355 <td class="function_type">
 356 <a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="returnvalue">hb_codepoint_t</span></a>
 357 </td>
 358 <td class="function_name">
 359 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-replacement-codepoint" title="hb_buffer_get_replacement_codepoint ()">hb_buffer_get_replacement_codepoint</a> <span class="c_punctuation">()</span>
 360 </td>
 361 </tr>
 362 <tr>
 363 <td class="function_type">
 364 <span class="returnvalue">void</span>
 365 </td>
 366 <td class="function_name">
 367 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-normalize-glyphs" title="hb_buffer_normalize_glyphs ()">hb_buffer_normalize_glyphs</a> <span class="c_punctuation">()</span>
 368 </td>
 369 </tr>
 370 <tr>
 371 <td class="function_type">
 372 <span class="returnvalue">void</span>
 373 </td>
 374 <td class="function_name">
 375 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-reverse" title="hb_buffer_reverse ()">hb_buffer_reverse</a> <span class="c_punctuation">()</span>
 376 </td>
 377 </tr>
 378 <tr>
 379 <td class="function_type">
 380 <span class="returnvalue">void</span>
 381 </td>
 382 <td class="function_name">
 383 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-reverse-range" title="hb_buffer_reverse_range ()">hb_buffer_reverse_range</a> <span class="c_punctuation">()</span>
 384 </td>
 385 </tr>
 386 <tr>
 387 <td class="function_type">
 388 <span class="returnvalue">void</span>
 389 </td>
 390 <td class="function_name">
 391 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-reverse-clusters" title="hb_buffer_reverse_clusters ()">hb_buffer_reverse_clusters</a> <span class="c_punctuation">()</span>
 392 </td>
 393 </tr>
 394 <tr>
 395 <td class="function_type">unsigned <span class="returnvalue">int</span>
 396 </td>
 397 <td class="function_name">
 398 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-glyphs" title="hb_buffer_serialize_glyphs ()">hb_buffer_serialize_glyphs</a> <span class="c_punctuation">()</span>
 399 </td>
 400 </tr>
 401 <tr>
 402 <td class="function_type">
 403 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
 404 </td>
 405 <td class="function_name">
 406 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-deserialize-glyphs" title="hb_buffer_deserialize_glyphs ()">hb_buffer_deserialize_glyphs</a> <span class="c_punctuation">()</span>
 407 </td>
 408 </tr>
 409 <tr>
 410 <td class="function_type">
 411 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t"><span class="returnvalue">hb_buffer_serialize_format_t</span></a>
 412 </td>
 413 <td class="function_name">
 414 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-from-string" title="hb_buffer_serialize_format_from_string ()">hb_buffer_serialize_format_from_string</a> <span class="c_punctuation">()</span>
 415 </td>
 416 </tr>
 417 <tr>
 418 <td class="function_type">const <span class="returnvalue">char</span> *
 419 </td>
 420 <td class="function_name">
 421 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-to-string" title="hb_buffer_serialize_format_to_string ()">hb_buffer_serialize_format_to_string</a> <span class="c_punctuation">()</span>
 422 </td>
 423 </tr>
 424 <tr>
 425 <td class="function_type">const <span class="returnvalue">char</span> **
 426 </td>
 427 <td class="function_name">
 428 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-list-formats" title="hb_buffer_serialize_list_formats ()">hb_buffer_serialize_list_formats</a> <span class="c_punctuation">()</span>
 429 </td>
 430 </tr>
 431 <tr>
 432 <td class="function_type">
 433 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
 434 </td>
 435 <td class="function_name">
 436 <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-equal" title="hb_segment_properties_equal ()">hb_segment_properties_equal</a> <span class="c_punctuation">()</span>
 437 </td>
 438 </tr>
 439 <tr>
 440 <td class="function_type">unsigned <span class="returnvalue">int</span>
 441 </td>
 442 <td class="function_name">
 443 <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-hash" title="hb_segment_properties_hash ()">hb_segment_properties_hash</a> <span class="c_punctuation">()</span>
 444 </td>
 445 </tr>
 446 <tr>
 447 <td class="function_type">
 448 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-diff-flags-t" title="enum hb_buffer_diff_flags_t"><span class="returnvalue">hb_buffer_diff_flags_t</span></a>
 449 </td>
 450 <td class="function_name">
 451 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-diff" title="hb_buffer_diff ()">hb_buffer_diff</a> <span class="c_punctuation">()</span>
 452 </td>
 453 </tr>
 454 <tr>
 455 <td class="function_type">
 456 <span class="returnvalue">void</span>
 457 </td>
 458 <td class="function_name">
 459 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-message-func" title="hb_buffer_set_message_func ()">hb_buffer_set_message_func</a> <span class="c_punctuation">()</span>
 460 </td>
 461 </tr>
 462 <tr>
 463 <td class="function_type">
 464 <a class="link" href="harfbuzz-Buffers.html#hb-glyph-flags-t" title="enum hb_glyph_flags_t"><span class="returnvalue">hb_glyph_flags_t</span></a>
 465 </td>
 466 <td class="function_name">
 467 <a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-get-glyph-flags" title="hb_glyph_info_get_glyph_flags ()">hb_glyph_info_get_glyph_flags</a> <span class="c_punctuation">()</span>
 468 </td>
 469 </tr>
 470 <tr>
 471 <td class="function_type">
 472 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
 473 </td>
 474 <td class="function_name">
 475 <span class="c_punctuation">(</span><a class="link" href="harfbuzz-Buffers.html#hb-buffer-message-func-t" title="hb_buffer_message_func_t ()">*hb_buffer_message_func_t</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
 476 </td>
 477 </tr>
 478 </tbody>
 479 </table></div>
 480 </div>
 481 <a name="hb-buffer-t"></a><a name="hb-glyph-info-t"></a><a name="hb-glyph-position-t"></a><a name="hb-segment-properties-t"></a><div class="refsect1">
 482 <a name="harfbuzz-Buffers.other"></a><h2>Types and Values</h2>
 483 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 484 <colgroup>
 485 <col width="150px" class="name">
 486 <col class="description">
 487 </colgroup>
 488 <tbody>
 489 <tr>
 490 <td class="define_keyword">#define</td>
 491 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#HB-SEGMENT-PROPERTIES-DEFAULT:CAPS" title="HB_SEGMENT_PROPERTIES_DEFAULT">HB_SEGMENT_PROPERTIES_DEFAULT</a></td>
 492 </tr>
 493 <tr>
 494 <td class="define_keyword">#define</td>
 495 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#HB-BUFFER-REPLACEMENT-CODEPOINT-DEFAULT:CAPS" title="HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT">HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT</a></td>
 496 </tr>
 497 <tr>
 498 <td class="typedef_keyword">typedef</td>
 499 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t">hb_buffer_t</a></td>
 500 </tr>
 501 <tr>
 502 <td class="datatype_keyword"> </td>
 503 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-t-struct" title="hb_glyph_info_t">hb_glyph_info_t</a></td>
 504 </tr>
 505 <tr>
 506 <td class="datatype_keyword">enum</td>
 507 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-glyph-flags-t" title="enum hb_glyph_flags_t">hb_glyph_flags_t</a></td>
 508 </tr>
 509 <tr>
 510 <td class="datatype_keyword"> </td>
 511 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-glyph-position-t-struct" title="hb_glyph_position_t">hb_glyph_position_t</a></td>
 512 </tr>
 513 <tr>
 514 <td class="datatype_keyword">enum</td>
 515 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-content-type-t" title="enum hb_buffer_content_type_t">hb_buffer_content_type_t</a></td>
 516 </tr>
 517 <tr>
 518 <td class="datatype_keyword">enum</td>
 519 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-flags-t" title="enum hb_buffer_flags_t">hb_buffer_flags_t</a></td>
 520 </tr>
 521 <tr>
 522 <td class="datatype_keyword">enum</td>
 523 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-cluster-level-t" title="enum hb_buffer_cluster_level_t">hb_buffer_cluster_level_t</a></td>
 524 </tr>
 525 <tr>
 526 <td class="datatype_keyword"> </td>
 527 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t-struct" title="hb_segment_properties_t">hb_segment_properties_t</a></td>
 528 </tr>
 529 <tr>
 530 <td class="datatype_keyword">enum</td>
 531 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t">hb_buffer_serialize_format_t</a></td>
 532 </tr>
 533 <tr>
 534 <td class="datatype_keyword">enum</td>
 535 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-flags-t" title="enum hb_buffer_serialize_flags_t">hb_buffer_serialize_flags_t</a></td>
 536 </tr>
 537 <tr>
 538 <td class="datatype_keyword">enum</td>
 539 <td class="function_name"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-diff-flags-t" title="enum hb_buffer_diff_flags_t">hb_buffer_diff_flags_t</a></td>
 540 </tr>
 541 </tbody>
 542 </table></div>
 543 </div>
 544 <div class="refsect1">
 545 <a name="harfbuzz-Buffers.object-hierarchy"></a><h2>Object Hierarchy</h2>
 546 <pre class="screen">    <a href="/home/behdad/.local/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a>
 547     <span class="lineart">├──</span> hb_buffer_t
 548     <span class="lineart">├──</span> hb_glyph_info_t
 549     <span class="lineart">├──</span> hb_glyph_position_t
 550     <span class="lineart">╰──</span> hb_segment_properties_t
 551     <a href="/home/behdad/.local/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a>
 552     <span class="lineart">├──</span> hb_buffer_cluster_level_t
 553     <span class="lineart">├──</span> hb_buffer_content_type_t
 554     <span class="lineart">╰──</span> hb_buffer_serialize_format_t
 555     <a href="/home/behdad/.local/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a>
 556     <span class="lineart">├──</span> hb_buffer_diff_flags_t
 557     <span class="lineart">├──</span> hb_buffer_flags_t
 558     <span class="lineart">├──</span> hb_buffer_serialize_flags_t
 559     <span class="lineart">╰──</span> hb_glyph_flags_t
 560 </pre>
 561 </div>
 562 <div class="refsect1">
 563 <a name="harfbuzz-Buffers.includes"></a><h2>Includes</h2>
 564 <pre class="synopsis">#include &lt;hb.h&gt;
 565 </pre>
 566 </div>
 567 <div class="refsect1">
 568 <a name="harfbuzz-Buffers.description"></a><h2>Description</h2>
 569 <p>Buffers serve dual role in HarfBuzz; they hold the input characters that are
 570 passed <a class="link" href="harfbuzz-Shaping.html#hb-shape" title="hb_shape ()"><code class="function">hb_shape()</code></a>, and after shaping they hold the output glyphs.</p>
 571 </div>
 572 <div class="refsect1">
 573 <a name="harfbuzz-Buffers.functions_details"></a><h2>Functions</h2>
 574 <div class="refsect2">
 575 <a name="hb-buffer-create"></a><h3>hb_buffer_create ()</h3>
 576 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="returnvalue">hb_buffer_t</span></a> *
 577 hb_buffer_create (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 578 <p>Creates a new <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> with all properties to defaults.</p>
 579 <p><span class="annotation">[Xconstructor]</span></p>
 580 <div class="refsect3">
 581 <a name="hb-buffer-create.returns"></a><h4>Returns</h4>
 582 <p>A newly allocated <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> with a reference count of 1. The initial
 583 reference count should be released with <a class="link" href="harfbuzz-Buffers.html#hb-buffer-destroy" title="hb_buffer_destroy ()"><code class="function">hb_buffer_destroy()</code></a> when you are done
 584 using the <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>. This function never returns <code class="literal">NULL</code>. If memory cannot
 585 be allocated, a special <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> object will be returned on which
 586 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-allocation-successful" title="hb_buffer_allocation_successful ()"><code class="function">hb_buffer_allocation_successful()</code></a> returns <code class="literal">false</code>. </p>
 587 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 588 </div>
 589 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 590 </div>
 591 <hr>
 592 <div class="refsect2">
 593 <a name="hb-buffer-reference"></a><h3>hb_buffer_reference ()</h3>
 594 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="returnvalue">hb_buffer_t</span></a> *
 595 hb_buffer_reference (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
 596 <p>Increases the reference count on <em class="parameter"><code>buffer</code></em>
 597  by one. This prevents <em class="parameter"><code>buffer</code></em>
 598  from
 599 being destroyed until a matching call to <a class="link" href="harfbuzz-Buffers.html#hb-buffer-destroy" title="hb_buffer_destroy ()"><code class="function">hb_buffer_destroy()</code></a> is made.</p>
 600 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 601 <div class="refsect3">
 602 <a name="hb-buffer-reference.parameters"></a><h4>Parameters</h4>
 603 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 604 <colgroup>
 605 <col width="150px" class="parameters_name">
 606 <col class="parameters_description">
 607 <col width="200px" class="parameters_annotations">
 608 </colgroup>
 609 <tbody><tr>
 610 <td class="parameter_name"><p>buffer</p></td>
 611 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
 612 <td class="parameter_annotations"> </td>
 613 </tr></tbody>
 614 </table></div>
 615 </div>
 616 <div class="refsect3">
 617 <a name="hb-buffer-reference.returns"></a><h4>Returns</h4>
 618 <p>The referenced <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>. </p>
 619 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 620 </div>
 621 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 622 </div>
 623 <hr>
 624 <div class="refsect2">
 625 <a name="hb-buffer-get-empty"></a><h3>hb_buffer_get_empty ()</h3>
 626 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="returnvalue">hb_buffer_t</span></a> *
 627 hb_buffer_get_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 628 <div class="refsect3">
 629 <a name="hb-buffer-get-empty.returns"></a><h4>Returns</h4>
 630 <p>. </p>
 631 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 632 </div>
 633 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 634 </div>
 635 <hr>
 636 <div class="refsect2">
 637 <a name="hb-buffer-destroy"></a><h3>hb_buffer_destroy ()</h3>
 638 <pre class="programlisting"><span class="returnvalue">void</span>
 639 hb_buffer_destroy (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
 640 <p>Deallocate the <em class="parameter"><code>buffer</code></em>
 641 .
 642 Decreases the reference count on <em class="parameter"><code>buffer</code></em>
 643  by one. If the result is zero, then
 644 <em class="parameter"><code>buffer</code></em>
 645  and all associated resources are freed. See <a class="link" href="harfbuzz-Buffers.html#hb-buffer-reference" title="hb_buffer_reference ()"><code class="function">hb_buffer_reference()</code></a>.</p>
 646 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
 647 <div class="refsect3">
 648 <a name="hb-buffer-destroy.parameters"></a><h4>Parameters</h4>
 649 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 650 <colgroup>
 651 <col width="150px" class="parameters_name">
 652 <col class="parameters_description">
 653 <col width="200px" class="parameters_annotations">
 654 </colgroup>
 655 <tbody><tr>
 656 <td class="parameter_name"><p>buffer</p></td>
 657 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
 658 <td class="parameter_annotations"> </td>
 659 </tr></tbody>
 660 </table></div>
 661 </div>
 662 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 663 </div>
 664 <hr>
 665 <div class="refsect2">
 666 <a name="hb-buffer-reset"></a><h3>hb_buffer_reset ()</h3>
 667 <pre class="programlisting"><span class="returnvalue">void</span>
 668 hb_buffer_reset (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
 669 <p>Resets the buffer to its initial status, as if it was just newly created
 670 with <a class="link" href="harfbuzz-Buffers.html#hb-buffer-create" title="hb_buffer_create ()"><code class="function">hb_buffer_create()</code></a>.</p>
 671 <div class="refsect3">
 672 <a name="hb-buffer-reset.parameters"></a><h4>Parameters</h4>
 673 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 674 <colgroup>
 675 <col width="150px" class="parameters_name">
 676 <col class="parameters_description">
 677 <col width="200px" class="parameters_annotations">
 678 </colgroup>
 679 <tbody><tr>
 680 <td class="parameter_name"><p>buffer</p></td>
 681 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
 682 <td class="parameter_annotations"> </td>
 683 </tr></tbody>
 684 </table></div>
 685 </div>
 686 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 687 </div>
 688 <hr>
 689 <div class="refsect2">
 690 <a name="hb-buffer-clear-contents"></a><h3>hb_buffer_clear_contents ()</h3>
 691 <pre class="programlisting"><span class="returnvalue">void</span>
 692 hb_buffer_clear_contents (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
 693 <p>Similar to <a class="link" href="harfbuzz-Buffers.html#hb-buffer-reset" title="hb_buffer_reset ()"><code class="function">hb_buffer_reset()</code></a>, but does not clear the Unicode functions and
 694 the replacement code point.</p>
 695 <div class="refsect3">
 696 <a name="hb-buffer-clear-contents.parameters"></a><h4>Parameters</h4>
 697 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 698 <colgroup>
 699 <col width="150px" class="parameters_name">
 700 <col class="parameters_description">
 701 <col width="200px" class="parameters_annotations">
 702 </colgroup>
 703 <tbody><tr>
 704 <td class="parameter_name"><p>buffer</p></td>
 705 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
 706 <td class="parameter_annotations"> </td>
 707 </tr></tbody>
 708 </table></div>
 709 </div>
 710 <p class="since">Since: <a class="link" href="api-index-0-9-11.html#api-index-0.9.11">0.9.11</a></p>
 711 </div>
 712 <hr>
 713 <div class="refsect2">
 714 <a name="hb-buffer-pre-allocate"></a><h3>hb_buffer_pre_allocate ()</h3>
 715 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
 716 hb_buffer_pre_allocate (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
 717                         <em class="parameter"><code>unsigned <span class="type">int</span> size</code></em>);</pre>
 718 <p>Pre allocates memory for <em class="parameter"><code>buffer</code></em>
 719  to fit at least <em class="parameter"><code>size</code></em>
 720  number of items.</p>
 721 <div class="refsect3">
 722 <a name="hb-buffer-pre-allocate.parameters"></a><h4>Parameters</h4>
 723 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 724 <colgroup>
 725 <col width="150px" class="parameters_name">
 726 <col class="parameters_description">
 727 <col width="200px" class="parameters_annotations">
 728 </colgroup>
 729 <tbody>
 730 <tr>
 731 <td class="parameter_name"><p>buffer</p></td>
 732 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
 733 <td class="parameter_annotations"> </td>
 734 </tr>
 735 <tr>
 736 <td class="parameter_name"><p>size</p></td>
 737 <td class="parameter_description"><p>number of items to pre allocate.</p></td>
 738 <td class="parameter_annotations"> </td>
 739 </tr>
 740 </tbody>
 741 </table></div>
 742 </div>
 743 <div class="refsect3">
 744 <a name="hb-buffer-pre-allocate.returns"></a><h4>Returns</h4>
 745 <p><code class="literal">true</code> if <em class="parameter"><code>buffer</code></em>
 746 memory allocation succeeded, <code class="literal">false</code> otherwise.</p>
 747 </div>
 748 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 749 </div>
 750 <hr>
 751 <div class="refsect2">
 752 <a name="hb-buffer-allocation-successful"></a><h3>hb_buffer_allocation_successful ()</h3>
 753 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
 754 hb_buffer_allocation_successful (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
 755 <p>Check if allocating memory for the buffer succeeded.</p>
 756 <div class="refsect3">
 757 <a name="hb-buffer-allocation-successful.parameters"></a><h4>Parameters</h4>
 758 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 759 <colgroup>
 760 <col width="150px" class="parameters_name">
 761 <col class="parameters_description">
 762 <col width="200px" class="parameters_annotations">
 763 </colgroup>
 764 <tbody><tr>
 765 <td class="parameter_name"><p>buffer</p></td>
 766 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
 767 <td class="parameter_annotations"> </td>
 768 </tr></tbody>
 769 </table></div>
 770 </div>
 771 <div class="refsect3">
 772 <a name="hb-buffer-allocation-successful.returns"></a><h4>Returns</h4>
 773 <p><code class="literal">true</code> if <em class="parameter"><code>buffer</code></em>
 774 memory allocation succeeded, <code class="literal">false</code> otherwise.</p>
 775 </div>
 776 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 777 </div>
 778 <hr>
 779 <div class="refsect2">
 780 <a name="hb-buffer-add"></a><h3>hb_buffer_add ()</h3>
 781 <pre class="programlisting"><span class="returnvalue">void</span>
 782 hb_buffer_add (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
 783                <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> codepoint</code></em>,
 784                <em class="parameter"><code>unsigned <span class="type">int</span> cluster</code></em>);</pre>
 785 <p>Appends a character with the Unicode value of <em class="parameter"><code>codepoint</code></em>
 786  to <em class="parameter"><code>buffer</code></em>
 787 , and
 788 gives it the initial cluster value of <em class="parameter"><code>cluster</code></em>
 789 . Clusters can be any thing
 790 the client wants, they are usually used to refer to the index of the
 791 character in the input text stream and are output in
 792 <span class="type">hb_glyph_info_t.cluster</span> field.</p>
 793 <p>This function does not check the validity of <em class="parameter"><code>codepoint</code></em>
 794 , it is up to the
 795 caller to ensure it is a valid Unicode code point.</p>
 796 <div class="refsect3">
 797 <a name="hb-buffer-add.parameters"></a><h4>Parameters</h4>
 798 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 799 <colgroup>
 800 <col width="150px" class="parameters_name">
 801 <col class="parameters_description">
 802 <col width="200px" class="parameters_annotations">
 803 </colgroup>
 804 <tbody>
 805 <tr>
 806 <td class="parameter_name"><p>buffer</p></td>
 807 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
 808 <td class="parameter_annotations"> </td>
 809 </tr>
 810 <tr>
 811 <td class="parameter_name"><p>codepoint</p></td>
 812 <td class="parameter_description"><p>a Unicode code point.</p></td>
 813 <td class="parameter_annotations"> </td>
 814 </tr>
 815 <tr>
 816 <td class="parameter_name"><p>cluster</p></td>
 817 <td class="parameter_description"><p>the cluster value of <em class="parameter"><code>codepoint</code></em>
 818 .</p></td>
 819 <td class="parameter_annotations"> </td>
 820 </tr>
 821 </tbody>
 822 </table></div>
 823 </div>
 824 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
 825 </div>
 826 <hr>
 827 <div class="refsect2">
 828 <a name="hb-buffer-add-codepoints"></a><h3>hb_buffer_add_codepoints ()</h3>
 829 <pre class="programlisting"><span class="returnvalue">void</span>
 830 hb_buffer_add_codepoints (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
 831                           <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> *text</code></em>,
 832                           <em class="parameter"><code><span class="type">int</span> text_length</code></em>,
 833                           <em class="parameter"><code>unsigned <span class="type">int</span> item_offset</code></em>,
 834                           <em class="parameter"><code><span class="type">int</span> item_length</code></em>);</pre>
 835 <p>Appends characters from <em class="parameter"><code>text</code></em>
 836  array to <em class="parameter"><code>buffer</code></em>
 837 . The <em class="parameter"><code>item_offset</code></em>
 838  is the
 839 position of the first character from <em class="parameter"><code>text</code></em>
 840  that will be appended, and
 841 <em class="parameter"><code>item_length</code></em>
 842  is the number of character. When shaping part of a larger text
 843 (e.g. a run of text from a paragraph), instead of passing just the substring
 844 corresponding to the run, it is preferable to pass the whole
 845 paragraph and specify the run start and length as <em class="parameter"><code>item_offset</code></em>
 846  and
 847 <em class="parameter"><code>item_length</code></em>
 848 , respectively, to give HarfBuzz the full context to be able,
 849 for example, to do cross-run Arabic shaping or properly handle combining
 850 marks at stat of run.</p>
 851 <p>This function does not check the validity of <em class="parameter"><code>text</code></em>
 852 , it is up to the caller
 853 to ensure it contains a valid Unicode code points.</p>
 854 <div class="refsect3">
 855 <a name="hb-buffer-add-codepoints.parameters"></a><h4>Parameters</h4>
 856 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 857 <colgroup>
 858 <col width="150px" class="parameters_name">
 859 <col class="parameters_description">
 860 <col width="200px" class="parameters_annotations">
 861 </colgroup>
 862 <tbody>
 863 <tr>
 864 <td class="parameter_name"><p>buffer</p></td>
 865 <td class="parameter_description"><p>a <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> to append characters to.</p></td>
 866 <td class="parameter_annotations"> </td>
 867 </tr>
 868 <tr>
 869 <td class="parameter_name"><p>text</p></td>
 870 <td class="parameter_description"><p>an array of Unicode code points to append. </p></td>
 871 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=text_length]</span></td>
 872 </tr>
 873 <tr>
 874 <td class="parameter_name"><p>text_length</p></td>
 875 <td class="parameter_description"><p>the length of the <em class="parameter"><code>text</code></em>
 876 , or -1 if it is <code class="literal">NULL</code> terminated.</p></td>
 877 <td class="parameter_annotations"> </td>
 878 </tr>
 879 <tr>
 880 <td class="parameter_name"><p>item_offset</p></td>
 881 <td class="parameter_description"><p>the offset of the first code point to add to the <em class="parameter"><code>buffer</code></em>
 882 .</p></td>
 883 <td class="parameter_annotations"> </td>
 884 </tr>
 885 <tr>
 886 <td class="parameter_name"><p>item_length</p></td>
 887 <td class="parameter_description"><p>the number of code points to add to the <em class="parameter"><code>buffer</code></em>
 888 , or -1 for the
 889 end of <em class="parameter"><code>text</code></em>
 890 (assuming it is <code class="literal">NULL</code> terminated).</p></td>
 891 <td class="parameter_annotations"> </td>
 892 </tr>
 893 </tbody>
 894 </table></div>
 895 </div>
 896 <p class="since">Since: <a class="link" href="api-index-0-9-31.html#api-index-0.9.31">0.9.31</a></p>
 897 </div>
 898 <hr>
 899 <div class="refsect2">
 900 <a name="hb-buffer-add-utf32"></a><h3>hb_buffer_add_utf32 ()</h3>
 901 <pre class="programlisting"><span class="returnvalue">void</span>
 902 hb_buffer_add_utf32 (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
 903                      <em class="parameter"><code>const <span class="type">uint32_t</span> *text</code></em>,
 904                      <em class="parameter"><code><span class="type">int</span> text_length</code></em>,
 905                      <em class="parameter"><code>unsigned <span class="type">int</span> item_offset</code></em>,
 906                      <em class="parameter"><code><span class="type">int</span> item_length</code></em>);</pre>
 907 <p>See <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add-codepoints" title="hb_buffer_add_codepoints ()"><code class="function">hb_buffer_add_codepoints()</code></a>.</p>
 908 <p>Replaces invalid UTF-32 characters with the <em class="parameter"><code>buffer</code></em>
 909  replacement code point,
 910 see <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-replacement-codepoint" title="hb_buffer_set_replacement_codepoint ()"><code class="function">hb_buffer_set_replacement_codepoint()</code></a>.</p>
 911 <div class="refsect3">
 912 <a name="hb-buffer-add-utf32.parameters"></a><h4>Parameters</h4>
 913 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 914 <colgroup>
 915 <col width="150px" class="parameters_name">
 916 <col class="parameters_description">
 917 <col width="200px" class="parameters_annotations">
 918 </colgroup>
 919 <tbody>
 920 <tr>
 921 <td class="parameter_name"><p>buffer</p></td>
 922 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
 923 <td class="parameter_annotations"> </td>
 924 </tr>
 925 <tr>
 926 <td class="parameter_name"><p>text</p></td>
 927 <td class="parameter_description"><p>an array of UTF-32 characters to append. </p></td>
 928 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=text_length]</span></td>
 929 </tr>
 930 <tr>
 931 <td class="parameter_name"><p>text_length</p></td>
 932 <td class="parameter_description"><p>the length of the <em class="parameter"><code>text</code></em>
 933 , or -1 if it is <code class="literal">NULL</code> terminated.</p></td>
 934 <td class="parameter_annotations"> </td>
 935 </tr>
 936 <tr>
 937 <td class="parameter_name"><p>item_offset</p></td>
 938 <td class="parameter_description"><p>the offset of the first character to add to the <em class="parameter"><code>buffer</code></em>
 939 .</p></td>
 940 <td class="parameter_annotations"> </td>
 941 </tr>
 942 <tr>
 943 <td class="parameter_name"><p>item_length</p></td>
 944 <td class="parameter_description"><p>the number of characters to add to the <em class="parameter"><code>buffer</code></em>
 945 , or -1 for the
 946 end of <em class="parameter"><code>text</code></em>
 947 (assuming it is <code class="literal">NULL</code> terminated).</p></td>
 948 <td class="parameter_annotations"> </td>
 949 </tr>
 950 </tbody>
 951 </table></div>
 952 </div>
 953 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 954 </div>
 955 <hr>
 956 <div class="refsect2">
 957 <a name="hb-buffer-add-utf16"></a><h3>hb_buffer_add_utf16 ()</h3>
 958 <pre class="programlisting"><span class="returnvalue">void</span>
 959 hb_buffer_add_utf16 (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
 960                      <em class="parameter"><code>const <span class="type">uint16_t</span> *text</code></em>,
 961                      <em class="parameter"><code><span class="type">int</span> text_length</code></em>,
 962                      <em class="parameter"><code>unsigned <span class="type">int</span> item_offset</code></em>,
 963                      <em class="parameter"><code><span class="type">int</span> item_length</code></em>);</pre>
 964 <p>See <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add-codepoints" title="hb_buffer_add_codepoints ()"><code class="function">hb_buffer_add_codepoints()</code></a>.</p>
 965 <p>Replaces invalid UTF-16 characters with the <em class="parameter"><code>buffer</code></em>
 966  replacement code point,
 967 see <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-replacement-codepoint" title="hb_buffer_set_replacement_codepoint ()"><code class="function">hb_buffer_set_replacement_codepoint()</code></a>.</p>
 968 <div class="refsect3">
 969 <a name="hb-buffer-add-utf16.parameters"></a><h4>Parameters</h4>
 970 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 971 <colgroup>
 972 <col width="150px" class="parameters_name">
 973 <col class="parameters_description">
 974 <col width="200px" class="parameters_annotations">
 975 </colgroup>
 976 <tbody>
 977 <tr>
 978 <td class="parameter_name"><p>buffer</p></td>
 979 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
 980 <td class="parameter_annotations"> </td>
 981 </tr>
 982 <tr>
 983 <td class="parameter_name"><p>text</p></td>
 984 <td class="parameter_description"><p>an array of UTF-16 characters to append. </p></td>
 985 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=text_length]</span></td>
 986 </tr>
 987 <tr>
 988 <td class="parameter_name"><p>text_length</p></td>
 989 <td class="parameter_description"><p>the length of the <em class="parameter"><code>text</code></em>
 990 , or -1 if it is <code class="literal">NULL</code> terminated.</p></td>
 991 <td class="parameter_annotations"> </td>
 992 </tr>
 993 <tr>
 994 <td class="parameter_name"><p>item_offset</p></td>
 995 <td class="parameter_description"><p>the offset of the first character to add to the <em class="parameter"><code>buffer</code></em>
 996 .</p></td>
 997 <td class="parameter_annotations"> </td>
 998 </tr>
 999 <tr>
1000 <td class="parameter_name"><p>item_length</p></td>
1001 <td class="parameter_description"><p>the number of characters to add to the <em class="parameter"><code>buffer</code></em>
1002 , or -1 for the
1003 end of <em class="parameter"><code>text</code></em>
1004 (assuming it is <code class="literal">NULL</code> terminated).</p></td>
1005 <td class="parameter_annotations"> </td>
1006 </tr>
1007 </tbody>
1008 </table></div>
1009 </div>
1010 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1011 </div>
1012 <hr>
1013 <div class="refsect2">
1014 <a name="hb-buffer-add-utf8"></a><h3>hb_buffer_add_utf8 ()</h3>
1015 <pre class="programlisting"><span class="returnvalue">void</span>
1016 hb_buffer_add_utf8 (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1017                     <em class="parameter"><code>const <span class="type">char</span> *text</code></em>,
1018                     <em class="parameter"><code><span class="type">int</span> text_length</code></em>,
1019                     <em class="parameter"><code>unsigned <span class="type">int</span> item_offset</code></em>,
1020                     <em class="parameter"><code><span class="type">int</span> item_length</code></em>);</pre>
1021 <p>See <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add-codepoints" title="hb_buffer_add_codepoints ()"><code class="function">hb_buffer_add_codepoints()</code></a>.</p>
1022 <p>Replaces invalid UTF-8 characters with the <em class="parameter"><code>buffer</code></em>
1023  replacement code point,
1024 see <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-replacement-codepoint" title="hb_buffer_set_replacement_codepoint ()"><code class="function">hb_buffer_set_replacement_codepoint()</code></a>.</p>
1025 <div class="refsect3">
1026 <a name="hb-buffer-add-utf8.parameters"></a><h4>Parameters</h4>
1027 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1028 <colgroup>
1029 <col width="150px" class="parameters_name">
1030 <col class="parameters_description">
1031 <col width="200px" class="parameters_annotations">
1032 </colgroup>
1033 <tbody>
1034 <tr>
1035 <td class="parameter_name"><p>buffer</p></td>
1036 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1037 <td class="parameter_annotations"> </td>
1038 </tr>
1039 <tr>
1040 <td class="parameter_name"><p>text</p></td>
1041 <td class="parameter_description"><p>an array of UTF-8
1042 characters to append. </p></td>
1043 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=text_length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint8_t]</span></td>
1044 </tr>
1045 <tr>
1046 <td class="parameter_name"><p>text_length</p></td>
1047 <td class="parameter_description"><p>the length of the <em class="parameter"><code>text</code></em>
1048 , or -1 if it is <code class="literal">NULL</code> terminated.</p></td>
1049 <td class="parameter_annotations"> </td>
1050 </tr>
1051 <tr>
1052 <td class="parameter_name"><p>item_offset</p></td>
1053 <td class="parameter_description"><p>the offset of the first character to add to the <em class="parameter"><code>buffer</code></em>
1054 .</p></td>
1055 <td class="parameter_annotations"> </td>
1056 </tr>
1057 <tr>
1058 <td class="parameter_name"><p>item_length</p></td>
1059 <td class="parameter_description"><p>the number of characters to add to the <em class="parameter"><code>buffer</code></em>
1060 , or -1 for the
1061 end of <em class="parameter"><code>text</code></em>
1062 (assuming it is <code class="literal">NULL</code> terminated).</p></td>
1063 <td class="parameter_annotations"> </td>
1064 </tr>
1065 </tbody>
1066 </table></div>
1067 </div>
1068 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1069 </div>
1070 <hr>
1071 <div class="refsect2">
1072 <a name="hb-buffer-add-latin1"></a><h3>hb_buffer_add_latin1 ()</h3>
1073 <pre class="programlisting"><span class="returnvalue">void</span>
1074 hb_buffer_add_latin1 (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1075                       <em class="parameter"><code>const <span class="type">uint8_t</span> *text</code></em>,
1076                       <em class="parameter"><code><span class="type">int</span> text_length</code></em>,
1077                       <em class="parameter"><code>unsigned <span class="type">int</span> item_offset</code></em>,
1078                       <em class="parameter"><code><span class="type">int</span> item_length</code></em>);</pre>
1079 <p>Similar to <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add-codepoints" title="hb_buffer_add_codepoints ()"><code class="function">hb_buffer_add_codepoints()</code></a>, but allows only access to first 256
1080 Unicode code points that can fit in 8-bit strings.</p>
1081 <div class="note">Has nothing to do with non-Unicode Latin-1 encoding.</div>
1082 <div class="refsect3">
1083 <a name="hb-buffer-add-latin1.parameters"></a><h4>Parameters</h4>
1084 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1085 <colgroup>
1086 <col width="150px" class="parameters_name">
1087 <col class="parameters_description">
1088 <col width="200px" class="parameters_annotations">
1089 </colgroup>
1090 <tbody>
1091 <tr>
1092 <td class="parameter_name"><p>buffer</p></td>
1093 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1094 <td class="parameter_annotations"> </td>
1095 </tr>
1096 <tr>
1097 <td class="parameter_name"><p>text</p></td>
1098 <td class="parameter_description"><p>an array of UTF-8
1099 characters to append. </p></td>
1100 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=text_length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint8_t]</span></td>
1101 </tr>
1102 <tr>
1103 <td class="parameter_name"><p>text_length</p></td>
1104 <td class="parameter_description"><p>the length of the <em class="parameter"><code>text</code></em>
1105 , or -1 if it is <code class="literal">NULL</code> terminated.</p></td>
1106 <td class="parameter_annotations"> </td>
1107 </tr>
1108 <tr>
1109 <td class="parameter_name"><p>item_offset</p></td>
1110 <td class="parameter_description"><p>the offset of the first character to add to the <em class="parameter"><code>buffer</code></em>
1111 .</p></td>
1112 <td class="parameter_annotations"> </td>
1113 </tr>
1114 <tr>
1115 <td class="parameter_name"><p>item_length</p></td>
1116 <td class="parameter_description"><p>the number of characters to add to the <em class="parameter"><code>buffer</code></em>
1117 , or -1 for the
1118 end of <em class="parameter"><code>text</code></em>
1119 (assuming it is <code class="literal">NULL</code> terminated).</p></td>
1120 <td class="parameter_annotations"> </td>
1121 </tr>
1122 </tbody>
1123 </table></div>
1124 </div>
1125 <p class="since">Since: <a class="link" href="api-index-0-9-39.html#api-index-0.9.39">0.9.39</a></p>
1126 </div>
1127 <hr>
1128 <div class="refsect2">
1129 <a name="hb-buffer-append"></a><h3>hb_buffer_append ()</h3>
1130 <pre class="programlisting"><span class="returnvalue">void</span>
1131 hb_buffer_append (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1132                   <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *source</code></em>,
1133                   <em class="parameter"><code>unsigned <span class="type">int</span> start</code></em>,
1134                   <em class="parameter"><code>unsigned <span class="type">int</span> end</code></em>);</pre>
1135 <p>Append (part of) contents of another buffer to this buffer.</p>
1136 <div class="refsect3">
1137 <a name="hb-buffer-append.parameters"></a><h4>Parameters</h4>
1138 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1139 <colgroup>
1140 <col width="150px" class="parameters_name">
1141 <col class="parameters_description">
1142 <col width="200px" class="parameters_annotations">
1143 </colgroup>
1144 <tbody>
1145 <tr>
1146 <td class="parameter_name"><p>buffer</p></td>
1147 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1148 <td class="parameter_annotations"> </td>
1149 </tr>
1150 <tr>
1151 <td class="parameter_name"><p>source</p></td>
1152 <td class="parameter_description"><p>source <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1153 <td class="parameter_annotations"> </td>
1154 </tr>
1155 <tr>
1156 <td class="parameter_name"><p>start</p></td>
1157 <td class="parameter_description"><p>start index into source buffer to copy.  Use 0 to copy from start of buffer.</p></td>
1158 <td class="parameter_annotations"> </td>
1159 </tr>
1160 <tr>
1161 <td class="parameter_name"><p>end</p></td>
1162 <td class="parameter_description"><p>end index into source buffer to copy.  Use (unsigned int) -1 to copy to end of buffer.</p></td>
1163 <td class="parameter_annotations"> </td>
1164 </tr>
1165 </tbody>
1166 </table></div>
1167 </div>
1168 <p class="since">Since: <a class="link" href="api-index-1-5-0.html#api-index-1.5.0">1.5.0</a></p>
1169 </div>
1170 <hr>
1171 <div class="refsect2">
1172 <a name="hb-buffer-set-content-type"></a><h3>hb_buffer_set_content_type ()</h3>
1173 <pre class="programlisting"><span class="returnvalue">void</span>
1174 hb_buffer_set_content_type (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1175                             <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-content-type-t" title="enum hb_buffer_content_type_t"><span class="type">hb_buffer_content_type_t</span></a> content_type</code></em>);</pre>
1176 <p>Sets the type of <em class="parameter"><code>buffer</code></em>
1177  contents, buffers are either empty, contain
1178 characters (before shaping) or glyphs (the result of shaping).</p>
1179 <div class="refsect3">
1180 <a name="hb-buffer-set-content-type.parameters"></a><h4>Parameters</h4>
1181 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1182 <colgroup>
1183 <col width="150px" class="parameters_name">
1184 <col class="parameters_description">
1185 <col width="200px" class="parameters_annotations">
1186 </colgroup>
1187 <tbody>
1188 <tr>
1189 <td class="parameter_name"><p>buffer</p></td>
1190 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1191 <td class="parameter_annotations"> </td>
1192 </tr>
1193 <tr>
1194 <td class="parameter_name"><p>content_type</p></td>
1195 <td class="parameter_description"><p>the type of buffer contents to set</p></td>
1196 <td class="parameter_annotations"> </td>
1197 </tr>
1198 </tbody>
1199 </table></div>
1200 </div>
1201 <p class="since">Since: <a class="link" href="api-index-0-9-5.html#api-index-0.9.5">0.9.5</a></p>
1202 </div>
1203 <hr>
1204 <div class="refsect2">
1205 <a name="hb-buffer-get-content-type"></a><h3>hb_buffer_get_content_type ()</h3>
1206 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-content-type-t" title="enum hb_buffer_content_type_t"><span class="returnvalue">hb_buffer_content_type_t</span></a>
1207 hb_buffer_get_content_type (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1208 <p>see <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-content-type" title="hb_buffer_set_content_type ()"><code class="function">hb_buffer_set_content_type()</code></a>.</p>
1209 <div class="refsect3">
1210 <a name="hb-buffer-get-content-type.parameters"></a><h4>Parameters</h4>
1211 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1212 <colgroup>
1213 <col width="150px" class="parameters_name">
1214 <col class="parameters_description">
1215 <col width="200px" class="parameters_annotations">
1216 </colgroup>
1217 <tbody><tr>
1218 <td class="parameter_name"><p>buffer</p></td>
1219 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1220 <td class="parameter_annotations"> </td>
1221 </tr></tbody>
1222 </table></div>
1223 </div>
1224 <div class="refsect3">
1225 <a name="hb-buffer-get-content-type.returns"></a><h4>Returns</h4>
1226 <p>The type of <em class="parameter"><code>buffer</code></em>
1227 contents.</p>
1228 </div>
1229 <p class="since">Since: <a class="link" href="api-index-0-9-5.html#api-index-0.9.5">0.9.5</a></p>
1230 </div>
1231 <hr>
1232 <div class="refsect2">
1233 <a name="hb-buffer-set-direction"></a><h3>hb_buffer_set_direction ()</h3>
1234 <pre class="programlisting"><span class="returnvalue">void</span>
1235 hb_buffer_set_direction (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1236                          <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="type">hb_direction_t</span></a> direction</code></em>);</pre>
1237 <p>Set the text flow direction of the buffer. No shaping can happen without
1238 setting <em class="parameter"><code>buffer</code></em>
1239  direction, and it controls the visual direction for the
1240 output glyphs; for RTL direction the glyphs will be reversed. Many layout
1241 features depend on the proper setting of the direction, for example,
1242 reversing RTL text before shaping, then shaping with LTR direction is not
1243 the same as keeping the text in logical order and shaping with RTL
1244 direction.</p>
1245 <div class="refsect3">
1246 <a name="hb-buffer-set-direction.parameters"></a><h4>Parameters</h4>
1247 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1248 <colgroup>
1249 <col width="150px" class="parameters_name">
1250 <col class="parameters_description">
1251 <col width="200px" class="parameters_annotations">
1252 </colgroup>
1253 <tbody>
1254 <tr>
1255 <td class="parameter_name"><p>buffer</p></td>
1256 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1257 <td class="parameter_annotations"> </td>
1258 </tr>
1259 <tr>
1260 <td class="parameter_name"><p>direction</p></td>
1261 <td class="parameter_description"><p>the <a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="type">hb_direction_t</span></a> of the <em class="parameter"><code>buffer</code></em>
1262 </p></td>
1263 <td class="parameter_annotations"> </td>
1264 </tr>
1265 </tbody>
1266 </table></div>
1267 </div>
1268 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1269 </div>
1270 <hr>
1271 <div class="refsect2">
1272 <a name="hb-buffer-get-direction"></a><h3>hb_buffer_get_direction ()</h3>
1273 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="returnvalue">hb_direction_t</span></a>
1274 hb_buffer_get_direction (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1275 <p>See <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-direction" title="hb_buffer_set_direction ()"><code class="function">hb_buffer_set_direction()</code></a></p>
1276 <div class="refsect3">
1277 <a name="hb-buffer-get-direction.parameters"></a><h4>Parameters</h4>
1278 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1279 <colgroup>
1280 <col width="150px" class="parameters_name">
1281 <col class="parameters_description">
1282 <col width="200px" class="parameters_annotations">
1283 </colgroup>
1284 <tbody><tr>
1285 <td class="parameter_name"><p>buffer</p></td>
1286 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1287 <td class="parameter_annotations"> </td>
1288 </tr></tbody>
1289 </table></div>
1290 </div>
1291 <div class="refsect3">
1292 <a name="hb-buffer-get-direction.returns"></a><h4>Returns</h4>
1293 <p>The direction of the <em class="parameter"><code>buffer</code></em>
1294 .</p>
1295 </div>
1296 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1297 </div>
1298 <hr>
1299 <div class="refsect2">
1300 <a name="hb-buffer-set-script"></a><h3>hb_buffer_set_script ()</h3>
1301 <pre class="programlisting"><span class="returnvalue">void</span>
1302 hb_buffer_set_script (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1303                       <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> script</code></em>);</pre>
1304 <p>Sets the script of <em class="parameter"><code>buffer</code></em>
1305  to <em class="parameter"><code>script</code></em>
1306 .</p>
1307 <p>Script is crucial for choosing the proper shaping behaviour for scripts that
1308 require it (e.g. Arabic) and the which OpenType features defined in the font
1309 to be applied.</p>
1310 <p>You can pass one of the predefined <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> values, or use
1311 <a class="link" href="harfbuzz-hb-common.html#hb-script-from-string" title="hb_script_from_string ()"><code class="function">hb_script_from_string()</code></a> or <a class="link" href="harfbuzz-hb-common.html#hb-script-from-iso15924-tag" title="hb_script_from_iso15924_tag ()"><code class="function">hb_script_from_iso15924_tag()</code></a> to get the
1312 corresponding script from an ISO 15924 script tag.</p>
1313 <div class="refsect3">
1314 <a name="hb-buffer-set-script.parameters"></a><h4>Parameters</h4>
1315 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1316 <colgroup>
1317 <col width="150px" class="parameters_name">
1318 <col class="parameters_description">
1319 <col width="200px" class="parameters_annotations">
1320 </colgroup>
1321 <tbody>
1322 <tr>
1323 <td class="parameter_name"><p>buffer</p></td>
1324 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1325 <td class="parameter_annotations"> </td>
1326 </tr>
1327 <tr>
1328 <td class="parameter_name"><p>script</p></td>
1329 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> to set.</p></td>
1330 <td class="parameter_annotations"> </td>
1331 </tr>
1332 </tbody>
1333 </table></div>
1334 </div>
1335 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1336 </div>
1337 <hr>
1338 <div class="refsect2">
1339 <a name="hb-buffer-get-script"></a><h3>hb_buffer_get_script ()</h3>
1340 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="returnvalue">hb_script_t</span></a>
1341 hb_buffer_get_script (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1342 <p>See <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-script" title="hb_buffer_set_script ()"><code class="function">hb_buffer_set_script()</code></a>.</p>
1343 <div class="refsect3">
1344 <a name="hb-buffer-get-script.parameters"></a><h4>Parameters</h4>
1345 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1346 <colgroup>
1347 <col width="150px" class="parameters_name">
1348 <col class="parameters_description">
1349 <col width="200px" class="parameters_annotations">
1350 </colgroup>
1351 <tbody><tr>
1352 <td class="parameter_name"><p>buffer</p></td>
1353 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1354 <td class="parameter_annotations"> </td>
1355 </tr></tbody>
1356 </table></div>
1357 </div>
1358 <div class="refsect3">
1359 <a name="hb-buffer-get-script.returns"></a><h4>Returns</h4>
1360 <p>The <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> of the <em class="parameter"><code>buffer</code></em>
1361 .</p>
1362 </div>
1363 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1364 </div>
1365 <hr>
1366 <div class="refsect2">
1367 <a name="hb-buffer-set-language"></a><h3>hb_buffer_set_language ()</h3>
1368 <pre class="programlisting"><span class="returnvalue">void</span>
1369 hb_buffer_set_language (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1370                         <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="type">hb_language_t</span></a> language</code></em>);</pre>
1371 <p>Sets the language of <em class="parameter"><code>buffer</code></em>
1372  to <em class="parameter"><code>language</code></em>
1373 .</p>
1374 <p>Languages are crucial for selecting which OpenType feature to apply to the
1375 buffer which can result in applying language-specific behaviour. Languages
1376 are orthogonal to the scripts, and though they are related, they are
1377 different concepts and should not be confused with each other.</p>
1378 <p>Use <a class="link" href="harfbuzz-hb-common.html#hb-language-from-string" title="hb_language_from_string ()"><code class="function">hb_language_from_string()</code></a> to convert from ISO 639 language codes to
1379 <a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="type">hb_language_t</span></a>.</p>
1380 <div class="refsect3">
1381 <a name="hb-buffer-set-language.parameters"></a><h4>Parameters</h4>
1382 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1383 <colgroup>
1384 <col width="150px" class="parameters_name">
1385 <col class="parameters_description">
1386 <col width="200px" class="parameters_annotations">
1387 </colgroup>
1388 <tbody>
1389 <tr>
1390 <td class="parameter_name"><p>buffer</p></td>
1391 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1392 <td class="parameter_annotations"> </td>
1393 </tr>
1394 <tr>
1395 <td class="parameter_name"><p>language</p></td>
1396 <td class="parameter_description"><p>an hb_language_t to set.</p></td>
1397 <td class="parameter_annotations"> </td>
1398 </tr>
1399 </tbody>
1400 </table></div>
1401 </div>
1402 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1403 </div>
1404 <hr>
1405 <div class="refsect2">
1406 <a name="hb-buffer-get-language"></a><h3>hb_buffer_get_language ()</h3>
1407 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="returnvalue">hb_language_t</span></a>
1408 hb_buffer_get_language (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1409 <p>See <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-language" title="hb_buffer_set_language ()"><code class="function">hb_buffer_set_language()</code></a>.</p>
1410 <div class="refsect3">
1411 <a name="hb-buffer-get-language.parameters"></a><h4>Parameters</h4>
1412 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1413 <colgroup>
1414 <col width="150px" class="parameters_name">
1415 <col class="parameters_description">
1416 <col width="200px" class="parameters_annotations">
1417 </colgroup>
1418 <tbody><tr>
1419 <td class="parameter_name"><p>buffer</p></td>
1420 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1421 <td class="parameter_annotations"> </td>
1422 </tr></tbody>
1423 </table></div>
1424 </div>
1425 <div class="refsect3">
1426 <a name="hb-buffer-get-language.returns"></a><h4>Returns</h4>
1427 <p>The <a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="type">hb_language_t</span></a> of the buffer. Must not be freed by the caller. </p>
1428 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
1429 </div>
1430 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1431 </div>
1432 <hr>
1433 <div class="refsect2">
1434 <a name="hb-buffer-set-flags"></a><h3>hb_buffer_set_flags ()</h3>
1435 <pre class="programlisting"><span class="returnvalue">void</span>
1436 hb_buffer_set_flags (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1437                      <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-flags-t" title="enum hb_buffer_flags_t"><span class="type">hb_buffer_flags_t</span></a> flags</code></em>);</pre>
1438 <p>Sets <em class="parameter"><code>buffer</code></em>
1439  flags to <em class="parameter"><code>flags</code></em>
1440 . See <a class="link" href="harfbuzz-Buffers.html#hb-buffer-flags-t" title="enum hb_buffer_flags_t"><span class="type">hb_buffer_flags_t</span></a>.</p>
1441 <div class="refsect3">
1442 <a name="hb-buffer-set-flags.parameters"></a><h4>Parameters</h4>
1443 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1444 <colgroup>
1445 <col width="150px" class="parameters_name">
1446 <col class="parameters_description">
1447 <col width="200px" class="parameters_annotations">
1448 </colgroup>
1449 <tbody>
1450 <tr>
1451 <td class="parameter_name"><p>buffer</p></td>
1452 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1453 <td class="parameter_annotations"> </td>
1454 </tr>
1455 <tr>
1456 <td class="parameter_name"><p>flags</p></td>
1457 <td class="parameter_description"><p>the buffer flags to set.</p></td>
1458 <td class="parameter_annotations"> </td>
1459 </tr>
1460 </tbody>
1461 </table></div>
1462 </div>
1463 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
1464 </div>
1465 <hr>
1466 <div class="refsect2">
1467 <a name="hb-buffer-get-flags"></a><h3>hb_buffer_get_flags ()</h3>
1468 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-flags-t" title="enum hb_buffer_flags_t"><span class="returnvalue">hb_buffer_flags_t</span></a>
1469 hb_buffer_get_flags (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1470 <p>See <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-flags" title="hb_buffer_set_flags ()"><code class="function">hb_buffer_set_flags()</code></a>.</p>
1471 <div class="refsect3">
1472 <a name="hb-buffer-get-flags.parameters"></a><h4>Parameters</h4>
1473 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1474 <colgroup>
1475 <col width="150px" class="parameters_name">
1476 <col class="parameters_description">
1477 <col width="200px" class="parameters_annotations">
1478 </colgroup>
1479 <tbody><tr>
1480 <td class="parameter_name"><p>buffer</p></td>
1481 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1482 <td class="parameter_annotations"> </td>
1483 </tr></tbody>
1484 </table></div>
1485 </div>
1486 <div class="refsect3">
1487 <a name="hb-buffer-get-flags.returns"></a><h4>Returns</h4>
1488 <p>The <em class="parameter"><code>buffer</code></em>
1489 flags.</p>
1490 </div>
1491 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
1492 </div>
1493 <hr>
1494 <div class="refsect2">
1495 <a name="hb-buffer-set-cluster-level"></a><h3>hb_buffer_set_cluster_level ()</h3>
1496 <pre class="programlisting"><span class="returnvalue">void</span>
1497 hb_buffer_set_cluster_level (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1498                              <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-cluster-level-t" title="enum hb_buffer_cluster_level_t"><span class="type">hb_buffer_cluster_level_t</span></a> cluster_level</code></em>);</pre>
1499 <div class="refsect3">
1500 <a name="hb-buffer-set-cluster-level.parameters"></a><h4>Parameters</h4>
1501 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1502 <colgroup>
1503 <col width="150px" class="parameters_name">
1504 <col class="parameters_description">
1505 <col width="200px" class="parameters_annotations">
1506 </colgroup>
1507 <tbody><tr>
1508 <td class="parameter_name"><p>buffer</p></td>
1509 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1510 <td class="parameter_annotations"> </td>
1511 </tr></tbody>
1512 </table></div>
1513 </div>
1514 <p class="since">Since: <a class="link" href="api-index-0-9-42.html#api-index-0.9.42">0.9.42</a></p>
1515 </div>
1516 <hr>
1517 <div class="refsect2">
1518 <a name="hb-buffer-get-cluster-level"></a><h3>hb_buffer_get_cluster_level ()</h3>
1519 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-cluster-level-t" title="enum hb_buffer_cluster_level_t"><span class="returnvalue">hb_buffer_cluster_level_t</span></a>
1520 hb_buffer_get_cluster_level (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1521 <div class="refsect3">
1522 <a name="hb-buffer-get-cluster-level.parameters"></a><h4>Parameters</h4>
1523 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1524 <colgroup>
1525 <col width="150px" class="parameters_name">
1526 <col class="parameters_description">
1527 <col width="200px" class="parameters_annotations">
1528 </colgroup>
1529 <tbody><tr>
1530 <td class="parameter_name"><p>buffer</p></td>
1531 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1532 <td class="parameter_annotations"> </td>
1533 </tr></tbody>
1534 </table></div>
1535 </div>
1536 <p class="since">Since: <a class="link" href="api-index-0-9-42.html#api-index-0.9.42">0.9.42</a></p>
1537 </div>
1538 <hr>
1539 <div class="refsect2">
1540 <a name="hb-buffer-set-length"></a><h3>hb_buffer_set_length ()</h3>
1541 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
1542 hb_buffer_set_length (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1543                       <em class="parameter"><code>unsigned <span class="type">int</span> length</code></em>);</pre>
1544 <p>Similar to <a class="link" href="harfbuzz-Buffers.html#hb-buffer-pre-allocate" title="hb_buffer_pre_allocate ()"><code class="function">hb_buffer_pre_allocate()</code></a>, but clears any new items added at the
1545 end.</p>
1546 <div class="refsect3">
1547 <a name="hb-buffer-set-length.parameters"></a><h4>Parameters</h4>
1548 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1549 <colgroup>
1550 <col width="150px" class="parameters_name">
1551 <col class="parameters_description">
1552 <col width="200px" class="parameters_annotations">
1553 </colgroup>
1554 <tbody>
1555 <tr>
1556 <td class="parameter_name"><p>buffer</p></td>
1557 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1558 <td class="parameter_annotations"> </td>
1559 </tr>
1560 <tr>
1561 <td class="parameter_name"><p>length</p></td>
1562 <td class="parameter_description"><p>the new length of <em class="parameter"><code>buffer</code></em>
1563 .</p></td>
1564 <td class="parameter_annotations"> </td>
1565 </tr>
1566 </tbody>
1567 </table></div>
1568 </div>
1569 <div class="refsect3">
1570 <a name="hb-buffer-set-length.returns"></a><h4>Returns</h4>
1571 <p><code class="literal">true</code> if <em class="parameter"><code>buffer</code></em>
1572 memory allocation succeeded, <code class="literal">false</code> otherwise.</p>
1573 </div>
1574 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1575 </div>
1576 <hr>
1577 <div class="refsect2">
1578 <a name="hb-buffer-get-length"></a><h3>hb_buffer_get_length ()</h3>
1579 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
1580 hb_buffer_get_length (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1581 <p>Returns the number of items in the buffer.</p>
1582 <div class="refsect3">
1583 <a name="hb-buffer-get-length.parameters"></a><h4>Parameters</h4>
1584 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1585 <colgroup>
1586 <col width="150px" class="parameters_name">
1587 <col class="parameters_description">
1588 <col width="200px" class="parameters_annotations">
1589 </colgroup>
1590 <tbody><tr>
1591 <td class="parameter_name"><p>buffer</p></td>
1592 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1593 <td class="parameter_annotations"> </td>
1594 </tr></tbody>
1595 </table></div>
1596 </div>
1597 <div class="refsect3">
1598 <a name="hb-buffer-get-length.returns"></a><h4>Returns</h4>
1599 <p>The <em class="parameter"><code>buffer</code></em>
1600 length.
1601 The value valid as long as buffer has not been modified.</p>
1602 </div>
1603 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1604 </div>
1605 <hr>
1606 <div class="refsect2">
1607 <a name="hb-buffer-set-segment-properties"></a><h3>hb_buffer_set_segment_properties ()</h3>
1608 <pre class="programlisting"><span class="returnvalue">void</span>
1609 hb_buffer_set_segment_properties (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1610                                   <em class="parameter"><code>const <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>);</pre>
1611 <p>Sets the segment properties of the buffer, a shortcut for calling
1612 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-direction" title="hb_buffer_set_direction ()"><code class="function">hb_buffer_set_direction()</code></a>, <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-script" title="hb_buffer_set_script ()"><code class="function">hb_buffer_set_script()</code></a> and
1613 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-language" title="hb_buffer_set_language ()"><code class="function">hb_buffer_set_language()</code></a> individually.</p>
1614 <div class="refsect3">
1615 <a name="hb-buffer-set-segment-properties.parameters"></a><h4>Parameters</h4>
1616 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1617 <colgroup>
1618 <col width="150px" class="parameters_name">
1619 <col class="parameters_description">
1620 <col width="200px" class="parameters_annotations">
1621 </colgroup>
1622 <tbody>
1623 <tr>
1624 <td class="parameter_name"><p>buffer</p></td>
1625 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1626 <td class="parameter_annotations"> </td>
1627 </tr>
1628 <tr>
1629 <td class="parameter_name"><p>props</p></td>
1630 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> to use.</p></td>
1631 <td class="parameter_annotations"> </td>
1632 </tr>
1633 </tbody>
1634 </table></div>
1635 </div>
1636 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
1637 </div>
1638 <hr>
1639 <div class="refsect2">
1640 <a name="hb-buffer-get-segment-properties"></a><h3>hb_buffer_get_segment_properties ()</h3>
1641 <pre class="programlisting"><span class="returnvalue">void</span>
1642 hb_buffer_get_segment_properties (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1643                                   <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *props</code></em>);</pre>
1644 <p>Sets <em class="parameter"><code>props</code></em>
1645  to the <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> of <em class="parameter"><code>buffer</code></em>
1646 .</p>
1647 <div class="refsect3">
1648 <a name="hb-buffer-get-segment-properties.parameters"></a><h4>Parameters</h4>
1649 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1650 <colgroup>
1651 <col width="150px" class="parameters_name">
1652 <col class="parameters_description">
1653 <col width="200px" class="parameters_annotations">
1654 </colgroup>
1655 <tbody>
1656 <tr>
1657 <td class="parameter_name"><p>buffer</p></td>
1658 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1659 <td class="parameter_annotations"> </td>
1660 </tr>
1661 <tr>
1662 <td class="parameter_name"><p>props</p></td>
1663 <td class="parameter_description"><p>the output <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a>. </p></td>
1664 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1665 </tr>
1666 </tbody>
1667 </table></div>
1668 </div>
1669 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
1670 </div>
1671 <hr>
1672 <div class="refsect2">
1673 <a name="hb-buffer-guess-segment-properties"></a><h3>hb_buffer_guess_segment_properties ()</h3>
1674 <pre class="programlisting"><span class="returnvalue">void</span>
1675 hb_buffer_guess_segment_properties (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1676 <p>Sets unset buffer segment properties based on buffer Unicode
1677 contents.  If buffer is not empty, it must have content type
1678 <a class="link" href="harfbuzz-Buffers.html#HB-BUFFER-CONTENT-TYPE-UNICODE:CAPS"><code class="literal">HB_BUFFER_CONTENT_TYPE_UNICODE</code></a>.</p>
1679 <p>If buffer script is not set (ie. is <a class="link" href="harfbuzz-hb-common.html#HB-SCRIPT-INVALID:CAPS"><code class="literal">HB_SCRIPT_INVALID</code></a>), it
1680 will be set to the Unicode script of the first character in
1681 the buffer that has a script other than <a href="harfbuzz-hb-common.html#HB-SCRIPT-COMMON:CAPS"><code class="literal">HB_SCRIPT_COMMON</code></a>,
1682 <a href="harfbuzz-hb-common.html#HB-SCRIPT-INHERITED:CAPS"><code class="literal">HB_SCRIPT_INHERITED</code></a>, and <a href="harfbuzz-hb-common.html#HB-SCRIPT-UNKNOWN:CAPS"><code class="literal">HB_SCRIPT_UNKNOWN</code></a>.</p>
1683 <p>Next, if buffer direction is not set (ie. is <a class="link" href="harfbuzz-hb-common.html#HB-DIRECTION-INVALID:CAPS"><code class="literal">HB_DIRECTION_INVALID</code></a>),
1684 it will be set to the natural horizontal direction of the
1685 buffer script as returned by <a class="link" href="harfbuzz-hb-common.html#hb-script-get-horizontal-direction" title="hb_script_get_horizontal_direction ()"><code class="function">hb_script_get_horizontal_direction()</code></a>.</p>
1686 <p>Finally, if buffer language is not set (ie. is <a class="link" href="harfbuzz-hb-common.html#HB-LANGUAGE-INVALID:CAPS" title="HB_LANGUAGE_INVALID"><code class="literal">HB_LANGUAGE_INVALID</code></a>),
1687 it will be set to the process's default language as returned by
1688 <a class="link" href="harfbuzz-hb-common.html#hb-language-get-default" title="hb_language_get_default ()"><code class="function">hb_language_get_default()</code></a>.  This may change in the future by
1689 taking buffer script into consideration when choosing a language.</p>
1690 <div class="refsect3">
1691 <a name="hb-buffer-guess-segment-properties.parameters"></a><h4>Parameters</h4>
1692 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1693 <colgroup>
1694 <col width="150px" class="parameters_name">
1695 <col class="parameters_description">
1696 <col width="200px" class="parameters_annotations">
1697 </colgroup>
1698 <tbody><tr>
1699 <td class="parameter_name"><p>buffer</p></td>
1700 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1701 <td class="parameter_annotations"> </td>
1702 </tr></tbody>
1703 </table></div>
1704 </div>
1705 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
1706 </div>
1707 <hr>
1708 <div class="refsect2">
1709 <a name="hb-buffer-set-unicode-funcs"></a><h3>hb_buffer_set_unicode_funcs ()</h3>
1710 <pre class="programlisting"><span class="returnvalue">void</span>
1711 hb_buffer_set_unicode_funcs (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1712                              <em class="parameter"><code><a class="link" href="harfbuzz-hb-unicode.html#hb-unicode-funcs-t"><span class="type">hb_unicode_funcs_t</span></a> *unicode_funcs</code></em>);</pre>
1713 <div class="refsect3">
1714 <a name="hb-buffer-set-unicode-funcs.parameters"></a><h4>Parameters</h4>
1715 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1716 <colgroup>
1717 <col width="150px" class="parameters_name">
1718 <col class="parameters_description">
1719 <col width="200px" class="parameters_annotations">
1720 </colgroup>
1721 <tbody><tr>
1722 <td class="parameter_name"><p>buffer</p></td>
1723 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1724 <td class="parameter_annotations"> </td>
1725 </tr></tbody>
1726 </table></div>
1727 </div>
1728 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1729 </div>
1730 <hr>
1731 <div class="refsect2">
1732 <a name="hb-buffer-get-unicode-funcs"></a><h3>hb_buffer_get_unicode_funcs ()</h3>
1733 <pre class="programlisting"><a class="link" href="harfbuzz-hb-unicode.html#hb-unicode-funcs-t"><span class="returnvalue">hb_unicode_funcs_t</span></a> *
1734 hb_buffer_get_unicode_funcs (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1735 <div class="refsect3">
1736 <a name="hb-buffer-get-unicode-funcs.parameters"></a><h4>Parameters</h4>
1737 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1738 <colgroup>
1739 <col width="150px" class="parameters_name">
1740 <col class="parameters_description">
1741 <col width="200px" class="parameters_annotations">
1742 </colgroup>
1743 <tbody><tr>
1744 <td class="parameter_name"><p>buffer</p></td>
1745 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1746 <td class="parameter_annotations"> </td>
1747 </tr></tbody>
1748 </table></div>
1749 </div>
1750 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1751 </div>
1752 <hr>
1753 <div class="refsect2">
1754 <a name="hb-buffer-set-user-data"></a><h3>hb_buffer_set_user_data ()</h3>
1755 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
1756 hb_buffer_set_user_data (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1757                          <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t"><span class="type">hb_user_data_key_t</span></a> *key</code></em>,
1758                          <em class="parameter"><code><span class="type">void</span> *data</code></em>,
1759                          <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-destroy-func-t" title="hb_destroy_func_t ()"><span class="type">hb_destroy_func_t</span></a> destroy</code></em>,
1760                          <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="type">hb_bool_t</span></a> replace</code></em>);</pre>
1761 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
1762 <div class="refsect3">
1763 <a name="hb-buffer-set-user-data.parameters"></a><h4>Parameters</h4>
1764 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1765 <colgroup>
1766 <col width="150px" class="parameters_name">
1767 <col class="parameters_description">
1768 <col width="200px" class="parameters_annotations">
1769 </colgroup>
1770 <tbody><tr>
1771 <td class="parameter_name"><p>buffer</p></td>
1772 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1773 <td class="parameter_annotations"> </td>
1774 </tr></tbody>
1775 </table></div>
1776 </div>
1777 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1778 </div>
1779 <hr>
1780 <div class="refsect2">
1781 <a name="hb-buffer-get-user-data"></a><h3>hb_buffer_get_user_data ()</h3>
1782 <pre class="programlisting"><span class="returnvalue">void</span> *
1783 hb_buffer_get_user_data (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1784                          <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-user-data-key-t"><span class="type">hb_user_data_key_t</span></a> *key</code></em>);</pre>
1785 <p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
1786 <div class="refsect3">
1787 <a name="hb-buffer-get-user-data.parameters"></a><h4>Parameters</h4>
1788 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1789 <colgroup>
1790 <col width="150px" class="parameters_name">
1791 <col class="parameters_description">
1792 <col width="200px" class="parameters_annotations">
1793 </colgroup>
1794 <tbody><tr>
1795 <td class="parameter_name"><p>buffer</p></td>
1796 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1797 <td class="parameter_annotations"> </td>
1798 </tr></tbody>
1799 </table></div>
1800 </div>
1801 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1802 </div>
1803 <hr>
1804 <div class="refsect2">
1805 <a name="hb-buffer-get-glyph-infos"></a><h3>hb_buffer_get_glyph_infos ()</h3>
1806 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-t"><span class="returnvalue">hb_glyph_info_t</span></a> *
1807 hb_buffer_get_glyph_infos (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1808                            <em class="parameter"><code>unsigned <span class="type">int</span> *length</code></em>);</pre>
1809 <p>Returns <em class="parameter"><code>buffer</code></em>
1810  glyph information array.  Returned pointer
1811 is valid as long as <em class="parameter"><code>buffer</code></em>
1812  contents are not modified.</p>
1813 <div class="refsect3">
1814 <a name="hb-buffer-get-glyph-infos.parameters"></a><h4>Parameters</h4>
1815 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1816 <colgroup>
1817 <col width="150px" class="parameters_name">
1818 <col class="parameters_description">
1819 <col width="200px" class="parameters_annotations">
1820 </colgroup>
1821 <tbody>
1822 <tr>
1823 <td class="parameter_name"><p>buffer</p></td>
1824 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1825 <td class="parameter_annotations"> </td>
1826 </tr>
1827 <tr>
1828 <td class="parameter_name"><p>length</p></td>
1829 <td class="parameter_description"><p>output array length. </p></td>
1830 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1831 </tr>
1832 </tbody>
1833 </table></div>
1834 </div>
1835 <div class="refsect3">
1836 <a name="hb-buffer-get-glyph-infos.returns"></a><h4>Returns</h4>
1837 <p>The <em class="parameter"><code>buffer</code></em>
1838 glyph information array.
1839 The value valid as long as buffer has not been modified. </p>
1840 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length]</span></p>
1841 </div>
1842 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1843 </div>
1844 <hr>
1845 <div class="refsect2">
1846 <a name="hb-buffer-get-glyph-positions"></a><h3>hb_buffer_get_glyph_positions ()</h3>
1847 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-glyph-position-t"><span class="returnvalue">hb_glyph_position_t</span></a> *
1848 hb_buffer_get_glyph_positions (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1849                                <em class="parameter"><code>unsigned <span class="type">int</span> *length</code></em>);</pre>
1850 <p>Returns <em class="parameter"><code>buffer</code></em>
1851  glyph position array.  Returned pointer
1852 is valid as long as <em class="parameter"><code>buffer</code></em>
1853  contents are not modified.</p>
1854 <div class="refsect3">
1855 <a name="hb-buffer-get-glyph-positions.parameters"></a><h4>Parameters</h4>
1856 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1857 <colgroup>
1858 <col width="150px" class="parameters_name">
1859 <col class="parameters_description">
1860 <col width="200px" class="parameters_annotations">
1861 </colgroup>
1862 <tbody>
1863 <tr>
1864 <td class="parameter_name"><p>buffer</p></td>
1865 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1866 <td class="parameter_annotations"> </td>
1867 </tr>
1868 <tr>
1869 <td class="parameter_name"><p>length</p></td>
1870 <td class="parameter_description"><p>output length. </p></td>
1871 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
1872 </tr>
1873 </tbody>
1874 </table></div>
1875 </div>
1876 <div class="refsect3">
1877 <a name="hb-buffer-get-glyph-positions.returns"></a><h4>Returns</h4>
1878 <p>The <em class="parameter"><code>buffer</code></em>
1879 glyph position array.
1880 The value valid as long as buffer has not been modified. </p>
1881 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length]</span></p>
1882 </div>
1883 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1884 </div>
1885 <hr>
1886 <div class="refsect2">
1887 <a name="hb-buffer-set-replacement-codepoint"></a><h3>hb_buffer_set_replacement_codepoint ()</h3>
1888 <pre class="programlisting"><span class="returnvalue">void</span>
1889 hb_buffer_set_replacement_codepoint (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
1890                                      <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> replacement</code></em>);</pre>
1891 <p>Sets the <a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> that replaces invalid entries for a given encoding
1892 when adding text to <em class="parameter"><code>buffer</code></em>
1893 .</p>
1894 <p>Default is <a class="link" href="harfbuzz-Buffers.html#HB-BUFFER-REPLACEMENT-CODEPOINT-DEFAULT:CAPS" title="HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT"><code class="literal">HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT</code></a>.</p>
1895 <div class="refsect3">
1896 <a name="hb-buffer-set-replacement-codepoint.parameters"></a><h4>Parameters</h4>
1897 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1898 <colgroup>
1899 <col width="150px" class="parameters_name">
1900 <col class="parameters_description">
1901 <col width="200px" class="parameters_annotations">
1902 </colgroup>
1903 <tbody>
1904 <tr>
1905 <td class="parameter_name"><p>buffer</p></td>
1906 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1907 <td class="parameter_annotations"> </td>
1908 </tr>
1909 <tr>
1910 <td class="parameter_name"><p>replacement</p></td>
1911 <td class="parameter_description"><p>the replacement <a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a></p></td>
1912 <td class="parameter_annotations"> </td>
1913 </tr>
1914 </tbody>
1915 </table></div>
1916 </div>
1917 <p class="since">Since: <a class="link" href="api-index-0-9-31.html#api-index-0.9.31">0.9.31</a></p>
1918 </div>
1919 <hr>
1920 <div class="refsect2">
1921 <a name="hb-buffer-get-replacement-codepoint"></a><h3>hb_buffer_get_replacement_codepoint ()</h3>
1922 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="returnvalue">hb_codepoint_t</span></a>
1923 hb_buffer_get_replacement_codepoint (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1924 <p>See <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-replacement-codepoint" title="hb_buffer_set_replacement_codepoint ()"><code class="function">hb_buffer_set_replacement_codepoint()</code></a>.</p>
1925 <div class="refsect3">
1926 <a name="hb-buffer-get-replacement-codepoint.parameters"></a><h4>Parameters</h4>
1927 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1928 <colgroup>
1929 <col width="150px" class="parameters_name">
1930 <col class="parameters_description">
1931 <col width="200px" class="parameters_annotations">
1932 </colgroup>
1933 <tbody><tr>
1934 <td class="parameter_name"><p>buffer</p></td>
1935 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1936 <td class="parameter_annotations"> </td>
1937 </tr></tbody>
1938 </table></div>
1939 </div>
1940 <div class="refsect3">
1941 <a name="hb-buffer-get-replacement-codepoint.returns"></a><h4>Returns</h4>
1942 <p>The <em class="parameter"><code>buffer</code></em>
1943 replacement <a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a>.</p>
1944 </div>
1945 <p class="since">Since: <a class="link" href="api-index-0-9-31.html#api-index-0.9.31">0.9.31</a></p>
1946 </div>
1947 <hr>
1948 <div class="refsect2">
1949 <a name="hb-buffer-normalize-glyphs"></a><h3>hb_buffer_normalize_glyphs ()</h3>
1950 <pre class="programlisting"><span class="returnvalue">void</span>
1951 hb_buffer_normalize_glyphs (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1952 <p>Reorders a glyph buffer to have canonical in-cluster glyph order / position.
1953 The resulting clusters should behave identical to pre-reordering clusters.</p>
1954 <div class="note">This has nothing to do with Unicode normalization.</div>
1955 <div class="refsect3">
1956 <a name="hb-buffer-normalize-glyphs.parameters"></a><h4>Parameters</h4>
1957 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1958 <colgroup>
1959 <col width="150px" class="parameters_name">
1960 <col class="parameters_description">
1961 <col width="200px" class="parameters_annotations">
1962 </colgroup>
1963 <tbody><tr>
1964 <td class="parameter_name"><p>buffer</p></td>
1965 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1966 <td class="parameter_annotations"> </td>
1967 </tr></tbody>
1968 </table></div>
1969 </div>
1970 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1971 </div>
1972 <hr>
1973 <div class="refsect2">
1974 <a name="hb-buffer-reverse"></a><h3>hb_buffer_reverse ()</h3>
1975 <pre class="programlisting"><span class="returnvalue">void</span>
1976 hb_buffer_reverse (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
1977 <p>Reverses buffer contents.</p>
1978 <div class="refsect3">
1979 <a name="hb-buffer-reverse.parameters"></a><h4>Parameters</h4>
1980 <div class="informaltable"><table class="informaltable" width="100%" border="0">
1981 <colgroup>
1982 <col width="150px" class="parameters_name">
1983 <col class="parameters_description">
1984 <col width="200px" class="parameters_annotations">
1985 </colgroup>
1986 <tbody><tr>
1987 <td class="parameter_name"><p>buffer</p></td>
1988 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
1989 <td class="parameter_annotations"> </td>
1990 </tr></tbody>
1991 </table></div>
1992 </div>
1993 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
1994 </div>
1995 <hr>
1996 <div class="refsect2">
1997 <a name="hb-buffer-reverse-range"></a><h3>hb_buffer_reverse_range ()</h3>
1998 <pre class="programlisting"><span class="returnvalue">void</span>
1999 hb_buffer_reverse_range (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
2000                          <em class="parameter"><code>unsigned <span class="type">int</span> start</code></em>,
2001                          <em class="parameter"><code>unsigned <span class="type">int</span> end</code></em>);</pre>
2002 <p>Reverses buffer contents between start to end.</p>
2003 <div class="refsect3">
2004 <a name="hb-buffer-reverse-range.parameters"></a><h4>Parameters</h4>
2005 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2006 <colgroup>
2007 <col width="150px" class="parameters_name">
2008 <col class="parameters_description">
2009 <col width="200px" class="parameters_annotations">
2010 </colgroup>
2011 <tbody>
2012 <tr>
2013 <td class="parameter_name"><p>buffer</p></td>
2014 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
2015 <td class="parameter_annotations"> </td>
2016 </tr>
2017 <tr>
2018 <td class="parameter_name"><p>start</p></td>
2019 <td class="parameter_description"><p>start index.</p></td>
2020 <td class="parameter_annotations"> </td>
2021 </tr>
2022 <tr>
2023 <td class="parameter_name"><p>end</p></td>
2024 <td class="parameter_description"><p>end index.</p></td>
2025 <td class="parameter_annotations"> </td>
2026 </tr>
2027 </tbody>
2028 </table></div>
2029 </div>
2030 <p class="since">Since: <a class="link" href="api-index-0-9-41.html#api-index-0.9.41">0.9.41</a></p>
2031 </div>
2032 <hr>
2033 <div class="refsect2">
2034 <a name="hb-buffer-reverse-clusters"></a><h3>hb_buffer_reverse_clusters ()</h3>
2035 <pre class="programlisting"><span class="returnvalue">void</span>
2036 hb_buffer_reverse_clusters (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>);</pre>
2037 <p>Reverses buffer clusters.  That is, the buffer contents are
2038 reversed, then each cluster (consecutive items having the
2039 same cluster number) are reversed again.</p>
2040 <div class="refsect3">
2041 <a name="hb-buffer-reverse-clusters.parameters"></a><h4>Parameters</h4>
2042 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2043 <colgroup>
2044 <col width="150px" class="parameters_name">
2045 <col class="parameters_description">
2046 <col width="200px" class="parameters_annotations">
2047 </colgroup>
2048 <tbody><tr>
2049 <td class="parameter_name"><p>buffer</p></td>
2050 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
2051 <td class="parameter_annotations"> </td>
2052 </tr></tbody>
2053 </table></div>
2054 </div>
2055 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
2056 </div>
2057 <hr>
2058 <div class="refsect2">
2059 <a name="hb-buffer-serialize-glyphs"></a><h3>hb_buffer_serialize_glyphs ()</h3>
2060 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
2061 hb_buffer_serialize_glyphs (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
2062                             <em class="parameter"><code>unsigned <span class="type">int</span> start</code></em>,
2063                             <em class="parameter"><code>unsigned <span class="type">int</span> end</code></em>,
2064                             <em class="parameter"><code><span class="type">char</span> *buf</code></em>,
2065                             <em class="parameter"><code>unsigned <span class="type">int</span> buf_size</code></em>,
2066                             <em class="parameter"><code>unsigned <span class="type">int</span> *buf_consumed</code></em>,
2067                             <em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-font-t"><span class="type">hb_font_t</span></a> *font</code></em>,
2068                             <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t"><span class="type">hb_buffer_serialize_format_t</span></a> format</code></em>,
2069                             <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-flags-t" title="enum hb_buffer_serialize_flags_t"><span class="type">hb_buffer_serialize_flags_t</span></a> flags</code></em>);</pre>
2070 <p>Serializes <em class="parameter"><code>buffer</code></em>
2071  into a textual representation of its glyph content,
2072 useful for showing the contents of the buffer, for example during debugging.
2073 There are currently two supported serialization formats:</p>
2074 <div class="refsect3">
2075 <a name="id-1.3.3.5.12.46.5"></a><h4>text</h4>
2076 <p>A human-readable, plain text format.
2077 The serialized glyphs will look something like:</p>
2078 <p><code class="literal">
2079 [uni0651=0@518,0+0|uni0628=0+1897]
2080 </code></p>
2081 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
2082 <li class="listitem"><p>The serialized glyphs are delimited with <code class="literal">[</code> and <code class="literal">]</code>.</p></li>
2083 <li class="listitem"><p>Glyphs are separated with <code class="literal">|</code></p></li>
2084 <li class="listitem">
2085 <p>Each glyph starts with glyph name, or glyph index if
2086 <a class="link" href="harfbuzz-Buffers.html#HB-BUFFER-SERIALIZE-FLAG-NO-GLYPH-NAMES:CAPS"><span class="type">HB_BUFFER_SERIALIZE_FLAG_NO_GLYPH_NAMES</span></a> flag is set. Then,</p>
2087 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
2088 <li class="listitem"><p>If <a class="link" href="harfbuzz-Buffers.html#HB-BUFFER-SERIALIZE-FLAG-NO-CLUSTERS:CAPS"><span class="type">HB_BUFFER_SERIALIZE_FLAG_NO_CLUSTERS</span></a> is not set, <code class="literal">=</code> then <span class="type">hb_glyph_info_t.cluster</span>.</p></li>
2089 <li class="listitem">
2090 <p>If <a class="link" href="harfbuzz-Buffers.html#HB-BUFFER-SERIALIZE-FLAG-NO-POSITIONS:CAPS"><span class="type">HB_BUFFER_SERIALIZE_FLAG_NO_POSITIONS</span></a> is not set, the <a class="link" href="harfbuzz-Buffers.html#hb-glyph-position-t"><span class="type">hb_glyph_position_t</span></a> in the format:</p>
2091 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: square; ">
2092 <li class="listitem"><p>If both <span class="type">hb_glyph_position_t.x_offset</span> and <span class="type">hb_glyph_position_t.y_offset</span> are not 0, <code class="literal">@x_offset,y_offset</code>. Then,</p></li>
2093 <li class="listitem"><p><code class="literal">+x_advance</code>, then <code class="literal">,y_advance</code> if <span class="type">hb_glyph_position_t.y_advance</span> is not 0. Then,</p></li>
2094 </ul></div>
2095 </li>
2096 <li class="listitem"><p>If <a class="link" href="harfbuzz-Buffers.html#HB-BUFFER-SERIALIZE-FLAG-GLYPH-EXTENTS:CAPS"><span class="type">HB_BUFFER_SERIALIZE_FLAG_GLYPH_EXTENTS</span></a> is set, the
2097 <span class="type">hb_glyph_extents_t</span> in the format
2098 <code class="literal">&amp;lt;x_bearing,y_bearing,width,height&amp;gt;</code></p></li>
2099 </ul></div>
2100 </li>
2101 </ul></div>
2102 </div>
2103 <div class="refsect3">
2104 <a name="id-1.3.3.5.12.46.6"></a><h4>json</h4>
2105 <p>TODO.</p>
2106 </div>
2107 <div class="refsect3">
2108 <a name="hb-buffer-serialize-glyphs.parameters"></a><h4>Parameters</h4>
2109 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2110 <colgroup>
2111 <col width="150px" class="parameters_name">
2112 <col class="parameters_description">
2113 <col width="200px" class="parameters_annotations">
2114 </colgroup>
2115 <tbody>
2116 <tr>
2117 <td class="parameter_name"><p>buffer</p></td>
2118 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> buffer.</p></td>
2119 <td class="parameter_annotations"> </td>
2120 </tr>
2121 <tr>
2122 <td class="parameter_name"><p>start</p></td>
2123 <td class="parameter_description"><p>the first item in <em class="parameter"><code>buffer</code></em>
2124 to serialize.</p></td>
2125 <td class="parameter_annotations"> </td>
2126 </tr>
2127 <tr>
2128 <td class="parameter_name"><p>end</p></td>
2129 <td class="parameter_description"><p>the last item in <em class="parameter"><code>buffer</code></em>
2130 to serialize.</p></td>
2131 <td class="parameter_annotations"> </td>
2132 </tr>
2133 <tr>
2134 <td class="parameter_name"><p>buf</p></td>
2135 <td class="parameter_description"><p>output string to
2136 write serialized buffer into. </p></td>
2137 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=buf_size][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint8_t]</span></td>
2138 </tr>
2139 <tr>
2140 <td class="parameter_name"><p>buf_size</p></td>
2141 <td class="parameter_description"><p>the size of <em class="parameter"><code>buf</code></em>
2142 .</p></td>
2143 <td class="parameter_annotations"> </td>
2144 </tr>
2145 <tr>
2146 <td class="parameter_name"><p>buf_consumed</p></td>
2147 <td class="parameter_description"><p>if not <code class="literal">NULL</code>, will be set to the number of byes written into <em class="parameter"><code>buf</code></em>
2148 . </p></td>
2149 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
2150 </tr>
2151 <tr>
2152 <td class="parameter_name"><p>font</p></td>
2153 <td class="parameter_description"><p>the <a class="link" href="harfbuzz-hb-font.html#hb-font-t"><span class="type">hb_font_t</span></a> used to shape this buffer, needed to
2154 read glyph names and extents. If <code class="literal">NULL</code>, and empty font will be used. </p></td>
2155 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
2156 </tr>
2157 <tr>
2158 <td class="parameter_name"><p>format</p></td>
2159 <td class="parameter_description"><p>the <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t"><span class="type">hb_buffer_serialize_format_t</span></a> to use for formatting the output.</p></td>
2160 <td class="parameter_annotations"> </td>
2161 </tr>
2162 <tr>
2163 <td class="parameter_name"><p>flags</p></td>
2164 <td class="parameter_description"><p>the <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-flags-t" title="enum hb_buffer_serialize_flags_t"><span class="type">hb_buffer_serialize_flags_t</span></a> that control what glyph properties
2165 to serialize.</p></td>
2166 <td class="parameter_annotations"> </td>
2167 </tr>
2168 </tbody>
2169 </table></div>
2170 </div>
2171 <div class="refsect3">
2172 <a name="hb-buffer-serialize-glyphs.returns"></a><h4>Returns</h4>
2173 <p>The number of serialized items.</p>
2174 </div>
2175 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
2176 </div>
2177 <hr>
2178 <div class="refsect2">
2179 <a name="hb-buffer-deserialize-glyphs"></a><h3>hb_buffer_deserialize_glyphs ()</h3>
2180 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
2181 hb_buffer_deserialize_glyphs (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
2182                               <em class="parameter"><code>const <span class="type">char</span> *buf</code></em>,
2183                               <em class="parameter"><code><span class="type">int</span> buf_len</code></em>,
2184                               <em class="parameter"><code>const <span class="type">char</span> **end_ptr</code></em>,
2185                               <em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-font-t"><span class="type">hb_font_t</span></a> *font</code></em>,
2186                               <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t"><span class="type">hb_buffer_serialize_format_t</span></a> format</code></em>);</pre>
2187 <div class="refsect3">
2188 <a name="hb-buffer-deserialize-glyphs.parameters"></a><h4>Parameters</h4>
2189 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2190 <colgroup>
2191 <col width="150px" class="parameters_name">
2192 <col class="parameters_description">
2193 <col width="200px" class="parameters_annotations">
2194 </colgroup>
2195 <tbody>
2196 <tr>
2197 <td class="parameter_name"><p>buffer</p></td>
2198 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> buffer.</p></td>
2199 <td class="parameter_annotations"> </td>
2200 </tr>
2201 <tr>
2202 <td class="parameter_name"><p>buf</p></td>
2203 <td class="parameter_description"><p>. </p></td>
2204 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=buf_len]</span></td>
2205 </tr>
2206 <tr>
2207 <td class="parameter_name"><p>end_ptr</p></td>
2208 <td class="parameter_description"><p>. </p></td>
2209 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
2210 </tr>
2211 </tbody>
2212 </table></div>
2213 </div>
2214 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
2215 </div>
2216 <hr>
2217 <div class="refsect2">
2218 <a name="hb-buffer-serialize-format-from-string"></a><h3>hb_buffer_serialize_format_from_string ()</h3>
2219 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t"><span class="returnvalue">hb_buffer_serialize_format_t</span></a>
2220 hb_buffer_serialize_format_from_string
2221                                (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
2222                                 <em class="parameter"><code><span class="type">int</span> len</code></em>);</pre>
2223 <p>Parses a string into an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t"><span class="type">hb_buffer_serialize_format_t</span></a>. Does not check if
2224 <em class="parameter"><code>str</code></em>
2225  is a valid buffer serialization format, use
2226 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-list-formats" title="hb_buffer_serialize_list_formats ()"><code class="function">hb_buffer_serialize_list_formats()</code></a> to get the list of supported formats.</p>
2227 <div class="refsect3">
2228 <a name="hb-buffer-serialize-format-from-string.parameters"></a><h4>Parameters</h4>
2229 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2230 <colgroup>
2231 <col width="150px" class="parameters_name">
2232 <col class="parameters_description">
2233 <col width="200px" class="parameters_annotations">
2234 </colgroup>
2235 <tbody>
2236 <tr>
2237 <td class="parameter_name"><p>str</p></td>
2238 <td class="parameter_description"><p>a string to parse. </p></td>
2239 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> uint8_t]</span></td>
2240 </tr>
2241 <tr>
2242 <td class="parameter_name"><p>len</p></td>
2243 <td class="parameter_description"><p>length of <em class="parameter"><code>str</code></em>
2244 , or -1 if string is <code class="literal">NULL</code> terminated</p></td>
2245 <td class="parameter_annotations"> </td>
2246 </tr>
2247 </tbody>
2248 </table></div>
2249 </div>
2250 <div class="refsect3">
2251 <a name="hb-buffer-serialize-format-from-string.returns"></a><h4>Returns</h4>
2252 <p>The parsed <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t"><span class="type">hb_buffer_serialize_format_t</span></a>.</p>
2253 </div>
2254 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
2255 </div>
2256 <hr>
2257 <div class="refsect2">
2258 <a name="hb-buffer-serialize-format-to-string"></a><h3>hb_buffer_serialize_format_to_string ()</h3>
2259 <pre class="programlisting">const <span class="returnvalue">char</span> *
2260 hb_buffer_serialize_format_to_string (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t"><span class="type">hb_buffer_serialize_format_t</span></a> format</code></em>);</pre>
2261 <p>Converts <em class="parameter"><code>format</code></em>
2262  to the string corresponding it, or <code class="literal">NULL</code> if it is not a valid
2263 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t"><span class="type">hb_buffer_serialize_format_t</span></a>.</p>
2264 <div class="refsect3">
2265 <a name="hb-buffer-serialize-format-to-string.parameters"></a><h4>Parameters</h4>
2266 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2267 <colgroup>
2268 <col width="150px" class="parameters_name">
2269 <col class="parameters_description">
2270 <col width="200px" class="parameters_annotations">
2271 </colgroup>
2272 <tbody><tr>
2273 <td class="parameter_name"><p>format</p></td>
2274 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-format-t" title="enum hb_buffer_serialize_format_t"><span class="type">hb_buffer_serialize_format_t</span></a> to convert.</p></td>
2275 <td class="parameter_annotations"> </td>
2276 </tr></tbody>
2277 </table></div>
2278 </div>
2279 <div class="refsect3">
2280 <a name="hb-buffer-serialize-format-to-string.returns"></a><h4>Returns</h4>
2281 <p>A <code class="literal">NULL</code> terminated string corresponding to <em class="parameter"><code>format</code></em>
2282 . Should not be freed. </p>
2283 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
2284 </div>
2285 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
2286 </div>
2287 <hr>
2288 <div class="refsect2">
2289 <a name="hb-buffer-serialize-list-formats"></a><h3>hb_buffer_serialize_list_formats ()</h3>
2290 <pre class="programlisting">const <span class="returnvalue">char</span> **
2291 hb_buffer_serialize_list_formats (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
2292 <p>Returns a list of supported buffer serialization formats.</p>
2293 <div class="refsect3">
2294 <a name="hb-buffer-serialize-list-formats.returns"></a><h4>Returns</h4>
2295 <p>A string array of buffer serialization formats. Should not be freed. </p>
2296 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
2297 </div>
2298 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
2299 </div>
2300 <hr>
2301 <div class="refsect2">
2302 <a name="hb-segment-properties-equal"></a><h3>hb_segment_properties_equal ()</h3>
2303 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
2304 hb_segment_properties_equal (<em class="parameter"><code>const <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *a</code></em>,
2305                              <em class="parameter"><code>const <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *b</code></em>);</pre>
2306 <p>Checks the equality of two <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a>'s.</p>
2307 <div class="refsect3">
2308 <a name="hb-segment-properties-equal.parameters"></a><h4>Parameters</h4>
2309 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2310 <colgroup>
2311 <col width="150px" class="parameters_name">
2312 <col class="parameters_description">
2313 <col width="200px" class="parameters_annotations">
2314 </colgroup>
2315 <tbody>
2316 <tr>
2317 <td class="parameter_name"><p>a</p></td>
2318 <td class="parameter_description"><p>first <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> to compare.</p></td>
2319 <td class="parameter_annotations"> </td>
2320 </tr>
2321 <tr>
2322 <td class="parameter_name"><p>b</p></td>
2323 <td class="parameter_description"><p>second <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> to compare.</p></td>
2324 <td class="parameter_annotations"> </td>
2325 </tr>
2326 </tbody>
2327 </table></div>
2328 </div>
2329 <div class="refsect3">
2330 <a name="hb-segment-properties-equal.returns"></a><h4>Returns</h4>
2331 <p><code class="literal">true</code> if all properties of <em class="parameter"><code>a</code></em>
2332 equal those of <em class="parameter"><code>b</code></em>
2333 , false otherwise.</p>
2334 </div>
2335 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
2336 </div>
2337 <hr>
2338 <div class="refsect2">
2339 <a name="hb-segment-properties-hash"></a><h3>hb_segment_properties_hash ()</h3>
2340 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
2341 hb_segment_properties_hash (<em class="parameter"><code>const <a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> *p</code></em>);</pre>
2342 <p>Creates a hash representing <em class="parameter"><code>p</code></em>
2343 .</p>
2344 <div class="refsect3">
2345 <a name="hb-segment-properties-hash.parameters"></a><h4>Parameters</h4>
2346 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2347 <colgroup>
2348 <col width="150px" class="parameters_name">
2349 <col class="parameters_description">
2350 <col width="200px" class="parameters_annotations">
2351 </colgroup>
2352 <tbody><tr>
2353 <td class="parameter_name"><p>p</p></td>
2354 <td class="parameter_description"><p><a class="link" href="harfbuzz-Buffers.html#hb-segment-properties-t"><span class="type">hb_segment_properties_t</span></a> to hash.</p></td>
2355 <td class="parameter_annotations"> </td>
2356 </tr></tbody>
2357 </table></div>
2358 </div>
2359 <div class="refsect3">
2360 <a name="hb-segment-properties-hash.returns"></a><h4>Returns</h4>
2361 <p>A hash of <em class="parameter"><code>p</code></em>
2362 .</p>
2363 </div>
2364 <p class="since">Since: <a class="link" href="api-index-0-9-7.html#api-index-0.9.7">0.9.7</a></p>
2365 </div>
2366 <hr>
2367 <div class="refsect2">
2368 <a name="hb-buffer-diff"></a><h3>hb_buffer_diff ()</h3>
2369 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-buffer-diff-flags-t" title="enum hb_buffer_diff_flags_t"><span class="returnvalue">hb_buffer_diff_flags_t</span></a>
2370 hb_buffer_diff (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
2371                 <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *reference</code></em>,
2372                 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> dottedcircle_glyph</code></em>,
2373                 <em class="parameter"><code>unsigned <span class="type">int</span> position_fuzz</code></em>);</pre>
2374 <p>If dottedcircle_glyph is (hb_codepoint_t) -1 then <a class="link" href="harfbuzz-Buffers.html#HB-BUFFER-DIFF-FLAG-DOTTED-CIRCLE-PRESENT:CAPS"><code class="literal">HB_BUFFER_DIFF_FLAG_DOTTED_CIRCLE_PRESENT</code></a>
2375 and <a class="link" href="harfbuzz-Buffers.html#HB-BUFFER-DIFF-FLAG-NOTDEF-PRESENT:CAPS"><code class="literal">HB_BUFFER_DIFF_FLAG_NOTDEF_PRESENT</code></a> are never returned.  This should be used by most
2376 callers if just comparing two buffers is needed.</p>
2377 <p class="since">Since: <a class="link" href="api-index-1-5-0.html#api-index-1.5.0">1.5.0</a></p>
2378 </div>
2379 <hr>
2380 <div class="refsect2">
2381 <a name="hb-buffer-set-message-func"></a><h3>hb_buffer_set_message_func ()</h3>
2382 <pre class="programlisting"><span class="returnvalue">void</span>
2383 hb_buffer_set_message_func (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
2384                             <em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-message-func-t" title="hb_buffer_message_func_t ()"><span class="type">hb_buffer_message_func_t</span></a> func</code></em>,
2385                             <em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
2386                             <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-destroy-func-t" title="hb_destroy_func_t ()"><span class="type">hb_destroy_func_t</span></a> destroy</code></em>);</pre>
2387 <div class="refsect3">
2388 <a name="hb-buffer-set-message-func.parameters"></a><h4>Parameters</h4>
2389 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2390 <colgroup>
2391 <col width="150px" class="parameters_name">
2392 <col class="parameters_description">
2393 <col width="200px" class="parameters_annotations">
2394 </colgroup>
2395 <tbody>
2396 <tr>
2397 <td class="parameter_name"><p>buffer</p></td>
2398 <td class="parameter_description"><p>an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>.</p></td>
2399 <td class="parameter_annotations"> </td>
2400 </tr>
2401 <tr>
2402 <td class="parameter_name"><p>func</p></td>
2403 <td class="parameter_description"><p>. </p></td>
2404 <td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> user_data][<acronym title="This parameter is a 'destroy_data', for callbacks."><span class="acronym">destroy</span></acronym> destroy][<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
2405 </tr>
2406 </tbody>
2407 </table></div>
2408 </div>
2409 <p class="since">Since: <a class="link" href="api-index-1-1-3.html#api-index-1.1.3">1.1.3</a></p>
2410 </div>
2411 <hr>
2412 <div class="refsect2">
2413 <a name="hb-glyph-info-get-glyph-flags"></a><h3>hb_glyph_info_get_glyph_flags ()</h3>
2414 <pre class="programlisting"><a class="link" href="harfbuzz-Buffers.html#hb-glyph-flags-t" title="enum hb_glyph_flags_t"><span class="returnvalue">hb_glyph_flags_t</span></a>
2415 hb_glyph_info_get_glyph_flags (<em class="parameter"><code>const <a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-t"><span class="type">hb_glyph_info_t</span></a> *info</code></em>);</pre>
2416 <p>Returns glyph flags encoded within a <a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-t"><span class="type">hb_glyph_info_t</span></a>.</p>
2417 <div class="refsect3">
2418 <a name="hb-glyph-info-get-glyph-flags.parameters"></a><h4>Parameters</h4>
2419 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2420 <colgroup>
2421 <col width="150px" class="parameters_name">
2422 <col class="parameters_description">
2423 <col width="200px" class="parameters_annotations">
2424 </colgroup>
2425 <tbody><tr>
2426 <td class="parameter_name"><p>info</p></td>
2427 <td class="parameter_description"><p>a <a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-t"><span class="type">hb_glyph_info_t</span></a>.</p></td>
2428 <td class="parameter_annotations"> </td>
2429 </tr></tbody>
2430 </table></div>
2431 </div>
2432 <div class="refsect3">
2433 <a name="hb-glyph-info-get-glyph-flags.returns"></a><h4>Returns</h4>
2434 <p>The <a class="link" href="harfbuzz-Buffers.html#hb-glyph-flags-t" title="enum hb_glyph_flags_t"><span class="type">hb_glyph_flags_t</span></a> encoded within <em class="parameter"><code>info</code></em>
2435 .</p>
2436 </div>
2437 <p class="since">Since: <a class="link" href="api-index-1-5-0.html#api-index-1.5.0">1.5.0</a></p>
2438 </div>
2439 <hr>
2440 <div class="refsect2">
2441 <a name="hb-buffer-message-func-t"></a><h3>hb_buffer_message_func_t ()</h3>
2442 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
2443 <span class="c_punctuation">(</span>*hb_buffer_message_func_t<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a> *buffer</code></em>,
2444                              <em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-font-t"><span class="type">hb_font_t</span></a> *font</code></em>,
2445                              <em class="parameter"><code>const <span class="type">char</span> *message</code></em>,
2446                              <em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
2447 </div>
2448 </div>
2449 <div class="refsect1">
2450 <a name="harfbuzz-Buffers.other_details"></a><h2>Types and Values</h2>
2451 <div class="refsect2">
2452 <a name="HB-SEGMENT-PROPERTIES-DEFAULT:CAPS"></a><h3>HB_SEGMENT_PROPERTIES_DEFAULT</h3>
2453 <pre class="programlisting">#define             HB_SEGMENT_PROPERTIES_DEFAULT</pre>
2454 </div>
2455 <hr>
2456 <div class="refsect2">
2457 <a name="HB-BUFFER-REPLACEMENT-CODEPOINT-DEFAULT:CAPS"></a><h3>HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT</h3>
2458 <pre class="programlisting">#define HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT 0xFFFDu
2459 </pre>
2460 <p>The default code point for replacing invalid characters in a given encoding.
2461 Set to U+FFFD REPLACEMENT CHARACTER.</p>
2462 <p class="since">Since: <a class="link" href="api-index-0-9-31.html#api-index-0.9.31">0.9.31</a></p>
2463 </div>
2464 <hr>
2465 <div class="refsect2">
2466 <a name="hb-buffer-t"></a><h3>hb_buffer_t</h3>
2467 <pre class="programlisting">typedef struct hb_buffer_t hb_buffer_t;
2468 </pre>
2469 <p>The main structure holding the input text and its properties before shaping,
2470 and output glyphs and their information after shaping.</p>
2471 </div>
2472 <hr>
2473 <div class="refsect2">
2474 <a name="hb-glyph-info-t-struct"></a><h3>hb_glyph_info_t</h3>
2475 <pre class="programlisting">typedef struct {
2476   hb_codepoint_t codepoint;
2477   hb_mask_t      mask; /* Holds hb_glyph_flags_t after hb_shape(), plus other things. */
2478   uint32_t       cluster;
2479 } hb_glyph_info_t;
2480 </pre>
2481 <p>The <a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-t"><span class="type">hb_glyph_info_t</span></a> is the structure that holds information about the
2482 glyphs and their relation to input text.</p>
2483 <div class="refsect3">
2484 <a name="hb-glyph-info-t.members"></a><h4>Members</h4>
2485 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2486 <colgroup>
2487 <col width="300px" class="struct_members_name">
2488 <col class="struct_members_description">
2489 <col width="200px" class="struct_members_annotations">
2490 </colgroup>
2491 <tbody>
2492 <tr>
2493 <td class="struct_member_name"><p><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> <em class="structfield"><code><a name="hb-glyph-info-t-struct.codepoint"></a>codepoint</code></em>;</p></td>
2494 <td class="struct_member_description"><p>either a Unicode code point (before shaping) or a glyph index
2495 (after shaping).</p></td>
2496 <td class="struct_member_annotations"> </td>
2497 </tr>
2498 <tr>
2499 <td class="struct_member_name"><p><a class="link" href="harfbuzz-hb-common.html#hb-mask-t" title="hb_mask_t"><span class="type">hb_mask_t</span></a> <em class="structfield"><code><a name="hb-glyph-info-t-struct.mask"></a>mask</code></em>;</p></td>
2500 <td class="struct_member_description"> </td>
2501 <td class="struct_member_annotations"> </td>
2502 </tr>
2503 <tr>
2504 <td class="struct_member_name"><p><span class="type">uint32_t</span> <em class="structfield"><code><a name="hb-glyph-info-t-struct.cluster"></a>cluster</code></em>;</p></td>
2505 <td class="struct_member_description"><p>the index of the character in the original text that corresponds
2506 to this <a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-t"><span class="type">hb_glyph_info_t</span></a>, or whatever the client passes to
2507 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-add" title="hb_buffer_add ()"><code class="function">hb_buffer_add()</code></a>. More than one <a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-t"><span class="type">hb_glyph_info_t</span></a> can have the same
2508 <em class="parameter"><code>cluster</code></em>
2509 value, if they resulted from the same character (e.g. one
2510 to many glyph substitution), and when more than one character gets
2511 merged in the same glyph (e.g. many to one glyph substitution) the
2512 <a class="link" href="harfbuzz-Buffers.html#hb-glyph-info-t"><span class="type">hb_glyph_info_t</span></a> will have the smallest cluster value of them.
2513 By default some characters are merged into the same cluster
2514 (e.g. combining marks have the same cluster as their bases)
2515 even if they are separate glyphs, <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-cluster-level" title="hb_buffer_set_cluster_level ()"><code class="function">hb_buffer_set_cluster_level()</code></a>
2516 allow selecting more fine-grained cluster handling.</p></td>
2517 <td class="struct_member_annotations"> </td>
2518 </tr>
2519 </tbody>
2520 </table></div>
2521 </div>
2522 </div>
2523 <hr>
2524 <div class="refsect2">
2525 <a name="hb-glyph-flags-t"></a><h3>enum hb_glyph_flags_t</h3>
2526 <div class="refsect3">
2527 <a name="hb-glyph-flags-t.members"></a><h4>Members</h4>
2528 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2529 <colgroup>
2530 <col width="300px" class="enum_members_name">
2531 <col class="enum_members_description">
2532 <col width="200px" class="enum_members_annotations">
2533 </colgroup>
2534 <tbody>
2535 <tr>
2536 <td class="enum_member_name"><p><a name="HB-GLYPH-FLAG-UNSAFE-TO-BREAK:CAPS"></a>HB_GLYPH_FLAG_UNSAFE_TO_BREAK</p></td>
2537 <td class="enum_member_description">
2538 <p>Indicates that if input text is broken at the
2539                                    beginning of the cluster this glyph is part of,
2540                                    then both sides need to be re-shaped, as the
2541                                    result might be different.  On the flip side,
2542                                    it means that when this flag is not present,
2543                                    then it's safe to break the glyph-run at the
2544                                    beginning of this cluster, and the two sides
2545                                    represent the exact same result one would get
2546                                    if breaking input text at the beginning of
2547                                    this cluster and shaping the two sides
2548                                    separately.  This can be used to optimize
2549                                    paragraph layout, by avoiding re-shaping
2550                                    of each line after line-breaking, or limiting
2551                                    the reshaping to a small piece around the
2552                                    breaking point only.</p>
2553 </td>
2554 <td class="enum_member_annotations"> </td>
2555 </tr>
2556 <tr>
2557 <td class="enum_member_name"><p><a name="HB-GLYPH-FLAG-DEFINED:CAPS"></a>HB_GLYPH_FLAG_DEFINED</p></td>
2558 <td> </td>
2559 <td> </td>
2560 </tr>
2561 </tbody>
2562 </table></div>
2563 </div>
2564 </div>
2565 <hr>
2566 <div class="refsect2">
2567 <a name="hb-glyph-position-t-struct"></a><h3>hb_glyph_position_t</h3>
2568 <pre class="programlisting">typedef struct {
2569   hb_position_t  x_advance;
2570   hb_position_t  y_advance;
2571   hb_position_t  x_offset;
2572   hb_position_t  y_offset;
2573 } hb_glyph_position_t;
2574 </pre>
2575 <p>The <a class="link" href="harfbuzz-Buffers.html#hb-glyph-position-t"><span class="type">hb_glyph_position_t</span></a> is the structure that holds the positions of the
2576 glyph in both horizontal and vertical directions. All positions in
2577 <a class="link" href="harfbuzz-Buffers.html#hb-glyph-position-t"><span class="type">hb_glyph_position_t</span></a> are relative to the current point.</p>
2578 <div class="refsect3">
2579 <a name="hb-glyph-position-t.members"></a><h4>Members</h4>
2580 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2581 <colgroup>
2582 <col width="300px" class="struct_members_name">
2583 <col class="struct_members_description">
2584 <col width="200px" class="struct_members_annotations">
2585 </colgroup>
2586 <tbody>
2587 <tr>
2588 <td class="struct_member_name"><p><a class="link" href="harfbuzz-hb-common.html#hb-position-t" title="hb_position_t"><span class="type">hb_position_t</span></a> <em class="structfield"><code><a name="hb-glyph-position-t-struct.x-advance"></a>x_advance</code></em>;</p></td>
2589 <td class="struct_member_description"><p>how much the line advances after drawing this glyph when setting
2590 text in horizontal direction.</p></td>
2591 <td class="struct_member_annotations"> </td>
2592 </tr>
2593 <tr>
2594 <td class="struct_member_name"><p><a class="link" href="harfbuzz-hb-common.html#hb-position-t" title="hb_position_t"><span class="type">hb_position_t</span></a> <em class="structfield"><code><a name="hb-glyph-position-t-struct.y-advance"></a>y_advance</code></em>;</p></td>
2595 <td class="struct_member_description"><p>how much the line advances after drawing this glyph when setting
2596 text in vertical direction.</p></td>
2597 <td class="struct_member_annotations"> </td>
2598 </tr>
2599 <tr>
2600 <td class="struct_member_name"><p><a class="link" href="harfbuzz-hb-common.html#hb-position-t" title="hb_position_t"><span class="type">hb_position_t</span></a> <em class="structfield"><code><a name="hb-glyph-position-t-struct.x-offset"></a>x_offset</code></em>;</p></td>
2601 <td class="struct_member_description"><p>how much the glyph moves on the X-axis before drawing it, this
2602 should not affect how much the line advances.</p></td>
2603 <td class="struct_member_annotations"> </td>
2604 </tr>
2605 <tr>
2606 <td class="struct_member_name"><p><a class="link" href="harfbuzz-hb-common.html#hb-position-t" title="hb_position_t"><span class="type">hb_position_t</span></a> <em class="structfield"><code><a name="hb-glyph-position-t-struct.y-offset"></a>y_offset</code></em>;</p></td>
2607 <td class="struct_member_description"><p>how much the glyph moves on the Y-axis before drawing it, this
2608 should not affect how much the line advances.</p></td>
2609 <td class="struct_member_annotations"> </td>
2610 </tr>
2611 </tbody>
2612 </table></div>
2613 </div>
2614 </div>
2615 <hr>
2616 <div class="refsect2">
2617 <a name="hb-buffer-content-type-t"></a><h3>enum hb_buffer_content_type_t</h3>
2618 <div class="refsect3">
2619 <a name="hb-buffer-content-type-t.members"></a><h4>Members</h4>
2620 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2621 <colgroup>
2622 <col width="300px" class="enum_members_name">
2623 <col class="enum_members_description">
2624 <col width="200px" class="enum_members_annotations">
2625 </colgroup>
2626 <tbody>
2627 <tr>
2628 <td class="enum_member_name"><p><a name="HB-BUFFER-CONTENT-TYPE-INVALID:CAPS"></a>HB_BUFFER_CONTENT_TYPE_INVALID</p></td>
2629 <td class="enum_member_description">
2630 <p>Initial value for new buffer.</p>
2631 </td>
2632 <td class="enum_member_annotations"> </td>
2633 </tr>
2634 <tr>
2635 <td class="enum_member_name"><p><a name="HB-BUFFER-CONTENT-TYPE-UNICODE:CAPS"></a>HB_BUFFER_CONTENT_TYPE_UNICODE</p></td>
2636 <td class="enum_member_description">
2637 <p>The buffer contains input characters (before shaping).</p>
2638 </td>
2639 <td class="enum_member_annotations"> </td>
2640 </tr>
2641 <tr>
2642 <td class="enum_member_name"><p><a name="HB-BUFFER-CONTENT-TYPE-GLYPHS:CAPS"></a>HB_BUFFER_CONTENT_TYPE_GLYPHS</p></td>
2643 <td class="enum_member_description">
2644 <p>The buffer contains output glyphs (after shaping).</p>
2645 </td>
2646 <td class="enum_member_annotations"> </td>
2647 </tr>
2648 </tbody>
2649 </table></div>
2650 </div>
2651 </div>
2652 <hr>
2653 <div class="refsect2">
2654 <a name="hb-buffer-flags-t"></a><h3>enum hb_buffer_flags_t</h3>
2655 <div class="refsect3">
2656 <a name="hb-buffer-flags-t.members"></a><h4>Members</h4>
2657 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2658 <colgroup>
2659 <col width="300px" class="enum_members_name">
2660 <col class="enum_members_description">
2661 <col width="200px" class="enum_members_annotations">
2662 </colgroup>
2663 <tbody>
2664 <tr>
2665 <td class="enum_member_name"><p><a name="HB-BUFFER-FLAG-DEFAULT:CAPS"></a>HB_BUFFER_FLAG_DEFAULT</p></td>
2666 <td class="enum_member_description">
2667 <p>the default buffer flag.</p>
2668 </td>
2669 <td class="enum_member_annotations"> </td>
2670 </tr>
2671 <tr>
2672 <td class="enum_member_name"><p><a name="HB-BUFFER-FLAG-BOT:CAPS"></a>HB_BUFFER_FLAG_BOT</p></td>
2673 <td class="enum_member_description">
2674 <p>flag indicating that special handling of the beginning
2675                      of text paragraph can be applied to this buffer. Should usually
2676                      be set, unless you are passing to the buffer only part
2677                      of the text without the full context.</p>
2678 </td>
2679 <td class="enum_member_annotations"> </td>
2680 </tr>
2681 <tr>
2682 <td class="enum_member_name"><p><a name="HB-BUFFER-FLAG-EOT:CAPS"></a>HB_BUFFER_FLAG_EOT</p></td>
2683 <td class="enum_member_description">
2684 <p>flag indicating that special handling of the end of text
2685                      paragraph can be applied to this buffer, similar to
2686                      <em class="parameter"><code>HB_BUFFER_FLAG_BOT</code></em>
2687 .</p>
2688 </td>
2689 <td class="enum_member_annotations"> </td>
2690 </tr>
2691 <tr>
2692 <td class="enum_member_name"><p><a name="HB-BUFFER-FLAG-PRESERVE-DEFAULT-IGNORABLES:CAPS"></a>HB_BUFFER_FLAG_PRESERVE_DEFAULT_IGNORABLES</p></td>
2693 <td class="enum_member_description">
2694 <p>                     flag indication that character with Default_Ignorable
2695                      Unicode property should use the corresponding glyph
2696                      from the font, instead of hiding them (done by
2697                      replacing them with the space glyph and zeroing the
2698                      advance width.)  This flag takes precedence over
2699                      <em class="parameter"><code>HB_BUFFER_FLAG_REMOVE_DEFAULT_IGNORABLES</code></em>
2700 .</p>
2701 </td>
2702 <td class="enum_member_annotations"> </td>
2703 </tr>
2704 <tr>
2705 <td class="enum_member_name"><p><a name="HB-BUFFER-FLAG-REMOVE-DEFAULT-IGNORABLES:CAPS"></a>HB_BUFFER_FLAG_REMOVE_DEFAULT_IGNORABLES</p></td>
2706 <td class="enum_member_description">
2707 <p>                     flag indication that character with Default_Ignorable
2708                      Unicode property should be removed from glyph string
2709                      instead of hiding them (done by replacing them with the
2710                      space glyph and zeroing the advance width.)
2711                      <em class="parameter"><code>HB_BUFFER_FLAG_PRESERVE_DEFAULT_IGNORABLES</code></em>
2712  takes
2713                      precedence over this flag. Since: 1.8.0</p>
2714 </td>
2715 <td class="enum_member_annotations"> </td>
2716 </tr>
2717 </tbody>
2718 </table></div>
2719 </div>
2720 <p class="since">Since: <a class="link" href="api-index-0-9-20.html#api-index-0.9.20">0.9.20</a></p>
2721 </div>
2722 <hr>
2723 <div class="refsect2">
2724 <a name="hb-buffer-cluster-level-t"></a><h3>enum hb_buffer_cluster_level_t</h3>
2725 <div class="refsect3">
2726 <a name="hb-buffer-cluster-level-t.members"></a><h4>Members</h4>
2727 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2728 <colgroup>
2729 <col width="300px" class="enum_members_name">
2730 <col class="enum_members_description">
2731 <col width="200px" class="enum_members_annotations">
2732 </colgroup>
2733 <tbody>
2734 <tr>
2735 <td class="enum_member_name"><p><a name="HB-BUFFER-CLUSTER-LEVEL-MONOTONE-GRAPHEMES:CAPS"></a>HB_BUFFER_CLUSTER_LEVEL_MONOTONE_GRAPHEMES</p></td>
2736 <td> </td>
2737 <td> </td>
2738 </tr>
2739 <tr>
2740 <td class="enum_member_name"><p><a name="HB-BUFFER-CLUSTER-LEVEL-MONOTONE-CHARACTERS:CAPS"></a>HB_BUFFER_CLUSTER_LEVEL_MONOTONE_CHARACTERS</p></td>
2741 <td> </td>
2742 <td> </td>
2743 </tr>
2744 <tr>
2745 <td class="enum_member_name"><p><a name="HB-BUFFER-CLUSTER-LEVEL-CHARACTERS:CAPS"></a>HB_BUFFER_CLUSTER_LEVEL_CHARACTERS</p></td>
2746 <td> </td>
2747 <td> </td>
2748 </tr>
2749 <tr>
2750 <td class="enum_member_name"><p><a name="HB-BUFFER-CLUSTER-LEVEL-DEFAULT:CAPS"></a>HB_BUFFER_CLUSTER_LEVEL_DEFAULT</p></td>
2751 <td> </td>
2752 <td> </td>
2753 </tr>
2754 </tbody>
2755 </table></div>
2756 </div>
2757 </div>
2758 <hr>
2759 <div class="refsect2">
2760 <a name="hb-segment-properties-t-struct"></a><h3>hb_segment_properties_t</h3>
2761 <pre class="programlisting">typedef struct {
2762   hb_direction_t  direction;
2763   hb_script_t     script;
2764   hb_language_t   language;
2765 } hb_segment_properties_t;
2766 </pre>
2767 <p>The structure that holds various text properties of an <a class="link" href="harfbuzz-Buffers.html#hb-buffer-t"><span class="type">hb_buffer_t</span></a>. Can be
2768 set and retrieved using <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-segment-properties" title="hb_buffer_set_segment_properties ()"><code class="function">hb_buffer_set_segment_properties()</code></a> and
2769 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-get-segment-properties" title="hb_buffer_get_segment_properties ()"><code class="function">hb_buffer_get_segment_properties()</code></a>, respectively.</p>
2770 <div class="refsect3">
2771 <a name="hb-segment-properties-t.members"></a><h4>Members</h4>
2772 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2773 <colgroup>
2774 <col width="300px" class="struct_members_name">
2775 <col class="struct_members_description">
2776 <col width="200px" class="struct_members_annotations">
2777 </colgroup>
2778 <tbody>
2779 <tr>
2780 <td class="struct_member_name"><p><a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="type">hb_direction_t</span></a> <em class="structfield"><code><a name="hb-segment-properties-t-struct.direction"></a>direction</code></em>;</p></td>
2781 <td class="struct_member_description"><p>the <a class="link" href="harfbuzz-hb-common.html#hb-direction-t" title="enum hb_direction_t"><span class="type">hb_direction_t</span></a> of the buffer, see <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-direction" title="hb_buffer_set_direction ()"><code class="function">hb_buffer_set_direction()</code></a>.</p></td>
2782 <td class="struct_member_annotations"> </td>
2783 </tr>
2784 <tr>
2785 <td class="struct_member_name"><p><a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> <em class="structfield"><code><a name="hb-segment-properties-t-struct.script"></a>script</code></em>;</p></td>
2786 <td class="struct_member_description"><p>the <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> of the buffer, see <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-script" title="hb_buffer_set_script ()"><code class="function">hb_buffer_set_script()</code></a>.</p></td>
2787 <td class="struct_member_annotations"> </td>
2788 </tr>
2789 <tr>
2790 <td class="struct_member_name"><p><a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="type">hb_language_t</span></a> <em class="structfield"><code><a name="hb-segment-properties-t-struct.language"></a>language</code></em>;</p></td>
2791 <td class="struct_member_description"><p>the <a class="link" href="harfbuzz-hb-common.html#hb-language-t" title="hb_language_t"><span class="type">hb_language_t</span></a> of the buffer, see <a class="link" href="harfbuzz-Buffers.html#hb-buffer-set-language" title="hb_buffer_set_language ()"><code class="function">hb_buffer_set_language()</code></a>.</p></td>
2792 <td class="struct_member_annotations"> </td>
2793 </tr>
2794 </tbody>
2795 </table></div>
2796 </div>
2797 </div>
2798 <hr>
2799 <div class="refsect2">
2800 <a name="hb-buffer-serialize-format-t"></a><h3>enum hb_buffer_serialize_format_t</h3>
2801 <p>The buffer serialization and de-serialization format used in
2802 <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-glyphs" title="hb_buffer_serialize_glyphs ()"><code class="function">hb_buffer_serialize_glyphs()</code></a> and <a class="link" href="harfbuzz-Buffers.html#hb-buffer-deserialize-glyphs" title="hb_buffer_deserialize_glyphs ()"><code class="function">hb_buffer_deserialize_glyphs()</code></a>.</p>
2803 <div class="refsect3">
2804 <a name="hb-buffer-serialize-format-t.members"></a><h4>Members</h4>
2805 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2806 <colgroup>
2807 <col width="300px" class="enum_members_name">
2808 <col class="enum_members_description">
2809 <col width="200px" class="enum_members_annotations">
2810 </colgroup>
2811 <tbody>
2812 <tr>
2813 <td class="enum_member_name"><p><a name="HB-BUFFER-SERIALIZE-FORMAT-TEXT:CAPS"></a>HB_BUFFER_SERIALIZE_FORMAT_TEXT</p></td>
2814 <td class="enum_member_description">
2815 <p>a human-readable, plain text format.</p>
2816 </td>
2817 <td class="enum_member_annotations"> </td>
2818 </tr>
2819 <tr>
2820 <td class="enum_member_name"><p><a name="HB-BUFFER-SERIALIZE-FORMAT-JSON:CAPS"></a>HB_BUFFER_SERIALIZE_FORMAT_JSON</p></td>
2821 <td class="enum_member_description">
2822 <p>a machine-readable JSON format.</p>
2823 </td>
2824 <td class="enum_member_annotations"> </td>
2825 </tr>
2826 <tr>
2827 <td class="enum_member_name"><p><a name="HB-BUFFER-SERIALIZE-FORMAT-INVALID:CAPS"></a>HB_BUFFER_SERIALIZE_FORMAT_INVALID</p></td>
2828 <td class="enum_member_description">
2829 <p>invalid format.</p>
2830 </td>
2831 <td class="enum_member_annotations"> </td>
2832 </tr>
2833 </tbody>
2834 </table></div>
2835 </div>
2836 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
2837 </div>
2838 <hr>
2839 <div class="refsect2">
2840 <a name="hb-buffer-serialize-flags-t"></a><h3>enum hb_buffer_serialize_flags_t</h3>
2841 <p>Flags that control what glyph information are serialized in <a class="link" href="harfbuzz-Buffers.html#hb-buffer-serialize-glyphs" title="hb_buffer_serialize_glyphs ()"><code class="function">hb_buffer_serialize_glyphs()</code></a>.</p>
2842 <div class="refsect3">
2843 <a name="hb-buffer-serialize-flags-t.members"></a><h4>Members</h4>
2844 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2845 <colgroup>
2846 <col width="300px" class="enum_members_name">
2847 <col class="enum_members_description">
2848 <col width="200px" class="enum_members_annotations">
2849 </colgroup>
2850 <tbody>
2851 <tr>
2852 <td class="enum_member_name"><p><a name="HB-BUFFER-SERIALIZE-FLAG-DEFAULT:CAPS"></a>HB_BUFFER_SERIALIZE_FLAG_DEFAULT</p></td>
2853 <td class="enum_member_description">
2854 <p>serialize glyph names, clusters and positions.</p>
2855 </td>
2856 <td class="enum_member_annotations"> </td>
2857 </tr>
2858 <tr>
2859 <td class="enum_member_name"><p><a name="HB-BUFFER-SERIALIZE-FLAG-NO-CLUSTERS:CAPS"></a>HB_BUFFER_SERIALIZE_FLAG_NO_CLUSTERS</p></td>
2860 <td class="enum_member_description">
2861 <p>do not serialize glyph cluster.</p>
2862 </td>
2863 <td class="enum_member_annotations"> </td>
2864 </tr>
2865 <tr>
2866 <td class="enum_member_name"><p><a name="HB-BUFFER-SERIALIZE-FLAG-NO-POSITIONS:CAPS"></a>HB_BUFFER_SERIALIZE_FLAG_NO_POSITIONS</p></td>
2867 <td class="enum_member_description">
2868 <p>do not serialize glyph position information.</p>
2869 </td>
2870 <td class="enum_member_annotations"> </td>
2871 </tr>
2872 <tr>
2873 <td class="enum_member_name"><p><a name="HB-BUFFER-SERIALIZE-FLAG-NO-GLYPH-NAMES:CAPS"></a>HB_BUFFER_SERIALIZE_FLAG_NO_GLYPH_NAMES</p></td>
2874 <td class="enum_member_description">
2875 <p>do no serialize glyph name.</p>
2876 </td>
2877 <td class="enum_member_annotations"> </td>
2878 </tr>
2879 <tr>
2880 <td class="enum_member_name"><p><a name="HB-BUFFER-SERIALIZE-FLAG-GLYPH-EXTENTS:CAPS"></a>HB_BUFFER_SERIALIZE_FLAG_GLYPH_EXTENTS</p></td>
2881 <td class="enum_member_description">
2882 <p>serialize glyph extents.</p>
2883 </td>
2884 <td class="enum_member_annotations"> </td>
2885 </tr>
2886 <tr>
2887 <td class="enum_member_name"><p><a name="HB-BUFFER-SERIALIZE-FLAG-GLYPH-FLAGS:CAPS"></a>HB_BUFFER_SERIALIZE_FLAG_GLYPH_FLAGS</p></td>
2888 <td class="enum_member_description">
2889 <p>serialize glyph flags. Since: 1.5.0</p>
2890 </td>
2891 <td class="enum_member_annotations"> </td>
2892 </tr>
2893 <tr>
2894 <td class="enum_member_name"><p><a name="HB-BUFFER-SERIALIZE-FLAG-NO-ADVANCES:CAPS"></a>HB_BUFFER_SERIALIZE_FLAG_NO_ADVANCES</p></td>
2895 <td class="enum_member_description">
2896 <p>do not serialize glyph advances,
2897  glyph offsets will reflect absolute glyph positions. Since: 1.8.0</p>
2898 </td>
2899 <td class="enum_member_annotations"> </td>
2900 </tr>
2901 </tbody>
2902 </table></div>
2903 </div>
2904 <p class="since">Since: <a class="link" href="api-index-0-9-20.html#api-index-0.9.20">0.9.20</a></p>
2905 </div>
2906 <hr>
2907 <div class="refsect2">
2908 <a name="hb-buffer-diff-flags-t"></a><h3>enum hb_buffer_diff_flags_t</h3>
2909 <div class="refsect3">
2910 <a name="hb-buffer-diff-flags-t.members"></a><h4>Members</h4>
2911 <div class="informaltable"><table class="informaltable" width="100%" border="0">
2912 <colgroup>
2913 <col width="300px" class="enum_members_name">
2914 <col class="enum_members_description">
2915 <col width="200px" class="enum_members_annotations">
2916 </colgroup>
2917 <tbody>
2918 <tr>
2919 <td class="enum_member_name"><p><a name="HB-BUFFER-DIFF-FLAG-EQUAL:CAPS"></a>HB_BUFFER_DIFF_FLAG_EQUAL</p></td>
2920 <td> </td>
2921 <td> </td>
2922 </tr>
2923 <tr>
2924 <td class="enum_member_name"><p><a name="HB-BUFFER-DIFF-FLAG-CONTENT-TYPE-MISMATCH:CAPS"></a>HB_BUFFER_DIFF_FLAG_CONTENT_TYPE_MISMATCH</p></td>
2925 <td> </td>
2926 <td> </td>
2927 </tr>
2928 <tr>
2929 <td class="enum_member_name"><p><a name="HB-BUFFER-DIFF-FLAG-LENGTH-MISMATCH:CAPS"></a>HB_BUFFER_DIFF_FLAG_LENGTH_MISMATCH</p></td>
2930 <td> </td>
2931 <td> </td>
2932 </tr>
2933 <tr>
2934 <td class="enum_member_name"><p><a name="HB-BUFFER-DIFF-FLAG-NOTDEF-PRESENT:CAPS"></a>HB_BUFFER_DIFF_FLAG_NOTDEF_PRESENT</p></td>
2935 <td> </td>
2936 <td> </td>
2937 </tr>
2938 <tr>
2939 <td class="enum_member_name"><p><a name="HB-BUFFER-DIFF-FLAG-DOTTED-CIRCLE-PRESENT:CAPS"></a>HB_BUFFER_DIFF_FLAG_DOTTED_CIRCLE_PRESENT</p></td>
2940 <td> </td>
2941 <td> </td>
2942 </tr>
2943 <tr>
2944 <td class="enum_member_name"><p><a name="HB-BUFFER-DIFF-FLAG-CODEPOINT-MISMATCH:CAPS"></a>HB_BUFFER_DIFF_FLAG_CODEPOINT_MISMATCH</p></td>
2945 <td> </td>
2946 <td> </td>
2947 </tr>
2948 <tr>
2949 <td class="enum_member_name"><p><a name="HB-BUFFER-DIFF-FLAG-CLUSTER-MISMATCH:CAPS"></a>HB_BUFFER_DIFF_FLAG_CLUSTER_MISMATCH</p></td>
2950 <td> </td>
2951 <td> </td>
2952 </tr>
2953 <tr>
2954 <td class="enum_member_name"><p><a name="HB-BUFFER-DIFF-FLAG-GLYPH-FLAGS-MISMATCH:CAPS"></a>HB_BUFFER_DIFF_FLAG_GLYPH_FLAGS_MISMATCH</p></td>
2955 <td> </td>
2956 <td> </td>
2957 </tr>
2958 <tr>
2959 <td class="enum_member_name"><p><a name="HB-BUFFER-DIFF-FLAG-POSITION-MISMATCH:CAPS"></a>HB_BUFFER_DIFF_FLAG_POSITION_MISMATCH</p></td>
2960 <td> </td>
2961 <td> </td>
2962 </tr>
2963 </tbody>
2964 </table></div>
2965 </div>
2966 </div>
2967 </div>
2968 </div>
2969 <div class="footer">
2970 <hr>Generated by GTK-Doc V1.27.1</div>
2971 </body>
2972 </html>