docs/reference/ft2-version.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2 "http://www.w3.org/TR/html4/loose.dtd">
   3 <html>
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6 <title>FreeType-2.6.5 API Reference</title>
   7 <style type="text/css">
   8   a:link { color: #0000EF; }
   9   a:visited { color: #51188E; }
  10   a:hover { color: #FF0000; }
  11
  12   body { font-family: Verdana, Geneva, Arial, Helvetica, serif;
  13          color: #000000;
  14          background: #FFFFFF;
  15          width: 87%;
  16          margin: auto; }
  17
  18   div.section { width: 75%;
  19                 margin: auto; }
  20   div.section hr { margin: 4ex 0 1ex 0; }
  21   div.section h4 { background-color: #EEEEFF;
  22                    font-size: medium;
  23                    font-style: oblique;
  24                    font-weight: bold;
  25                    margin: 3ex 0 1.5ex 9%;
  26                    padding: 0.3ex 0 0.3ex 1%; }
  27   div.section p { margin: 1.5ex 0 1.5ex 10%; }
  28   div.section pre { margin: 3ex 0 3ex 9%;
  29                     background-color: #D6E8FF;
  30                     padding: 2ex 0 2ex 1%; }
  31   div.section table.fields { width: 90%;
  32                              margin: 1.5ex 0 1.5ex 10%; }
  33   div.section table.toc { width: 95%;
  34                           margin: 1.5ex 0 1.5ex 5%; }
  35   div.timestamp { text-align: center;
  36                   font-size: 69%;
  37                   margin: 1.5ex 0 1.5ex 0; }
  38
  39   h1 { text-align: center; }
  40   h3 { font-size: medium;
  41        margin: 4ex 0 1.5ex 0; }
  42
  43   p { text-align: justify; }
  44
  45   pre.colored { color: blue; }
  46
  47   span.keyword { font-family: monospace;
  48                  text-align: left;
  49                  white-space: pre;
  50                  color: darkblue; }
  51
  52   table.fields td.val { font-weight: bold;
  53                         text-align: right;
  54                         width: 30%;
  55                         vertical-align: baseline;
  56                         padding: 1ex 1em 1ex 0; }
  57   table.fields td.desc { vertical-align: baseline;
  58                          padding: 1ex 0 1ex 1em; }
  59   table.fields td.desc p:first-child { margin: 0; }
  60   table.fields td.desc p { margin: 1.5ex 0 0 0; }
  61   table.index { margin: 6ex auto 6ex auto;
  62                 border: 0;
  63                 border-collapse: separate;
  64                 border-spacing: 1em 0.3ex; }
  65   table.index tr { padding: 0; }
  66   table.index td { padding: 0; }
  67   table.index-toc-link { width: 100%;
  68                          border: 0;
  69                          border-spacing: 0;
  70                          margin: 1ex 0 1ex 0; }
  71   table.index-toc-link td.left { padding: 0 0.5em 0 0.5em;
  72                                  font-size: 83%;
  73                                  text-align: left; }
  74   table.index-toc-link td.middle { padding: 0 0.5em 0 0.5em;
  75                                    font-size: 83%;
  76                                    text-align: center; }
  77   table.index-toc-link td.right { padding: 0 0.5em 0 0.5em;
  78                                   font-size: 83%;
  79                                   text-align: right; }
  80   table.synopsis { margin: 6ex auto 6ex auto;
  81                    border: 0;
  82                    border-collapse: separate;
  83                    border-spacing: 2em 0.6ex; }
  84   table.synopsis tr { padding: 0; }
  85   table.synopsis td { padding: 0; }
  86   table.toc td.link { width: 30%;
  87                       text-align: right;
  88                       vertical-align: baseline;
  89                       padding: 1ex 1em 1ex 0; }
  90   table.toc td.desc { vertical-align: baseline;
  91                       padding: 1ex 0 1ex 1em;
  92                       text-align: left; }
  93   table.toc td.desc p:first-child { margin: 0;
  94                                     text-align: left; }
  95   table.toc td.desc p { margin: 1.5ex 0 0 0;
  96                         text-align: left; }
  97
  98 </style>
  99 </head>
 100 <body>
 101
 102 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table>
 103 <h1>FreeType-2.6.5 API Reference</h1>
 104
 105 <h1 id="version">FreeType Version</h1>
 106 <h2>Synopsis</h2>
 107 <table class="synopsis">
 108 <tr><td><a href="#FT_Library_Version">FT_Library_Version</a></td><td>&nbsp;</td></tr>
 109 <tr><td>&nbsp;</td><td><a href="#FT_Face_CheckTrueTypePatents">FT_Face_CheckTrueTypePatents</a></td></tr>
 110 <tr><td><a href="#FREETYPE_MAJOR">FREETYPE_MAJOR</a></td><td><a href="#FT_Face_SetUnpatentedHinting">FT_Face_SetUnpatentedHinting</a></td></tr>
 111 <tr><td><a href="#FREETYPE_MINOR">FREETYPE_MINOR</a></td><td>&nbsp;</td></tr>
 112 <tr><td><a href="#FREETYPE_PATCH">FREETYPE_PATCH</a></td><td><a href="#FREETYPE_XXX">FREETYPE_XXX</a></td></tr>
 113 </table>
 114
 115
 116 <p>Note that those functions and macros are of limited use because even a new release of FreeType with only documentation changes increases the version number.</p>
 117
 118 <div class="section">
 119 <h3 id="FT_Library_Version">FT_Library_Version</h3>
 120 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
 121 <pre>
 122   FT_EXPORT( <span class="keyword">void</span> )
 123   <b>FT_Library_Version</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a>   library,
 124                       <a href="ft2-basic_types.html#FT_Int">FT_Int</a>      *amajor,
 125                       <a href="ft2-basic_types.html#FT_Int">FT_Int</a>      *aminor,
 126                       <a href="ft2-basic_types.html#FT_Int">FT_Int</a>      *apatch );
 127 </pre>
 128
 129 <p>Return the version of the FreeType library being used. This is useful when dynamically linking to the library, since one cannot use the macros <a href="ft2-version.html#FREETYPE_XXX">FREETYPE_MAJOR</a>, <a href="ft2-version.html#FREETYPE_XXX">FREETYPE_MINOR</a>, and <a href="ft2-version.html#FREETYPE_XXX">FREETYPE_PATCH</a>.</p>
 130
 131 <h4>input</h4>
 132 <table class="fields">
 133 <tr><td class="val" id="library">library</td><td class="desc">
 134 <p>A source library handle.</p>
 135 </td></tr>
 136 </table>
 137
 138 <h4>output</h4>
 139 <table class="fields">
 140 <tr><td class="val" id="amajor">amajor</td><td class="desc">
 141 <p>The major version number.</p>
 142 </td></tr>
 143 <tr><td class="val" id="aminor">aminor</td><td class="desc">
 144 <p>The minor version number.</p>
 145 </td></tr>
 146 <tr><td class="val" id="apatch">apatch</td><td class="desc">
 147 <p>The patch version number.</p>
 148 </td></tr>
 149 </table>
 150
 151 <h4>note</h4>
 152 <p>The reason why this function takes a &lsquo;library&rsquo; argument is because certain programs implement library initialization in a custom way that doesn't use <a href="ft2-base_interface.html#FT_Init_FreeType">FT_Init_FreeType</a>.</p>
 153 <p>In such cases, the library version might not be available before the library object has been created.</p>
 154
 155 <hr>
 156 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 157
 158 <div class="section">
 159 <h3 id="FT_Face_CheckTrueTypePatents">FT_Face_CheckTrueTypePatents</h3>
 160 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
 161 <pre>
 162   FT_EXPORT( <a href="ft2-basic_types.html#FT_Bool">FT_Bool</a> )
 163   <b>FT_Face_CheckTrueTypePatents</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>  face );
 164 </pre>
 165
 166 <p>Deprecated, does nothing.</p>
 167
 168 <h4>input</h4>
 169 <table class="fields">
 170 <tr><td class="val" id="face">face</td><td class="desc">
 171 <p>A face handle.</p>
 172 </td></tr>
 173 </table>
 174
 175 <h4>return</h4>
 176 <p>Always returns false.</p>
 177
 178 <h4>note</h4>
 179 <p>Since May 2010, TrueType hinting is no longer patented.</p>
 180
 181 <h4>since</h4>
 182 <p>2.3.5</p>
 183
 184 <hr>
 185 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 186
 187 <div class="section">
 188 <h3 id="FT_Face_SetUnpatentedHinting">FT_Face_SetUnpatentedHinting</h3>
 189 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
 190 <pre>
 191   FT_EXPORT( <a href="ft2-basic_types.html#FT_Bool">FT_Bool</a> )
 192   <b>FT_Face_SetUnpatentedHinting</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>  face,
 193                                 <a href="ft2-basic_types.html#FT_Bool">FT_Bool</a>  value );
 194 </pre>
 195
 196 <p>Deprecated, does nothing.</p>
 197
 198 <h4>input</h4>
 199 <table class="fields">
 200 <tr><td class="val" id="face">face</td><td class="desc">
 201 <p>A face handle.</p>
 202 </td></tr>
 203 <tr><td class="val" id="value">value</td><td class="desc">
 204 <p>New boolean setting.</p>
 205 </td></tr>
 206 </table>
 207
 208 <h4>return</h4>
 209 <p>Always returns false.</p>
 210
 211 <h4>note</h4>
 212 <p>Since May 2010, TrueType hinting is no longer patented.</p>
 213
 214 <h4>since</h4>
 215 <p>2.3.5</p>
 216
 217 <hr>
 218 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 219
 220 <div class="section">
 221 <h3 id="FREETYPE_XXX">FREETYPE_XXX</h3>
 222 <p>Defined in FT_FREETYPE_H (freetype/freetype.h).</p>
 223 <pre>
 224 #define <a href="ft2-version.html#FREETYPE_MAJOR">FREETYPE_MAJOR</a>  2
 225 #define <a href="ft2-version.html#FREETYPE_MINOR">FREETYPE_MINOR</a>  6
 226 #define <a href="ft2-version.html#FREETYPE_PATCH">FREETYPE_PATCH</a>  5
 227 </pre>
 228
 229 <p>These three macros identify the FreeType source code version. Use <a href="ft2-version.html#FT_Library_Version">FT_Library_Version</a> to access them at runtime.</p>
 230
 231 <h4>values</h4>
 232 <table class="fields">
 233 <tr><td class="val" id="FREETYPE_MAJOR">FREETYPE_MAJOR</td><td class="desc">
 234 <p>The major version number.</p>
 235 </td></tr>
 236 <tr><td class="val" id="FREETYPE_MINOR">FREETYPE_MINOR</td><td class="desc">
 237 <p>The minor version number.</p>
 238 </td></tr>
 239 <tr><td class="val" id="FREETYPE_PATCH">FREETYPE_PATCH</td><td class="desc">
 240 <p>The patch level.</p>
 241 </td></tr>
 242 </table>
 243
 244 <h4>note</h4>
 245 <p>The version number of FreeType if built as a dynamic link library with the &lsquo;libtool&rsquo; package is <i>not</i> controlled by these three macros.</p>
 246
 247 <hr>
 248 <table class="index-toc-link"><tr><td class="left">[<a href="ft2-index.html">Index</a>]</td><td class="middle">[<a href="#">Top</a>]</td><td class="right">[<a href="ft2-toc.html">TOC</a>]</td></tr></table></div>
 249
 250 </body>
 251 </html>