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