docs/html/harfbuzz-hb-version.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-version: 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="core-api.html" title="Core API">
   9 <link rel="prev" href="harfbuzz-hb-unicode.html" title="hb-unicode">
  10 <link rel="next" href="opentype-api.html" title="OpenType API">
  11 <meta name="generator" content="GTK-Doc V1.32 (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-version.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="core-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="harfbuzz-hb-unicode.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="opentype-api.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-version"></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-version.top_of_page"></a>hb-version</span></h2>
  30 <p>hb-version — Information about the version of HarfBuzz in use</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-version.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="define_keyword">#define</td>
  44 <td class="function_name">
  45 <a class="link" href="harfbuzz-hb-version.html#HB-VERSION-ATLEAST:CAPS" title="HB_VERSION_ATLEAST()">HB_VERSION_ATLEAST</a><span class="c_punctuation">()</span>
  46 </td>
  47 </tr>
  48 <tr>
  49 <td class="function_type">
  50 <span class="returnvalue">void</span>
  51 </td>
  52 <td class="function_name">
  53 <a class="link" href="harfbuzz-hb-version.html#hb-version" title="hb_version ()">hb_version</a> <span class="c_punctuation">()</span>
  54 </td>
  55 </tr>
  56 <tr>
  57 <td class="function_type">
  58 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
  59 </td>
  60 <td class="function_name">
  61 <a class="link" href="harfbuzz-hb-version.html#hb-version-atleast" title="hb_version_atleast ()">hb_version_atleast</a> <span class="c_punctuation">()</span>
  62 </td>
  63 </tr>
  64 <tr>
  65 <td class="function_type">const <span class="returnvalue">char</span> *
  66 </td>
  67 <td class="function_name">
  68 <a class="link" href="harfbuzz-hb-version.html#hb-version-string" title="hb_version_string ()">hb_version_string</a> <span class="c_punctuation">()</span>
  69 </td>
  70 </tr>
  71 </tbody>
  72 </table></div>
  73 </div>
  74 <div class="refsect1">
  75 <a name="harfbuzz-hb-version.other"></a><h2>Types and Values</h2>
  76 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  77 <colgroup>
  78 <col width="150px" class="other_proto_type">
  79 <col class="other_proto_name">
  80 </colgroup>
  81 <tbody>
  82 <tr>
  83 <td class="define_keyword">#define</td>
  84 <td class="function_name"><a class="link" href="harfbuzz-hb-version.html#HB-VERSION-MAJOR:CAPS" title="HB_VERSION_MAJOR">HB_VERSION_MAJOR</a></td>
  85 </tr>
  86 <tr>
  87 <td class="define_keyword">#define</td>
  88 <td class="function_name"><a class="link" href="harfbuzz-hb-version.html#HB-VERSION-MICRO:CAPS" title="HB_VERSION_MICRO">HB_VERSION_MICRO</a></td>
  89 </tr>
  90 <tr>
  91 <td class="define_keyword">#define</td>
  92 <td class="function_name"><a class="link" href="harfbuzz-hb-version.html#HB-VERSION-MINOR:CAPS" title="HB_VERSION_MINOR">HB_VERSION_MINOR</a></td>
  93 </tr>
  94 <tr>
  95 <td class="define_keyword">#define</td>
  96 <td class="function_name"><a class="link" href="harfbuzz-hb-version.html#HB-VERSION-STRING:CAPS" title="HB_VERSION_STRING">HB_VERSION_STRING</a></td>
  97 </tr>
  98 </tbody>
  99 </table></div>
 100 </div>
 101 <div class="refsect1">
 102 <a name="harfbuzz-hb-version.includes"></a><h2>Includes</h2>
 103 <pre class="synopsis">#include &lt;hb.h&gt;
 104 </pre>
 105 </div>
 106 <div class="refsect1">
 107 <a name="harfbuzz-hb-version.description"></a><h2>Description</h2>
 108 <p>These functions and macros allow accessing version of the HarfBuzz
 109 library used at compile- as well as run-time, and to direct code
 110 conditionally based on those versions, again, at compile- or run-time.</p>
 111 </div>
 112 <div class="refsect1">
 113 <a name="harfbuzz-hb-version.functions_details"></a><h2>Functions</h2>
 114 <div class="refsect2">
 115 <a name="HB-VERSION-ATLEAST:CAPS"></a><h3>HB_VERSION_ATLEAST()</h3>
 116 <pre class="programlisting">#define             HB_VERSION_ATLEAST(major,minor,micro)</pre>
 117 <p>Tests the library version at compile-time against a minimum value,
 118 as three integer components.</p>
 119 <div class="refsect3">
 120 <a name="HB-VERSION-ATLEAST.parameters"></a><h4>Parameters</h4>
 121 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 122 <colgroup>
 123 <col width="150px" class="parameters_name">
 124 <col class="parameters_description">
 125 <col width="200px" class="parameters_annotations">
 126 </colgroup>
 127 <tbody>
 128 <tr>
 129 <td class="parameter_name"><p>major</p></td>
 130 <td class="parameter_description"><p>the major component of the version number</p></td>
 131 <td class="parameter_annotations"> </td>
 132 </tr>
 133 <tr>
 134 <td class="parameter_name"><p>minor</p></td>
 135 <td class="parameter_description"><p>the minor component of the version number</p></td>
 136 <td class="parameter_annotations"> </td>
 137 </tr>
 138 <tr>
 139 <td class="parameter_name"><p>micro</p></td>
 140 <td class="parameter_description"><p>the micro component of the version number</p></td>
 141 <td class="parameter_annotations"> </td>
 142 </tr>
 143 </tbody>
 144 </table></div>
 145 </div>
 146 </div>
 147 <hr>
 148 <div class="refsect2">
 149 <a name="hb-version"></a><h3>hb_version ()</h3>
 150 <pre class="programlisting"><span class="returnvalue">void</span>
 151 hb_version (<em class="parameter"><code>unsigned <span class="type">int</span> *major</code></em>,
 152             <em class="parameter"><code>unsigned <span class="type">int</span> *minor</code></em>,
 153             <em class="parameter"><code>unsigned <span class="type">int</span> *micro</code></em>);</pre>
 154 <p>Returns library version as three integer components.</p>
 155 <div class="refsect3">
 156 <a name="hb-version.parameters"></a><h4>Parameters</h4>
 157 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 158 <colgroup>
 159 <col width="150px" class="parameters_name">
 160 <col class="parameters_description">
 161 <col width="200px" class="parameters_annotations">
 162 </colgroup>
 163 <tbody>
 164 <tr>
 165 <td class="parameter_name"><p>major</p></td>
 166 <td class="parameter_description"><p>Library major version component. </p></td>
 167 <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>
 168 </tr>
 169 <tr>
 170 <td class="parameter_name"><p>minor</p></td>
 171 <td class="parameter_description"><p>Library minor version component. </p></td>
 172 <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>
 173 </tr>
 174 <tr>
 175 <td class="parameter_name"><p>micro</p></td>
 176 <td class="parameter_description"><p>Library micro version component. </p></td>
 177 <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>
 178 </tr>
 179 </tbody>
 180 </table></div>
 181 </div>
 182 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 183 </div>
 184 <hr>
 185 <div class="refsect2">
 186 <a name="hb-version-atleast"></a><h3>hb_version_atleast ()</h3>
 187 <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>
 188 hb_version_atleast (<em class="parameter"><code>unsigned <span class="type">int</span> major</code></em>,
 189                     <em class="parameter"><code>unsigned <span class="type">int</span> minor</code></em>,
 190                     <em class="parameter"><code>unsigned <span class="type">int</span> micro</code></em>);</pre>
 191 <p>Tests the library version against a minimum value,
 192 as three integer components.</p>
 193 <div class="refsect3">
 194 <a name="hb-version-atleast.parameters"></a><h4>Parameters</h4>
 195 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 196 <colgroup>
 197 <col width="150px" class="parameters_name">
 198 <col class="parameters_description">
 199 <col width="200px" class="parameters_annotations">
 200 </colgroup>
 201 <tbody>
 202 <tr>
 203 <td class="parameter_name"><p>major</p></td>
 204 <td class="parameter_description"><p>Library major version component</p></td>
 205 <td class="parameter_annotations"> </td>
 206 </tr>
 207 <tr>
 208 <td class="parameter_name"><p>minor</p></td>
 209 <td class="parameter_description"><p>Library minor version component</p></td>
 210 <td class="parameter_annotations"> </td>
 211 </tr>
 212 <tr>
 213 <td class="parameter_name"><p>micro</p></td>
 214 <td class="parameter_description"><p>Library micro version component</p></td>
 215 <td class="parameter_annotations"> </td>
 216 </tr>
 217 </tbody>
 218 </table></div>
 219 </div>
 220 <div class="refsect3">
 221 <a name="hb-version-atleast.returns"></a><h4>Returns</h4>
 222 <p> <code class="literal">true</code> if the library is equal to or greater than
 223 the test value, <code class="literal">false</code> otherwise</p>
 224 </div>
 225 <p class="since">Since: <a class="link" href="api-index-0-9-30.html#api-index-0.9.30">0.9.30</a></p>
 226 </div>
 227 <hr>
 228 <div class="refsect2">
 229 <a name="hb-version-string"></a><h3>hb_version_string ()</h3>
 230 <pre class="programlisting">const <span class="returnvalue">char</span> *
 231 hb_version_string (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 232 <p>Returns library version as a string with three components.</p>
 233 <div class="refsect3">
 234 <a name="hb-version-string.returns"></a><h4>Returns</h4>
 235 <p> Library version string</p>
 236 </div>
 237 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
 238 </div>
 239 </div>
 240 <div class="refsect1">
 241 <a name="harfbuzz-hb-version.other_details"></a><h2>Types and Values</h2>
 242 <div class="refsect2">
 243 <a name="HB-VERSION-MAJOR:CAPS"></a><h3>HB_VERSION_MAJOR</h3>
 244 <pre class="programlisting">#define HB_VERSION_MAJOR 3
 245 </pre>
 246 <p>The major component of the library version available at compile-time.</p>
 247 </div>
 248 <hr>
 249 <div class="refsect2">
 250 <a name="HB-VERSION-MICRO:CAPS"></a><h3>HB_VERSION_MICRO</h3>
 251 <pre class="programlisting">#define HB_VERSION_MICRO 0
 252 </pre>
 253 <p>The micro component of the library version available at compile-time.</p>
 254 </div>
 255 <hr>
 256 <div class="refsect2">
 257 <a name="HB-VERSION-MINOR:CAPS"></a><h3>HB_VERSION_MINOR</h3>
 258 <pre class="programlisting">#define HB_VERSION_MINOR 4
 259 </pre>
 260 <p>The minor component of the library version available at compile-time.</p>
 261 </div>
 262 <hr>
 263 <div class="refsect2">
 264 <a name="HB-VERSION-STRING:CAPS"></a><h3>HB_VERSION_STRING</h3>
 265 <pre class="programlisting">#define HB_VERSION_STRING "3.4.0"
 266 </pre>
 267 <p>A string literal containing the library version available at compile-time.</p>
 268 </div>
 269 </div>
 270 </div>
 271 <div class="footer">
 272 <hr>Generated by GTK-Doc V1.32</div>
 273 </body>
 274 </html>