docs/reference/ft2-winfnt_fonts.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.4.9 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.4.9 API Reference</h1></center>
  39
  40 <center><h1>
  41 Window FNT Files
  42 </h1></center>
  43 <h2>Synopsis</h2>
  44 <table align=center cellspacing=5 cellpadding=0 border=0>
  45 <tr><td></td><td><a href="#FT_WinFNT_ID_XXX">FT_WinFNT_ID_XXX</a></td><td></td><td><a href="#FT_WinFNT_Header">FT_WinFNT_Header</a></td><td></td><td></td></tr>
  46 <tr><td></td><td><a href="#FT_WinFNT_HeaderRec">FT_WinFNT_HeaderRec</a></td><td></td><td><a href="#FT_Get_WinFNT_Header">FT_Get_WinFNT_Header</a></td><td></td><td></td></tr>
  47 </table><br><br>
  48
  49 <table align=center width="87%"><tr><td>
  50 <p>This section contains the declaration of Windows FNT specific functions.</p>
  51 </td></tr></table><br>
  52 <table align=center width="75%"><tr><td>
  53 <h4><a name="FT_WinFNT_ID_XXX">FT_WinFNT_ID_XXX</a></h4>
  54 <table align=center width="87%"><tr><td>
  55 Defined in FT_WINFONTS_H (freetype/ftwinfnt.h).
  56 </td></tr></table><br>
  57 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
  58
  59 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP1252</a>    0
  60 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_DEFAULT</a>   1
  61 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_SYMBOL</a>    2
  62 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_MAC</a>      77
  63 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP932</a>   128
  64 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP949</a>   129
  65 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP1361</a>  130
  66 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP936</a>   134
  67 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP950</a>   136
  68 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP1253</a>  161
  69 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP1254</a>  162
  70 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP1258</a>  163
  71 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP1255</a>  177
  72 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP1256</a>  178
  73 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP1257</a>  186
  74 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP1251</a>  204
  75 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP874</a>   222
  76 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_CP1250</a>  238
  77 #define <a href="ft2-winfnt_fonts.html#FT_WinFNT_ID_XXX">FT_WinFNT_ID_OEM</a>     255
  78
  79 </pre></table><br>
  80 <table align=center width="87%"><tr><td>
  81 <p>A list of valid values for the &lsquo;charset&rsquo; byte in <a href="ft2-winfnt_fonts.html#FT_WinFNT_HeaderRec">FT_WinFNT_HeaderRec</a>. Exact mapping tables for the various cpXXXX encodings (except for cp1361) can be found at ftp://ftp.unicode.org in the MAPPINGS/VENDORS/MICSFT/WINDOWS subdirectory. cp1361 is roughly a superset of MAPPINGS/OBSOLETE/EASTASIA/KSC/JOHAB.TXT.</p>
  82 </td></tr></table><br>
  83 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>values</b></em></td></tr><tr><td>
  84 <p></p>
  85 <table cellpadding=3 border=0>
  86 <tr valign=top><td><b>FT_WinFNT_ID_DEFAULT</b></td><td>
  87 <p>This is used for font enumeration and font creation as a &lsquo;don't care&rsquo; value. Valid font files don't contain this value. When querying for information about the character set of the font that is currently selected into a specified device context, this return value (of the related Windows API) simply denotes failure.</p>
  88 </td></tr>
  89 <tr valign=top><td><b>FT_WinFNT_ID_SYMBOL</b></td><td>
  90 <p>There is no known mapping table available.</p>
  91 </td></tr>
  92 <tr valign=top><td><b>FT_WinFNT_ID_MAC</b></td><td>
  93 <p>Mac Roman encoding.</p>
  94 </td></tr>
  95 <tr valign=top><td><b>FT_WinFNT_ID_OEM</b></td><td>
  96 <p>From Michael Pöttgen &lt;michael@poettgen.de&gt;:</p>
  97 <p>The &lsquo;Windows Font Mapping&rsquo; article says that FT_WinFNT_ID_OEM is used for the charset of vector fonts, like &lsquo;modern.fon&rsquo;, &lsquo;roman.fon&rsquo;, and &lsquo;script.fon&rsquo; on Windows.</p>
  98 <p>The &lsquo;CreateFont&rsquo; documentation says: The FT_WinFNT_ID_OEM value specifies a character set that is operating-system dependent.</p>
  99 <p>The &lsquo;IFIMETRICS&rsquo; documentation from the &lsquo;Windows Driver Development Kit&rsquo; says: This font supports an OEM-specific character set. The OEM character set is system dependent.</p>
 100 <p>In general OEM, as opposed to ANSI (i.e., cp1252), denotes the second default codepage that most international versions of Windows have. It is one of the OEM codepages from</p>
 101 <p>http://www.microsoft.com/globaldev/reference/cphome.mspx,</p>
 102 <p>and is used for the &lsquo;DOS boxes&rsquo;, to support legacy applications. A German Windows version for example usually uses ANSI codepage 1252 and OEM codepage 850.</p>
 103 </td></tr>
 104 <tr valign=top><td><b>FT_WinFNT_ID_CP874</b></td><td>
 105 <p>A superset of Thai TIS 620 and ISO 8859-11.</p>
 106 </td></tr>
 107 <tr valign=top><td><b>FT_WinFNT_ID_CP932</b></td><td>
 108 <p>A superset of Japanese Shift-JIS (with minor deviations).</p>
 109 </td></tr>
 110 <tr valign=top><td><b>FT_WinFNT_ID_CP936</b></td><td>
 111 <p>A superset of simplified Chinese GB 2312-1980 (with different ordering and minor deviations).</p>
 112 </td></tr>
 113 <tr valign=top><td><b>FT_WinFNT_ID_CP949</b></td><td>
 114 <p>A superset of Korean Hangul KS&nbsp;C 5601-1987 (with different ordering and minor deviations).</p>
 115 </td></tr>
 116 <tr valign=top><td><b>FT_WinFNT_ID_CP950</b></td><td>
 117 <p>A superset of traditional Chinese Big&nbsp;5 ETen (with different ordering and minor deviations).</p>
 118 </td></tr>
 119 <tr valign=top><td><b>FT_WinFNT_ID_CP1250</b></td><td>
 120 <p>A superset of East European ISO 8859-2 (with slightly different ordering).</p>
 121 </td></tr>
 122 <tr valign=top><td><b>FT_WinFNT_ID_CP1251</b></td><td>
 123 <p>A superset of Russian ISO 8859-5 (with different ordering).</p>
 124 </td></tr>
 125 <tr valign=top><td><b>FT_WinFNT_ID_CP1252</b></td><td>
 126 <p>ANSI encoding. A superset of ISO 8859-1.</p>
 127 </td></tr>
 128 <tr valign=top><td><b>FT_WinFNT_ID_CP1253</b></td><td>
 129 <p>A superset of Greek ISO 8859-7 (with minor modifications).</p>
 130 </td></tr>
 131 <tr valign=top><td><b>FT_WinFNT_ID_CP1254</b></td><td>
 132 <p>A superset of Turkish ISO 8859-9.</p>
 133 </td></tr>
 134 <tr valign=top><td><b>FT_WinFNT_ID_CP1255</b></td><td>
 135 <p>A superset of Hebrew ISO 8859-8 (with some modifications).</p>
 136 </td></tr>
 137 <tr valign=top><td><b>FT_WinFNT_ID_CP1256</b></td><td>
 138 <p>A superset of Arabic ISO 8859-6 (with different ordering).</p>
 139 </td></tr>
 140 <tr valign=top><td><b>FT_WinFNT_ID_CP1257</b></td><td>
 141 <p>A superset of Baltic ISO 8859-13 (with some deviations).</p>
 142 </td></tr>
 143 <tr valign=top><td><b>FT_WinFNT_ID_CP1258</b></td><td>
 144 <p>For Vietnamese. This encoding doesn't cover all necessary characters.</p>
 145 </td></tr>
 146 <tr valign=top><td><b>FT_WinFNT_ID_CP1361</b></td><td>
 147 <p>Korean (Johab).</p>
 148 </td></tr>
 149 </table>
 150 </td></tr></table>
 151 </td></tr></table>
 152 <hr width="75%">
 153 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 154 <td width="100%"></td>
 155 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 156
 157 <table align=center width="75%"><tr><td>
 158 <h4><a name="FT_WinFNT_HeaderRec">FT_WinFNT_HeaderRec</a></h4>
 159 <table align=center width="87%"><tr><td>
 160 Defined in FT_WINFONTS_H (freetype/ftwinfnt.h).
 161 </td></tr></table><br>
 162 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 163
 164   <span class="keyword">typedef</span> <span class="keyword">struct</span>  FT_WinFNT_HeaderRec_
 165   {
 166     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  version;
 167     <a href="ft2-basic_types.html#FT_ULong">FT_ULong</a>   file_size;
 168     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    copyright[60];
 169     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  file_type;
 170     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  nominal_point_size;
 171     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  vertical_resolution;
 172     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  horizontal_resolution;
 173     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  ascent;
 174     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  internal_leading;
 175     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  external_leading;
 176     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    italic;
 177     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    underline;
 178     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    strike_out;
 179     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  weight;
 180     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    charset;
 181     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  pixel_width;
 182     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  pixel_height;
 183     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    pitch_and_family;
 184     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  avg_width;
 185     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  max_width;
 186     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    first_char;
 187     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    last_char;
 188     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    default_char;
 189     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    break_char;
 190     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  bytes_per_row;
 191     <a href="ft2-basic_types.html#FT_ULong">FT_ULong</a>   device_offset;
 192     <a href="ft2-basic_types.html#FT_ULong">FT_ULong</a>   face_name_offset;
 193     <a href="ft2-basic_types.html#FT_ULong">FT_ULong</a>   bits_pointer;
 194     <a href="ft2-basic_types.html#FT_ULong">FT_ULong</a>   bits_offset;
 195     <a href="ft2-basic_types.html#FT_Byte">FT_Byte</a>    reserved;
 196     <a href="ft2-basic_types.html#FT_ULong">FT_ULong</a>   flags;
 197     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  A_space;
 198     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  B_space;
 199     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  C_space;
 200     <a href="ft2-basic_types.html#FT_UShort">FT_UShort</a>  color_table_offset;
 201     <a href="ft2-basic_types.html#FT_ULong">FT_ULong</a>   reserved1[4];
 202
 203   } <b>FT_WinFNT_HeaderRec</b>;
 204
 205 </pre></table><br>
 206 <table align=center width="87%"><tr><td>
 207 <p>Windows FNT Header info.</p>
 208 </td></tr></table><br>
 209 </td></tr></table>
 210 <hr width="75%">
 211 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 212 <td width="100%"></td>
 213 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 214
 215 <table align=center width="75%"><tr><td>
 216 <h4><a name="FT_WinFNT_Header">FT_WinFNT_Header</a></h4>
 217 <table align=center width="87%"><tr><td>
 218 Defined in FT_WINFONTS_H (freetype/ftwinfnt.h).
 219 </td></tr></table><br>
 220 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 221
 222   <span class="keyword">typedef</span> <span class="keyword">struct</span> FT_WinFNT_HeaderRec_*  <b>FT_WinFNT_Header</b>;
 223
 224 </pre></table><br>
 225 <table align=center width="87%"><tr><td>
 226 <p>A handle to an <a href="ft2-winfnt_fonts.html#FT_WinFNT_HeaderRec">FT_WinFNT_HeaderRec</a> structure.</p>
 227 </td></tr></table><br>
 228 </td></tr></table>
 229 <hr width="75%">
 230 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 231 <td width="100%"></td>
 232 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 233
 234 <table align=center width="75%"><tr><td>
 235 <h4><a name="FT_Get_WinFNT_Header">FT_Get_WinFNT_Header</a></h4>
 236 <table align=center width="87%"><tr><td>
 237 Defined in FT_WINFONTS_H (freetype/ftwinfnt.h).
 238 </td></tr></table><br>
 239 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 240
 241   FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
 242   <b>FT_Get_WinFNT_Header</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>               face,
 243                         <a href="ft2-winfnt_fonts.html#FT_WinFNT_HeaderRec">FT_WinFNT_HeaderRec</a>  *aheader );
 244
 245 </pre></table><br>
 246 <table align=center width="87%"><tr><td>
 247 <p>Retrieve a Windows FNT font info header.</p>
 248 </td></tr></table><br>
 249 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
 250 <p></p>
 251 <table cellpadding=3 border=0>
 252 <tr valign=top><td><b>face</b></td><td>
 253 <p>A handle to the input face.</p>
 254 </td></tr>
 255 </table>
 256 </td></tr></table>
 257 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
 258 <p></p>
 259 <table cellpadding=3 border=0>
 260 <tr valign=top><td><b>aheader</b></td><td>
 261 <p>The WinFNT header.</p>
 262 </td></tr>
 263 </table>
 264 </td></tr></table>
 265 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
 266 <p>FreeType error code. 0&nbsp;means success.</p>
 267 </td></tr></table>
 268 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
 269 <p>This function only works with Windows FNT faces, returning an error otherwise.</p>
 270 </td></tr></table>
 271 </td></tr></table>
 272 <hr width="75%">
 273 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 274 <td width="100%"></td>
 275 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 276
 277 </body>
 278 </html>