docs/html/harfbuzz-hb-ot-var.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>hb-ot-var: 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="ch10.html" title="OpenType API">
   9 <link rel="prev" href="harfbuzz-hb-ot-shape.html" title="hb-ot-shape">
  10 <link rel="next" href="ch11.html" title="Apple Advanced Typography API">
  11 <meta name="generator" content="GTK-Doc V1.25 (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-hb-ot-var.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span>
  19                   <a href="#harfbuzz-hb-ot-var.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="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="harfbuzz-hb-ot-shape.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="ch11.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-hb-ot-var"></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-hb-ot-var.top_of_page"></a>hb-ot-var</span></h2>
  31 <p>hb-ot-var — OpenType Font Variations</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-hb-ot-var.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-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
  46 </td>
  47 <td class="function_name">
  48 <a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-has-data" title="hb_ot_var_has_data ()">hb_ot_var_has_data</a> <span class="c_punctuation">()</span>
  49 </td>
  50 </tr>
  51 <tr>
  52 <td class="function_type">
  53 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
  54 </td>
  55 <td class="function_name">
  56 <a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-find-axis-info" title="hb_ot_var_find_axis_info ()">hb_ot_var_find_axis_info</a> <span class="c_punctuation">()</span>
  57 </td>
  58 </tr>
  59 <tr>
  60 <td class="function_type">unsigned <span class="returnvalue">int</span>
  61 </td>
  62 <td class="function_name">
  63 <a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-get-axis-count" title="hb_ot_var_get_axis_count ()">hb_ot_var_get_axis_count</a> <span class="c_punctuation">()</span>
  64 </td>
  65 </tr>
  66 <tr>
  67 <td class="function_type">unsigned <span class="returnvalue">int</span>
  68 </td>
  69 <td class="function_name">
  70 <a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-get-axis-infos" title="hb_ot_var_get_axis_infos ()">hb_ot_var_get_axis_infos</a> <span class="c_punctuation">()</span>
  71 </td>
  72 </tr>
  73 <tr>
  74 <td class="function_type">unsigned <span class="returnvalue">int</span>
  75 </td>
  76 <td class="function_name">
  77 <a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-get-named-instance-count" title="hb_ot_var_get_named_instance_count ()">hb_ot_var_get_named_instance_count</a> <span class="c_punctuation">()</span>
  78 </td>
  79 </tr>
  80 <tr>
  81 <td class="function_type">
  82 <a class="link" href="harfbuzz-hb-ot-name.html#hb-ot-name-id-t" title="hb_ot_name_id_t"><span class="returnvalue">hb_ot_name_id_t</span></a>
  83 </td>
  84 <td class="function_name">
  85 <a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-named-instance-get-subfamily-name-id" title="hb_ot_var_named_instance_get_subfamily_name_id ()">hb_ot_var_named_instance_get_subfamily_name_id</a> <span class="c_punctuation">()</span>
  86 </td>
  87 </tr>
  88 <tr>
  89 <td class="function_type">
  90 <a class="link" href="harfbuzz-hb-ot-name.html#hb-ot-name-id-t" title="hb_ot_name_id_t"><span class="returnvalue">hb_ot_name_id_t</span></a>
  91 </td>
  92 <td class="function_name">
  93 <a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-named-instance-get-postscript-name-id" title="hb_ot_var_named_instance_get_postscript_name_id ()">hb_ot_var_named_instance_get_postscript_name_id</a> <span class="c_punctuation">()</span>
  94 </td>
  95 </tr>
  96 <tr>
  97 <td class="function_type">unsigned <span class="returnvalue">int</span>
  98 </td>
  99 <td class="function_name">
 100 <a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-named-instance-get-design-coords" title="hb_ot_var_named_instance_get_design_coords ()">hb_ot_var_named_instance_get_design_coords</a> <span class="c_punctuation">()</span>
 101 </td>
 102 </tr>
 103 <tr>
 104 <td class="function_type">
 105 <span class="returnvalue">void</span>
 106 </td>
 107 <td class="function_name">
 108 <a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-normalize-variations" title="hb_ot_var_normalize_variations ()">hb_ot_var_normalize_variations</a> <span class="c_punctuation">()</span>
 109 </td>
 110 </tr>
 111 <tr>
 112 <td class="function_type">
 113 <span class="returnvalue">void</span>
 114 </td>
 115 <td class="function_name">
 116 <a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-normalize-coords" title="hb_ot_var_normalize_coords ()">hb_ot_var_normalize_coords</a> <span class="c_punctuation">()</span>
 117 </td>
 118 </tr>
 119 </tbody>
 120 </table></div>
 121 </div>
 122 <div class="refsect1">
 123 <a name="harfbuzz-hb-ot-var.other"></a><h2>Types and Values</h2>
 124 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 125 <colgroup>
 126 <col width="150px" class="name">
 127 <col class="description">
 128 </colgroup>
 129 <tbody>
 130 <tr>
 131 <td class="define_keyword">#define</td>
 132 <td class="function_name"><a class="link" href="harfbuzz-hb-ot-var.html#HB-OT-TAG-VAR-AXIS-ITALIC:CAPS" title="HB_OT_TAG_VAR_AXIS_ITALIC">HB_OT_TAG_VAR_AXIS_ITALIC</a></td>
 133 </tr>
 134 <tr>
 135 <td class="define_keyword">#define</td>
 136 <td class="function_name"><a class="link" href="harfbuzz-hb-ot-var.html#HB-OT-TAG-VAR-AXIS-OPTICAL-SIZE:CAPS" title="HB_OT_TAG_VAR_AXIS_OPTICAL_SIZE">HB_OT_TAG_VAR_AXIS_OPTICAL_SIZE</a></td>
 137 </tr>
 138 <tr>
 139 <td class="define_keyword">#define</td>
 140 <td class="function_name"><a class="link" href="harfbuzz-hb-ot-var.html#HB-OT-TAG-VAR-AXIS-SLANT:CAPS" title="HB_OT_TAG_VAR_AXIS_SLANT">HB_OT_TAG_VAR_AXIS_SLANT</a></td>
 141 </tr>
 142 <tr>
 143 <td class="define_keyword">#define</td>
 144 <td class="function_name"><a class="link" href="harfbuzz-hb-ot-var.html#HB-OT-TAG-VAR-AXIS-WEIGHT:CAPS" title="HB_OT_TAG_VAR_AXIS_WEIGHT">HB_OT_TAG_VAR_AXIS_WEIGHT</a></td>
 145 </tr>
 146 <tr>
 147 <td class="define_keyword">#define</td>
 148 <td class="function_name"><a class="link" href="harfbuzz-hb-ot-var.html#HB-OT-TAG-VAR-AXIS-WIDTH:CAPS" title="HB_OT_TAG_VAR_AXIS_WIDTH">HB_OT_TAG_VAR_AXIS_WIDTH</a></td>
 149 </tr>
 150 <tr>
 151 <td class="datatype_keyword">enum</td>
 152 <td class="function_name"><a class="link" href="harfbuzz-hb-ot-var.html#hb-ot-var-axis-flags-t" title="enum hb_ot_var_axis_flags_t">hb_ot_var_axis_flags_t</a></td>
 153 </tr>
 154 </tbody>
 155 </table></div>
 156 </div>
 157 <div class="refsect1">
 158 <a name="harfbuzz-hb-ot-var.object-hierarchy"></a><h2>Object Hierarchy</h2>
 159 <pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GFlags</a>
 160     <span class="lineart">╰──</span> hb_ot_var_axis_flags_t
 161 </pre>
 162 </div>
 163 <div class="refsect1">
 164 <a name="harfbuzz-hb-ot-var.includes"></a><h2>Includes</h2>
 165 <pre class="synopsis">#include &lt;hb-ot.h&gt;
 166 </pre>
 167 </div>
 168 <div class="refsect1">
 169 <a name="harfbuzz-hb-ot-var.description"></a><h2>Description</h2>
 170 <p>Functions for fetching information about OpenType Variable Fonts.</p>
 171 </div>
 172 <div class="refsect1">
 173 <a name="harfbuzz-hb-ot-var.functions_details"></a><h2>Functions</h2>
 174 <div class="refsect2">
 175 <a name="hb-ot-var-has-data"></a><h3>hb_ot_var_has_data ()</h3>
 176 <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>
 177 hb_ot_var_has_data (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
 178 <p>This function allows to verify the presence of OpenType variation data on the face.</p>
 179 <div class="refsect3">
 180 <a name="hb-ot-var-has-data.parameters"></a><h4>Parameters</h4>
 181 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 182 <colgroup>
 183 <col width="150px" class="parameters_name">
 184 <col class="parameters_description">
 185 <col width="200px" class="parameters_annotations">
 186 </colgroup>
 187 <tbody><tr>
 188 <td class="parameter_name"><p>face</p></td>
 189 <td class="parameter_description"><p><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> to test</p></td>
 190 <td class="parameter_annotations"> </td>
 191 </tr></tbody>
 192 </table></div>
 193 </div>
 194 <div class="refsect3">
 195 <a name="hb-ot-var-has-data.returns"></a><h4>Returns</h4>
 196 <p> true if face has a `fvar' table and false otherwise</p>
 197 </div>
 198 <p class="since">Since: <a class="link" href="api-index-1-4-2.html#api-index-1.4.2">1.4.2</a></p>
 199 </div>
 200 <hr>
 201 <div class="refsect2">
 202 <a name="hb-ot-var-find-axis-info"></a><h3>hb_ot_var_find_axis_info ()</h3>
 203 <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>
 204 hb_ot_var_find_axis_info (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 205                           <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> axis_tag</code></em>,
 206                           <em class="parameter"><code><span class="type">hb_ot_var_axis_info_t</span> *axis_info</code></em>);</pre>
 207 <p class="since">Since: 2.2.0</p>
 208 </div>
 209 <hr>
 210 <div class="refsect2">
 211 <a name="hb-ot-var-get-axis-count"></a><h3>hb_ot_var_get_axis_count ()</h3>
 212 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
 213 hb_ot_var_get_axis_count (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
 214 <p class="since">Since: <a class="link" href="api-index-1-4-2.html#api-index-1.4.2">1.4.2</a></p>
 215 </div>
 216 <hr>
 217 <div class="refsect2">
 218 <a name="hb-ot-var-get-axis-infos"></a><h3>hb_ot_var_get_axis_infos ()</h3>
 219 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
 220 hb_ot_var_get_axis_infos (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 221                           <em class="parameter"><code>unsigned <span class="type">int</span> start_offset</code></em>,
 222                           <em class="parameter"><code>unsigned <span class="type">int</span> *axes_count</code></em>,
 223                           <em class="parameter"><code><span class="type">hb_ot_var_axis_info_t</span> *axes_array</code></em>);</pre>
 224 <p class="since">Since: 2.2.0</p>
 225 </div>
 226 <hr>
 227 <div class="refsect2">
 228 <a name="hb-ot-var-get-named-instance-count"></a><h3>hb_ot_var_get_named_instance_count ()</h3>
 229 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
 230 hb_ot_var_get_named_instance_count (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
 231 </div>
 232 <hr>
 233 <div class="refsect2">
 234 <a name="hb-ot-var-named-instance-get-subfamily-name-id"></a><h3>hb_ot_var_named_instance_get_subfamily_name_id ()</h3>
 235 <pre class="programlisting"><a class="link" href="harfbuzz-hb-ot-name.html#hb-ot-name-id-t" title="hb_ot_name_id_t"><span class="returnvalue">hb_ot_name_id_t</span></a>
 236 hb_ot_var_named_instance_get_subfamily_name_id
 237                                (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 238                                 <em class="parameter"><code>unsigned <span class="type">int</span> instance_index</code></em>);</pre>
 239 </div>
 240 <hr>
 241 <div class="refsect2">
 242 <a name="hb-ot-var-named-instance-get-postscript-name-id"></a><h3>hb_ot_var_named_instance_get_postscript_name_id ()</h3>
 243 <pre class="programlisting"><a class="link" href="harfbuzz-hb-ot-name.html#hb-ot-name-id-t" title="hb_ot_name_id_t"><span class="returnvalue">hb_ot_name_id_t</span></a>
 244 hb_ot_var_named_instance_get_postscript_name_id
 245                                (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 246                                 <em class="parameter"><code>unsigned <span class="type">int</span> instance_index</code></em>);</pre>
 247 </div>
 248 <hr>
 249 <div class="refsect2">
 250 <a name="hb-ot-var-named-instance-get-design-coords"></a><h3>hb_ot_var_named_instance_get_design_coords ()</h3>
 251 <pre class="programlisting">unsigned <span class="returnvalue">int</span>
 252 hb_ot_var_named_instance_get_design_coords
 253                                (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 254                                 <em class="parameter"><code>unsigned <span class="type">int</span> instance_index</code></em>,
 255                                 <em class="parameter"><code>unsigned <span class="type">int</span> *coords_length</code></em>,
 256                                 <em class="parameter"><code><span class="type">float</span> *coords</code></em>);</pre>
 257 </div>
 258 <hr>
 259 <div class="refsect2">
 260 <a name="hb-ot-var-normalize-variations"></a><h3>hb_ot_var_normalize_variations ()</h3>
 261 <pre class="programlisting"><span class="returnvalue">void</span>
 262 hb_ot_var_normalize_variations (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 263                                 <em class="parameter"><code>const <a class="link" href="harfbuzz-hb-font.html#hb-variation-t" title="hb_variation_t"><span class="type">hb_variation_t</span></a> *variations</code></em>,
 264                                 <em class="parameter"><code>unsigned <span class="type">int</span> variations_length</code></em>,
 265                                 <em class="parameter"><code><span class="type">int</span> *coords</code></em>,
 266                                 <em class="parameter"><code>unsigned <span class="type">int</span> coords_length</code></em>);</pre>
 267 <p class="since">Since: <a class="link" href="api-index-1-4-2.html#api-index-1.4.2">1.4.2</a></p>
 268 </div>
 269 <hr>
 270 <div class="refsect2">
 271 <a name="hb-ot-var-normalize-coords"></a><h3>hb_ot_var_normalize_coords ()</h3>
 272 <pre class="programlisting"><span class="returnvalue">void</span>
 273 hb_ot_var_normalize_coords (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
 274                             <em class="parameter"><code>unsigned <span class="type">int</span> coords_length</code></em>,
 275                             <em class="parameter"><code>const <span class="type">float</span> *design_coords</code></em>,
 276                             <em class="parameter"><code><span class="type">int</span> *normalized_coords</code></em>);</pre>
 277 <p class="since">Since: <a class="link" href="api-index-1-4-2.html#api-index-1.4.2">1.4.2</a></p>
 278 </div>
 279 </div>
 280 <div class="refsect1">
 281 <a name="harfbuzz-hb-ot-var.other_details"></a><h2>Types and Values</h2>
 282 <div class="refsect2">
 283 <a name="HB-OT-TAG-VAR-AXIS-ITALIC:CAPS"></a><h3>HB_OT_TAG_VAR_AXIS_ITALIC</h3>
 284 <pre class="programlisting">#define HB_OT_TAG_VAR_AXIS_ITALIC HB_TAG('i','t','a','l')
 285 </pre>
 286 </div>
 287 <hr>
 288 <div class="refsect2">
 289 <a name="HB-OT-TAG-VAR-AXIS-OPTICAL-SIZE:CAPS"></a><h3>HB_OT_TAG_VAR_AXIS_OPTICAL_SIZE</h3>
 290 <pre class="programlisting">#define HB_OT_TAG_VAR_AXIS_OPTICAL_SIZE HB_TAG('o','p','s','z')
 291 </pre>
 292 </div>
 293 <hr>
 294 <div class="refsect2">
 295 <a name="HB-OT-TAG-VAR-AXIS-SLANT:CAPS"></a><h3>HB_OT_TAG_VAR_AXIS_SLANT</h3>
 296 <pre class="programlisting">#define HB_OT_TAG_VAR_AXIS_SLANT HB_TAG('s','l','n','t')
 297 </pre>
 298 </div>
 299 <hr>
 300 <div class="refsect2">
 301 <a name="HB-OT-TAG-VAR-AXIS-WEIGHT:CAPS"></a><h3>HB_OT_TAG_VAR_AXIS_WEIGHT</h3>
 302 <pre class="programlisting">#define HB_OT_TAG_VAR_AXIS_WEIGHT HB_TAG('w','g','h','t')
 303 </pre>
 304 </div>
 305 <hr>
 306 <div class="refsect2">
 307 <a name="HB-OT-TAG-VAR-AXIS-WIDTH:CAPS"></a><h3>HB_OT_TAG_VAR_AXIS_WIDTH</h3>
 308 <pre class="programlisting">#define HB_OT_TAG_VAR_AXIS_WIDTH HB_TAG('w','d','t','h')
 309 </pre>
 310 </div>
 311 <hr>
 312 <div class="refsect2">
 313 <a name="hb-ot-var-axis-flags-t"></a><h3>enum hb_ot_var_axis_flags_t</h3>
 314 <div class="refsect3">
 315 <a name="hb-ot-var-axis-flags-t.members"></a><h4>Members</h4>
 316 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 317 <colgroup>
 318 <col width="300px" class="enum_members_name">
 319 <col class="enum_members_description">
 320 <col width="200px" class="enum_members_annotations">
 321 </colgroup>
 322 <tbody>
 323 <tr>
 324 <td class="enum_member_name"><p><a name="HB-OT-VAR-AXIS-FLAG-HIDDEN:CAPS"></a>HB_OT_VAR_AXIS_FLAG_HIDDEN</p></td>
 325 <td class="enum_member_description">
 326 <p>The axis should not be exposed directly in user interfaces.</p>
 327 </td>
 328 <td class="enum_member_annotations"> </td>
 329 </tr>
 330 <tr>
 331 <td class="enum_member_name"><p><a name="HB-OT-VAR-AXIS-FLAG-MAX-VALUE:CAPS"></a>_HB_OT_VAR_AXIS_FLAG_MAX_VALUE</p></td>
 332 <td> </td>
 333 <td> </td>
 334 </tr>
 335 </tbody>
 336 </table></div>
 337 </div>
 338 <p class="since">Since: 2.2.0</p>
 339 </div>
 340 </div>
 341 </div>
 342 <div class="footer">
 343 <hr>Generated by GTK-Doc V1.25</div>
 344 </body>
 345 </html>