Imported Upstream version 8.2.2
[platform/upstream/harfbuzz.git] / docs / html / harfbuzz-hb-directwrite.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-directwrite: HarfBuzz Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="index.html" title="HarfBuzz Manual">
8 <link rel="up" href="integration-api.html" title="Integration API">
9 <link rel="prev" href="harfbuzz-hb-gdi.html" title="hb-gdi">
10 <link rel="next" href="harfbuzz-hb-cairo.html" title="hb-cairo">
11 <meta name="generator" content="GTK-Doc V1.32 (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-directwrite.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="integration-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="harfbuzz-hb-gdi.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="harfbuzz-hb-cairo.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-directwrite"></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-directwrite.top_of_page"></a>hb-directwrite</span></h2>
30 <p>hb-directwrite — DirectWrite 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-directwrite.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-directwrite.html#hb-directwrite-face-create" title="hb_directwrite_face_create ()">hb_directwrite_face_create</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">IDWriteFontFace</span> *
53 </td>
54 <td class="function_name">
55 <a class="link" href="harfbuzz-hb-directwrite.html#hb-directwrite-face-get-font-face" title="hb_directwrite_face_get_font_face ()">hb_directwrite_face_get_font_face</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 </tbody>
59 </table></div>
60 </div>
61 <div class="refsect1">
62 <a name="harfbuzz-hb-directwrite.includes"></a><h2>Includes</h2>
63 <pre class="synopsis">#include &lt;hb-directwrite.h&gt;
64 </pre>
65 </div>
66 <div class="refsect1">
67 <a name="harfbuzz-hb-directwrite.description"></a><h2>Description</h2>
68 <p>Functions for using HarfBuzz with DirectWrite fonts.</p>
69 </div>
70 <div class="refsect1">
71 <a name="harfbuzz-hb-directwrite.functions_details"></a><h2>Functions</h2>
72 <div class="refsect2">
73 <a name="hb-directwrite-face-create"></a><h3>hb_directwrite_face_create ()</h3>
74 <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> *
75 hb_directwrite_face_create (<em class="parameter"><code><span class="type">IDWriteFontFace</span> *font_face</code></em>);</pre>
76 <p>Constructs a new face object from the specified DirectWrite IDWriteFontFace.</p>
77 <div class="refsect3">
78 <a name="hb-directwrite-face-create.parameters"></a><h4>Parameters</h4>
79 <div class="informaltable"><table class="informaltable" width="100%" border="0">
80 <colgroup>
81 <col width="150px" class="parameters_name">
82 <col class="parameters_description">
83 <col width="200px" class="parameters_annotations">
84 </colgroup>
85 <tbody><tr>
86 <td class="parameter_name"><p>font_face</p></td>
87 <td class="parameter_description"><p>a DirectWrite IDWriteFontFace object.</p></td>
88 <td class="parameter_annotations"> </td>
89 </tr></tbody>
90 </table></div>
91 </div>
92 <div class="refsect3">
93 <a name="hb-directwrite-face-create.returns"></a><h4>Returns</h4>
94 <p> <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> object corresponding to the given input</p>
95 </div>
96 <p class="since">Since: <a class="link" href="api-index-2-4-0.html#api-index-2.4.0">2.4.0</a></p>
97 </div>
98 <hr>
99 <div class="refsect2">
100 <a name="hb-directwrite-face-get-font-face"></a><h3>hb_directwrite_face_get_font_face ()</h3>
101 <pre class="programlisting"><span class="returnvalue">IDWriteFontFace</span> *
102 hb_directwrite_face_get_font_face (<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>
103 <p>Gets the DirectWrite IDWriteFontFace associated with <em class="parameter"><code>face</code></em>
104 .</p>
105 <div class="refsect3">
106 <a name="hb-directwrite-face-get-font-face.parameters"></a><h4>Parameters</h4>
107 <div class="informaltable"><table class="informaltable" width="100%" border="0">
108 <colgroup>
109 <col width="150px" class="parameters_name">
110 <col class="parameters_description">
111 <col width="200px" class="parameters_annotations">
112 </colgroup>
113 <tbody><tr>
114 <td class="parameter_name"><p>face</p></td>
115 <td class="parameter_description"><p>a <a class="link" href="harfbuzz-hb-face.html#hb-face-t" title="hb_face_t"><span class="type">hb_face_t</span></a> object</p></td>
116 <td class="parameter_annotations"> </td>
117 </tr></tbody>
118 </table></div>
119 </div>
120 <div class="refsect3">
121 <a name="hb-directwrite-face-get-font-face.returns"></a><h4>Returns</h4>
122 <p> DirectWrite IDWriteFontFace object corresponding to the given input</p>
123 </div>
124 <p class="since">Since: <a class="link" href="api-index-2-5-0.html#api-index-2.5.0">2.5.0</a></p>
125 </div>
126 </div>
127 </div>
128 <div class="footer">
129 <hr>Generated by GTK-Doc V1.32</div>
130 </body>
131 </html>