docs/reference/ft2-cid_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 CID Fonts
  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_Get_CID_Registry_Ordering_Supplement">FT_Get_CID_Registry_Ordering_Supplement</a></td></tr>
  46 <tr><td></td><td><a href="#FT_Get_CID_Is_Internally_CID_Keyed">FT_Get_CID_Is_Internally_CID_Keyed</a></td></tr>
  47 <tr><td></td><td><a href="#FT_Get_CID_From_Glyph_Index">FT_Get_CID_From_Glyph_Index</a></td></tr>
  48 </table><br><br>
  49
  50 <table align=center width="87%"><tr><td>
  51 <p>This section contains the declaration of CID-keyed font specific functions.</p>
  52 </td></tr></table><br>
  53 <table align=center width="75%"><tr><td>
  54 <h4><a name="FT_Get_CID_Registry_Ordering_Supplement">FT_Get_CID_Registry_Ordering_Supplement</a></h4>
  55 <table align=center width="87%"><tr><td>
  56 Defined in FT_CID_H (freetype/ftcid.h).
  57 </td></tr></table><br>
  58 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
  59
  60   FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
  61   <b>FT_Get_CID_Registry_Ordering_Supplement</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>       face,
  62                                            <span class="keyword">const</span> <span class="keyword">char</span>*  *registry,
  63                                            <span class="keyword">const</span> <span class="keyword">char</span>*  *ordering,
  64                                            <a href="ft2-basic_types.html#FT_Int">FT_Int</a>       *supplement);
  65
  66 </pre></table><br>
  67 <table align=center width="87%"><tr><td>
  68 <p>Retrieve the Registry/Ordering/Supplement triple (also known as the "R/O/S") from a CID-keyed font.</p>
  69 </td></tr></table><br>
  70 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
  71 <p></p>
  72 <table cellpadding=3 border=0>
  73 <tr valign=top><td><b>face</b></td><td>
  74 <p>A handle to the input face.</p>
  75 </td></tr>
  76 </table>
  77 </td></tr></table>
  78 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
  79 <p></p>
  80 <table cellpadding=3 border=0>
  81 <tr valign=top><td><b>registry</b></td><td>
  82 <p>The registry, as a C&nbsp;string, owned by the face.</p>
  83 </td></tr>
  84 <tr valign=top><td><b>ordering</b></td><td>
  85 <p>The ordering, as a C&nbsp;string, owned by the face.</p>
  86 </td></tr>
  87 <tr valign=top><td><b>supplement</b></td><td>
  88 <p>The supplement.</p>
  89 </td></tr>
  90 </table>
  91 </td></tr></table>
  92 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
  93 <p>FreeType error code. 0&nbsp;means success.</p>
  94 </td></tr></table>
  95 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
  96 <p>This function only works with CID faces, returning an error otherwise.</p>
  97 </td></tr></table>
  98 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>since</b></em></td></tr><tr><td>
  99 <p>2.3.6</p>
 100 </td></tr></table>
 101 </td></tr></table>
 102 <hr width="75%">
 103 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 104 <td width="100%"></td>
 105 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 106
 107 <table align=center width="75%"><tr><td>
 108 <h4><a name="FT_Get_CID_Is_Internally_CID_Keyed">FT_Get_CID_Is_Internally_CID_Keyed</a></h4>
 109 <table align=center width="87%"><tr><td>
 110 Defined in FT_CID_H (freetype/ftcid.h).
 111 </td></tr></table><br>
 112 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 113
 114   FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
 115   <b>FT_Get_CID_Is_Internally_CID_Keyed</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>   face,
 116                                       <a href="ft2-basic_types.html#FT_Bool">FT_Bool</a>  *is_cid );
 117
 118 </pre></table><br>
 119 <table align=center width="87%"><tr><td>
 120 <p>Retrieve the type of the input face, CID keyed or not. In constrast to the <a href="ft2-base_interface.html#FT_IS_CID_KEYED">FT_IS_CID_KEYED</a> macro this function returns successfully also for CID-keyed fonts in an SNFT wrapper.</p>
 121 </td></tr></table><br>
 122 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
 123 <p></p>
 124 <table cellpadding=3 border=0>
 125 <tr valign=top><td><b>face</b></td><td>
 126 <p>A handle to the input face.</p>
 127 </td></tr>
 128 </table>
 129 </td></tr></table>
 130 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
 131 <p></p>
 132 <table cellpadding=3 border=0>
 133 <tr valign=top><td><b>is_cid</b></td><td>
 134 <p>The type of the face as an <a href="ft2-basic_types.html#FT_Bool">FT_Bool</a>.</p>
 135 </td></tr>
 136 </table>
 137 </td></tr></table>
 138 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
 139 <p>FreeType error code. 0&nbsp;means success.</p>
 140 </td></tr></table>
 141 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
 142 <p>This function only works with CID faces and OpenType fonts, returning an error otherwise.</p>
 143 </td></tr></table>
 144 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>since</b></em></td></tr><tr><td>
 145 <p>2.3.9</p>
 146 </td></tr></table>
 147 </td></tr></table>
 148 <hr width="75%">
 149 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 150 <td width="100%"></td>
 151 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 152
 153 <table align=center width="75%"><tr><td>
 154 <h4><a name="FT_Get_CID_From_Glyph_Index">FT_Get_CID_From_Glyph_Index</a></h4>
 155 <table align=center width="87%"><tr><td>
 156 Defined in FT_CID_H (freetype/ftcid.h).
 157 </td></tr></table><br>
 158 <table align=center width="87%"><tr bgcolor="#D6E8FF"><td><pre>
 159
 160   FT_EXPORT( <a href="ft2-basic_types.html#FT_Error">FT_Error</a> )
 161   <b>FT_Get_CID_From_Glyph_Index</b>( <a href="ft2-base_interface.html#FT_Face">FT_Face</a>   face,
 162                                <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a>   glyph_index,
 163                                <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a>  *cid );
 164
 165 </pre></table><br>
 166 <table align=center width="87%"><tr><td>
 167 <p>Retrieve the CID of the input glyph index.</p>
 168 </td></tr></table><br>
 169 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>input</b></em></td></tr><tr><td>
 170 <p></p>
 171 <table cellpadding=3 border=0>
 172 <tr valign=top><td><b>face</b></td><td>
 173 <p>A handle to the input face.</p>
 174 </td></tr>
 175 <tr valign=top><td><b>glyph_index</b></td><td>
 176 <p>The input glyph index.</p>
 177 </td></tr>
 178 </table>
 179 </td></tr></table>
 180 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>output</b></em></td></tr><tr><td>
 181 <p></p>
 182 <table cellpadding=3 border=0>
 183 <tr valign=top><td><b>cid</b></td><td>
 184 <p>The CID as an <a href="ft2-basic_types.html#FT_UInt">FT_UInt</a>.</p>
 185 </td></tr>
 186 </table>
 187 </td></tr></table>
 188 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>return</b></em></td></tr><tr><td>
 189 <p>FreeType error code. 0&nbsp;means success.</p>
 190 </td></tr></table>
 191 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>note</b></em></td></tr><tr><td>
 192 <p>This function only works with CID faces and OpenType fonts, returning an error otherwise.</p>
 193 </td></tr></table>
 194 <table align=center width="87%" cellpadding=5><tr bgcolor="#EEEEFF"><td><em><b>since</b></em></td></tr><tr><td>
 195 <p>2.3.9</p>
 196 </td></tr></table>
 197 </td></tr></table>
 198 <hr width="75%">
 199 <table align=center width="75%"><tr><td><font size=-2>[<a href="ft2-index.html">Index</a>]</font></td>
 200 <td width="100%"></td>
 201 <td><font size=-2>[<a href="ft2-toc.html">TOC</a>]</font></td></tr></table>
 202
 203 </body>
 204 </html>