modules/freetype2/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.3.7 API Reference</title>
   7 <style type="text/css">
   8   body { font-family: Verdana, Geneva, Arial, Helvetica, serif;
   9          color: #000000;
  10          background: #FFFFFF; }
  11
  12   p { text-align: justify; }
  13   h1 { text-align: center; }
  14   li { text-align: justify; }
  15   td { padding: 0 0.5em 0 0.5em; }
  16   td.left { padding: 0 0.5em 0 0.5em;
  17             text-align: left; }
  18
  19   a:link { color: #0000EF; }
  20   a:visited { color: #51188E; }
  21   a:hover { color: #FF0000; }
  22
  23   span.keyword { font-family: monospace;
  24                  text-align: left;
  25                  white-space: pre;
  26                  color: darkblue; }
  27
  28   pre.colored { color: blue; }
  29
  30   ul.empty { list-style-type: none; }
  31 </style>
  32 </head>
  33 <body>
  34
  35 <table align=center><tr><td><font size=-1>[<a href="ft2-index.html">Index</a>]</font></td>
  36 <td width="100%"></td>
  37 <td><font size=-1>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
  38 <center><h1>FreeType-2.3.7 API Reference</h1></center>
  39
  40 <center><h1>
  41 FreeType Version
  42 </h1></center>
  43 <h2>Synopsis</h2>
  44 <table align=center cellspacing=5 cellpadding=0 border=0>
  45 <tr><td></td><td><a href="#FREETYPE_XXX">FREETYPE_XXX</a></td><td></td><td><a href="#FT_Face_CheckTrueTypePatents">FT_Face_CheckTrueTypePatents</a></td></tr>
  46 <tr><td></td><td><a href="#FT_Library_Version">FT_Library_Version</a></td><td></td><td><a href="#FT_Face_SetUnpatentedHinting">FT_Face_SetUnpatentedHinting</a></td></tr>
  47 </table><br><br>
  48
  49 <table align=center width="87%"><tr><td>
  50 <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>
  51 </td></tr></table><br>
  52 <table align=center width="75%"><tr><td>
  53 <h4><a name="FREETYPE_XXX">FREETYPE_XXX</a></h4>
  54 <table align=center width="87%"><tr><td>
  55 Defined in FT_FREETYPE_H (freetype/freetype.h).
  56 </td></tr></table><br>
  57 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
  58
  59 #define <a href="ft2-version.html#FREETYPE_XXX">FREETYPE_MAJOR</a>  2
  60 #define <a href="ft2-version.html#FREETYPE_XXX">FREETYPE_MINOR</a>  3
  61 #define <a href="ft2-version.html#FREETYPE_XXX">FREETYPE_PATCH</a>  7
  62
  63 </pre></table><br>
  64 <table align=center width="87%"><tr><td>
  65 <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>
  66 </td></tr></table><br>
  67 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>values</b></em></td></tr><tr><td>
  68 <p></p>
  69 <table cellpadding=3 border=0>
  70 <tr valign=top><td><b>FREETYPE_MAJOR</b></td><td>
  71 <p>The major version number.</p>
  72 </td></tr>
  73 <tr valign=top><td><b>FREETYPE_MINOR</b></td><td>
  74 <p>The minor version number.</p>
  75 </td></tr>
  76 <tr valign=top><td><b>FREETYPE_PATCH</b></td><td>
  77 <p>The patch level.</p>
  78 </td></tr>
  79 </table>
  80 </td></tr></table>
  81 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
  82 <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>
  83 </td></tr></table>
  84 </td></tr></table>
  85 <hr width="75%">
  86 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
  87 <td width="100%"></td>
  88 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
  89
  90 <table align=center width="75%"><tr><td>
  91 <h4><a name="FT_Library_Version">FT_Library_Version</a></h4>
  92 <table align=center width="87%"><tr><td>
  93 Defined in FT_FREETYPE_H (freetype/freetype.h).
  94 </td></tr></table><br>
  95 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
  96
  97   FT_EXPORT( <span class="keyword">void</span> )
  98   <b>FT_Library_Version</b>( <a href="ft2-base_interface.html#FT_Library">FT_Library</a>   library,
  99                       <a href="ft2-basic_types.html#FT_Int">FT_Int</a>      *amajor,
 100                       <a href="ft2-basic_types.html#FT_Int">FT_Int</a>      *aminor,
 101                       <a href="ft2-basic_types.html#FT_Int">FT_Int</a>      *apatch );
 102
 103 </pre></table><br>
 104 <table align=center width="87%"><tr><td>
 105 <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>
 106 </td></tr></table><br>
 107 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
 108 <p></p>
 109 <table cellpadding=3 border=0>
 110 <tr valign=top><td><b>library</b></td><td>
 111 <p>A source library handle.</p>
 112 </td></tr>
 113 </table>
 114 </td></tr></table>
 115 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
 116 <p></p>
 117 <table cellpadding=3 border=0>
 118 <tr valign=top><td><b>amajor</b></td><td>
 119 <p>The major version number.</p>
 120 </td></tr>
 121 <tr valign=top><td><b>aminor</b></td><td>
 122 <p>The minor version number.</p>
 123 </td></tr>
 124 <tr valign=top><td><b>apatch</b></td><td>
 125 <p>The patch version number.</p>
 126 </td></tr>
 127 </table>
 128 </td></tr></table>
 129 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
 130 <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>
 131 <p>In such cases, the library version might not be available before the library object has been created.</p>
 132 </td></tr></table>
 133 </td></tr></table>
 134 <hr width="75%">
 135 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 136 <td width="100%"></td>
 137 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 138
 139 <table align=center width="75%"><tr><td>
 140 <h4><a name="FT_Face_CheckTrueTypePatents">FT_Face_CheckTrueTypePatents</a></h4>
 141 <table align=center width="87%"><tr><td>
 142 Defined in FT_FREETYPE_H (freetype/freetype.h).
 143 </td></tr></table><br>
 144 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 145
 146   FT_EXPORT( <a href="ft2-basic_types.html#FT_Bool">FT_Bool</a> )
 147   <b>FT_Face_CheckTrueTypePatents</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>  face );
 148
 149 </pre></table><br>
 150 <table align=center width="87%"><tr><td>
 151 <p>Parse all bytecode instructions of a TrueType font file to check whether any of the patented opcodes are used. This is only useful if you want to be able to use the unpatented hinter with fonts that do <b>not</b> use these opcodes.</p>
 152 <p>Note that this function parses <b>all</b> glyph instructions in the font file, which may be slow.</p>
 153 </td></tr></table><br>
 154 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
 155 <p></p>
 156 <table cellpadding=3 border=0>
 157 <tr valign=top><td><b>face</b></td><td>
 158 <p>A face handle.</p>
 159 </td></tr>
 160 </table>
 161 </td></tr></table>
 162 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
 163 <p>1&nbsp;if this is a TrueType font that uses one of the patented opcodes, 0&nbsp;otherwise.</p>
 164 </td></tr></table>
 165 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>since</b></em></td></tr><tr><td>
 166 <p>2.3.5</p>
 167 </td></tr></table>
 168 </td></tr></table>
 169 <hr width="75%">
 170 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 171 <td width="100%"></td>
 172 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 173
 174 <table align=center width="75%"><tr><td>
 175 <h4><a name="FT_Face_SetUnpatentedHinting">FT_Face_SetUnpatentedHinting</a></h4>
 176 <table align=center width="87%"><tr><td>
 177 Defined in FT_FREETYPE_H (freetype/freetype.h).
 178 </td></tr></table><br>
 179 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 180
 181   FT_EXPORT( <a href="ft2-basic_types.html#FT_Bool">FT_Bool</a> )
 182   <b>FT_Face_SetUnpatentedHinting</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>  face,
 183                                 <a href="ft2-basic_types.html#FT_Bool">FT_Bool</a>  value );
 184
 185 </pre></table><br>
 186 <table align=center width="87%"><tr><td>
 187 <p>Enable or disable the unpatented hinter for a given face. Only enable it if you have determined that the face doesn't use any patented opcodes (see <a href="ft2-version.html#FT_Face_CheckTrueTypePatents">FT_Face_CheckTrueTypePatents</a>).</p>
 188 </td></tr></table><br>
 189 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
 190 <p></p>
 191 <table cellpadding=3 border=0>
 192 <tr valign=top><td><b>face</b></td><td>
 193 <p>A face handle.</p>
 194 </td></tr>
 195 <tr valign=top><td><b>value</b></td><td>
 196 <p>New boolean setting.</p>
 197 </td></tr>
 198 </table>
 199 </td></tr></table>
 200 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
 201 <p>The old setting value. This will always be false if this is not a SFNT font, or if the unpatented hinter is not compiled in this instance of the library.</p>
 202 </td></tr></table>
 203 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>since</b></em></td></tr><tr><td>
 204 <p>2.3.5</p>
 205 </td></tr></table>
 206 </td></tr></table>
 207 <hr width="75%">
 208 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 209 <td width="100%"></td>
 210 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 211
 212 </body>
 213 </html>