docs/html/harfbuzz-hb-coretext.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-coretext: HarfBuzz Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
   7 <link rel="home" href="index.html" title="HarfBuzz Manual">
   8 <link rel="up" href="ch15.html" title="Integration API">
   9 <link rel="prev" href="ch15.html" title="Integration API">
  10 <link rel="next" href="harfbuzz-hb-ft.html" title="hb-ft">
  11 <meta name="generator" content="GTK-Doc V1.32.1 (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-coretext.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="ch15.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="ch15.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="harfbuzz-hb-ft.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-coretext"></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-coretext.top_of_page"></a>hb-coretext</span></h2>
  30 <p>hb-coretext — CoreText integration</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-coretext.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="function_type">
  44 <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
  45 </td>
  46 <td class="function_name">
  47 <a class="link" href="harfbuzz-hb-coretext.html#hb-coretext-face-create" title="hb_coretext_face_create ()">hb_coretext_face_create</a> <span class="c_punctuation">()</span>
  48 </td>
  49 </tr>
  50 <tr>
  51 <td class="function_type">
  52 <a class="link" href="harfbuzz-hb-font.html#hb-font-t" title="hb_font_t"><span class="returnvalue">hb_font_t</span></a> *
  53 </td>
  54 <td class="function_name">
  55 <a class="link" href="harfbuzz-hb-coretext.html#hb-coretext-font-create" title="hb_coretext_font_create ()">hb_coretext_font_create</a> <span class="c_punctuation">()</span>
  56 </td>
  57 </tr>
  58 <tr>
  59 <td class="function_type">
  60 <span class="returnvalue">CGFontRef</span>
  61 </td>
  62 <td class="function_name">
  63 <a class="link" href="harfbuzz-hb-coretext.html#hb-coretext-face-get-cg-font" title="hb_coretext_face_get_cg_font ()">hb_coretext_face_get_cg_font</a> <span class="c_punctuation">()</span>
  64 </td>
  65 </tr>
  66 <tr>
  67 <td class="function_type">
  68 <span class="returnvalue">CTFontRef</span>
  69 </td>
  70 <td class="function_name">
  71 <a class="link" href="harfbuzz-hb-coretext.html#hb-coretext-font-get-ct-font" title="hb_coretext_font_get_ct_font ()">hb_coretext_font_get_ct_font</a> <span class="c_punctuation">()</span>
  72 </td>
  73 </tr>
  74 </tbody>
  75 </table></div>
  76 </div>
  77 <div class="refsect1">
  78 <a name="harfbuzz-hb-coretext.other"></a><h2>Types and Values</h2>
  79 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  80 <colgroup>
  81 <col width="150px" class="other_proto_type">
  82 <col class="other_proto_name">
  83 </colgroup>
  84 <tbody>
  85 <tr>
  86 <td class="define_keyword">#define</td>
  87 <td class="function_name"><a class="link" href="harfbuzz-hb-coretext.html#HB-CORETEXT-TAG-KERX:CAPS" title="HB_CORETEXT_TAG_KERX">HB_CORETEXT_TAG_KERX</a></td>
  88 </tr>
  89 <tr>
  90 <td class="define_keyword">#define</td>
  91 <td class="function_name"><a class="link" href="harfbuzz-hb-coretext.html#HB-CORETEXT-TAG-MORT:CAPS" title="HB_CORETEXT_TAG_MORT">HB_CORETEXT_TAG_MORT</a></td>
  92 </tr>
  93 <tr>
  94 <td class="define_keyword">#define</td>
  95 <td class="function_name"><a class="link" href="harfbuzz-hb-coretext.html#HB-CORETEXT-TAG-MORX:CAPS" title="HB_CORETEXT_TAG_MORX">HB_CORETEXT_TAG_MORX</a></td>
  96 </tr>
  97 </tbody>
  98 </table></div>
  99 </div>
 100 <div class="refsect1">
 101 <a name="harfbuzz-hb-coretext.includes"></a><h2>Includes</h2>
 102 <pre class="synopsis">#include &lt;hb-coretext.h&gt;
 103 </pre>
 104 </div>
 105 <div class="refsect1">
 106 <a name="harfbuzz-hb-coretext.description"></a><h2>Description</h2>
 107 <p>Functions for using HarfBuzz with the CoreText fonts.</p>
 108 </div>
 109 <div class="refsect1">
 110 <a name="harfbuzz-hb-coretext.functions_details"></a><h2>Functions</h2>
 111 <div class="refsect2">
 112 <a name="hb-coretext-face-create"></a><h3>hb_coretext_face_create ()</h3>
 113 <pre class="programlisting"><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="returnvalue">hb_face_t</span></a> *
 114 hb_coretext_face_create (<em class="parameter"><code><span class="type">CGFontRef</span> cg_font</code></em>);</pre>
 115 <p>Creates an <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> face object from the specified
 116 CGFontRef.</p>
 117 <div class="refsect3">
 118 <a name="hb-coretext-face-create.parameters"></a><h4>Parameters</h4>
 119 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 120 <colgroup>
 121 <col width="150px" class="parameters_name">
 122 <col class="parameters_description">
 123 <col width="200px" class="parameters_annotations">
 124 </colgroup>
 125 <tbody><tr>
 126 <td class="parameter_name"><p>cg_font</p></td>
 127 <td class="parameter_description"><p>The CGFontRef to work upon</p></td>
 128 <td class="parameter_annotations"> </td>
 129 </tr></tbody>
 130 </table></div>
 131 </div>
 132 <div class="refsect3">
 133 <a name="hb-coretext-face-create.returns"></a><h4>Returns</h4>
 134 <p> the new <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> face object</p>
 135 </div>
 136 <p class="since">Since: <a class="link" href="api-index-0-9-10.html#api-index-0.9.10">0.9.10</a></p>
 137 </div>
 138 <hr>
 139 <div class="refsect2">
 140 <a name="hb-coretext-font-create"></a><h3>hb_coretext_font_create ()</h3>
 141 <pre class="programlisting"><a class="link" href="harfbuzz-hb-font.html#hb-font-t" title="hb_font_t"><span class="returnvalue">hb_font_t</span></a> *
 142 hb_coretext_font_create (<em class="parameter"><code><span class="type">CTFontRef</span> ct_font</code></em>);</pre>
 143 <p>Creates an <a class="link" href="harfbuzz-hb-font.html#hb-font-t" title="hb_font_t"><span class="type">hb_font_t</span></a> font object from the specified
 144 CTFontRef.</p>
 145 <div class="refsect3">
 146 <a name="hb-coretext-font-create.parameters"></a><h4>Parameters</h4>
 147 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 148 <colgroup>
 149 <col width="150px" class="parameters_name">
 150 <col class="parameters_description">
 151 <col width="200px" class="parameters_annotations">
 152 </colgroup>
 153 <tbody><tr>
 154 <td class="parameter_name"><p>ct_font</p></td>
 155 <td class="parameter_description"><p>The CTFontRef to work upon</p></td>
 156 <td class="parameter_annotations"> </td>
 157 </tr></tbody>
 158 </table></div>
 159 </div>
 160 <div class="refsect3">
 161 <a name="hb-coretext-font-create.returns"></a><h4>Returns</h4>
 162 <p> the new <a class="link" href="harfbuzz-hb-font.html#hb-font-t" title="hb_font_t"><span class="type">hb_font_t</span></a> font object</p>
 163 </div>
 164 <p class="since">Since: 1.7.2</p>
 165 </div>
 166 <hr>
 167 <div class="refsect2">
 168 <a name="hb-coretext-face-get-cg-font"></a><h3>hb_coretext_face_get_cg_font ()</h3>
 169 <pre class="programlisting"><span class="returnvalue">CGFontRef</span>
 170 hb_coretext_face_get_cg_font (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> *face</code></em>);</pre>
 171 <p>Fetches the CGFontRef associated with an <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a>
 172 face object</p>
 173 <div class="refsect3">
 174 <a name="hb-coretext-face-get-cg-font.parameters"></a><h4>Parameters</h4>
 175 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 176 <colgroup>
 177 <col width="150px" class="parameters_name">
 178 <col class="parameters_description">
 179 <col width="200px" class="parameters_annotations">
 180 </colgroup>
 181 <tbody><tr>
 182 <td class="parameter_name"><p>face</p></td>
 183 <td class="parameter_description"><p>The <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> to work upon</p></td>
 184 <td class="parameter_annotations"> </td>
 185 </tr></tbody>
 186 </table></div>
 187 </div>
 188 <div class="refsect3">
 189 <a name="hb-coretext-face-get-cg-font.returns"></a><h4>Returns</h4>
 190 <p> the CGFontRef found</p>
 191 </div>
 192 <p class="since">Since: <a class="link" href="api-index-0-9-10.html#api-index-0.9.10">0.9.10</a></p>
 193 </div>
 194 <hr>
 195 <div class="refsect2">
 196 <a name="hb-coretext-font-get-ct-font"></a><h3>hb_coretext_font_get_ct_font ()</h3>
 197 <pre class="programlisting"><span class="returnvalue">CTFontRef</span>
 198 hb_coretext_font_get_ct_font (<em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-font-t" title="hb_font_t"><span class="type">hb_font_t</span></a> *font</code></em>);</pre>
 199 </div>
 200 </div>
 201 <div class="refsect1">
 202 <a name="harfbuzz-hb-coretext.other_details"></a><h2>Types and Values</h2>
 203 <div class="refsect2">
 204 <a name="HB-CORETEXT-TAG-KERX:CAPS"></a><h3>HB_CORETEXT_TAG_KERX</h3>
 205 <pre class="programlisting">#define HB_CORETEXT_TAG_KERX HB_TAG('k','e','r','x')
 206 </pre>
 207 <p>The <a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> tag for the <code class="literal">kerx</code> (extended kerning) table, which
 208 holds AAT kerning information. </p>
 209 <p>For more information, see
 210
 211 https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6kerx.html</p>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="HB-CORETEXT-TAG-MORT:CAPS"></a><h3>HB_CORETEXT_TAG_MORT</h3>
 216 <pre class="programlisting">#define HB_CORETEXT_TAG_MORT HB_TAG('m','o','r','t')
 217 </pre>
 218 <p>The <a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> tag for the <code class="literal">mort</code> (glyph metamorphosis) table,
 219 which holds AAT features. </p>
 220 <p>For more information, see
 221
 222 https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6mort.html</p>
 223 </div>
 224 <hr>
 225 <div class="refsect2">
 226 <a name="HB-CORETEXT-TAG-MORX:CAPS"></a><h3>HB_CORETEXT_TAG_MORX</h3>
 227 <pre class="programlisting">#define HB_CORETEXT_TAG_MORX HB_TAG('m','o','r','x')
 228 </pre>
 229 <p>The <a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> tag for the <code class="literal">morx</code> (extended glyph metamorphosis)
 230 table, which holds AAT features. </p>
 231 <p>For more information, see
 232 https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6morx.html</p>
 233 </div>
 234 </div>
 235 </div>
 236 <div class="footer">
 237 <hr>Generated by GTK-Doc V1.32.1</div>
 238 </body>
 239 </html>