Git init
[external/pango1.0.git] / docs / xml / xft-fonts.xml
1 <refentry id="pango-Xft-Fonts-and-Rendering">
2 <refmeta>
3 <refentrytitle role="top_of_page" id="pango-Xft-Fonts-and-Rendering.top_of_page">Xft Fonts and Rendering</refentrytitle>
4 <manvolnum>3</manvolnum>
5 <refmiscinfo>PANGO Library</refmiscinfo>
6 </refmeta>
7
8 <refnamediv>
9 <refname>Xft Fonts and Rendering</refname>
10 <refpurpose>Font handling and rendering with the Xft backend</refpurpose>
11 </refnamediv>
12
13 <refsynopsisdiv id="pango-Xft-Fonts-and-Rendering.synopsis" role="synopsis">
14 <title role="synopsis.title">Synopsis</title>
15 <anchor id="PangoXftFont"/><anchor id="PangoXftFontMap"/><anchor id="PangoXftRenderer"/>
16 <synopsis>
17                     <link linkend="PangoXftFont-struct">PangoXftFont</link>;
18                     <link linkend="PangoXftFontMap-struct">PangoXftFontMap</link>;
19 #define             <link linkend="PANGO-RENDER-TYPE-XFT--CAPS">PANGO_RENDER_TYPE_XFT</link>
20 <link linkend="PangoContext">PangoContext</link> *      <link linkend="pango-xft-get-context">pango_xft_get_context</link>               (<link linkend="Display">Display</link> *display,
21                                                          <link linkend="int">int</link> screen);
22 <link linkend="PangoFontMap">PangoFontMap</link> *      <link linkend="pango-xft-get-font-map">pango_xft_get_font_map</link>              (<link linkend="Display">Display</link> *display,
23                                                          <link linkend="int">int</link> screen);
24 <link linkend="void">void</link>                <link linkend="pango-xft-set-default-substitute">pango_xft_set_default_substitute</link>    (<link linkend="Display">Display</link> *display,
25                                                          <link linkend="int">int</link> screen,
26                                                          <link linkend="PangoXftSubstituteFunc">PangoXftSubstituteFunc</link> func,
27                                                          <link linkend="gpointer">gpointer</link> data,
28                                                          <link linkend="GDestroyNotify">GDestroyNotify</link> notify);
29 <link linkend="void">void</link>                (<link linkend="PangoXftSubstituteFunc">*PangoXftSubstituteFunc</link>)           (<link linkend="FcPattern">FcPattern</link> *pattern,
30                                                          <link linkend="gpointer">gpointer</link> data);
31 <link linkend="void">void</link>                <link linkend="pango-xft-substitute-changed">pango_xft_substitute_changed</link>        (<link linkend="Display">Display</link> *display,
32                                                          <link linkend="int">int</link> screen);
33 <link linkend="void">void</link>                <link linkend="pango-xft-shutdown-display">pango_xft_shutdown_display</link>          (<link linkend="Display">Display</link> *display,
34                                                          <link linkend="int">int</link> screen);
35 <link linkend="XftFont">XftFont</link> *           <link linkend="pango-xft-font-get-font">pango_xft_font_get_font</link>             (<link linkend="PangoFont">PangoFont</link> *font);
36 <link linkend="Display">Display</link> *           <link linkend="pango-xft-font-get-display">pango_xft_font_get_display</link>          (<link linkend="PangoFont">PangoFont</link> *font);
37 <link linkend="gboolean">gboolean</link>            <link linkend="pango-xft-font-has-char">pango_xft_font_has_char</link>             (<link linkend="PangoFont">PangoFont</link> *font,
38                                                          <link linkend="gunichar">gunichar</link> wc);
39 <link linkend="FT-Face">FT_Face</link>             <link linkend="pango-xft-font-lock-face">pango_xft_font_lock_face</link>            (<link linkend="PangoFont">PangoFont</link> *font);
40 <link linkend="void">void</link>                <link linkend="pango-xft-font-unlock-face">pango_xft_font_unlock_face</link>          (<link linkend="PangoFont">PangoFont</link> *font);
41 <link linkend="guint">guint</link>               <link linkend="pango-xft-font-get-glyph">pango_xft_font_get_glyph</link>            (<link linkend="PangoFont">PangoFont</link> *font,
42                                                          <link linkend="gunichar">gunichar</link> wc);
43 <link linkend="PangoGlyph">PangoGlyph</link>          <link linkend="pango-xft-font-get-unknown-glyph">pango_xft_font_get_unknown_glyph</link>    (<link linkend="PangoFont">PangoFont</link> *font,
44                                                          <link linkend="gunichar">gunichar</link> wc);
45                     <link linkend="PangoXftRenderer-struct">PangoXftRenderer</link>;
46                     <link linkend="PangoXftRendererClass">PangoXftRendererClass</link>;
47 <link linkend="PangoRenderer">PangoRenderer</link> *     <link linkend="pango-xft-renderer-new">pango_xft_renderer_new</link>              (<link linkend="Display">Display</link> *display,
48                                                          <link linkend="int">int</link> screen);
49 <link linkend="void">void</link>                <link linkend="pango-xft-renderer-set-draw">pango_xft_renderer_set_draw</link>         (<link linkend="PangoXftRenderer">PangoXftRenderer</link> *xftrenderer,
50                                                          <link linkend="XftDraw">XftDraw</link> *draw);
51 <link linkend="void">void</link>                <link linkend="pango-xft-renderer-set-default-color">pango_xft_renderer_set_default_color</link>
52                                                         (<link linkend="PangoXftRenderer">PangoXftRenderer</link> *xftrenderer,
53                                                          <link linkend="PangoColor">PangoColor</link> *default_color);
54 <link linkend="void">void</link>                <link linkend="pango-xft-render">pango_xft_render</link>                    (<link linkend="XftDraw">XftDraw</link> *draw,
55                                                          <link linkend="XftColor">XftColor</link> *color,
56                                                          <link linkend="PangoFont">PangoFont</link> *font,
57                                                          <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
58                                                          <link linkend="gint">gint</link> x,
59                                                          <link linkend="gint">gint</link> y);
60 <link linkend="void">void</link>                <link linkend="pango-xft-picture-render">pango_xft_picture_render</link>            (<link linkend="Display">Display</link> *display,
61                                                          <link linkend="Picture">Picture</link> src_picture,
62                                                          <link linkend="Picture">Picture</link> dest_picture,
63                                                          <link linkend="PangoFont">PangoFont</link> *font,
64                                                          <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
65                                                          <link linkend="gint">gint</link> x,
66                                                          <link linkend="gint">gint</link> y);
67 <link linkend="void">void</link>                <link linkend="pango-xft-render-transformed">pango_xft_render_transformed</link>        (<link linkend="XftDraw">XftDraw</link> *draw,
68                                                          <link linkend="XftColor">XftColor</link> *color,
69                                                          <link linkend="PangoMatrix">PangoMatrix</link> *matrix,
70                                                          <link linkend="PangoFont">PangoFont</link> *font,
71                                                          <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
72                                                          <link linkend="int">int</link> x,
73                                                          <link linkend="int">int</link> y);
74 <link linkend="void">void</link>                <link linkend="pango-xft-render-layout-line">pango_xft_render_layout_line</link>        (<link linkend="XftDraw">XftDraw</link> *draw,
75                                                          <link linkend="XftColor">XftColor</link> *color,
76                                                          <link linkend="PangoLayoutLine">PangoLayoutLine</link> *line,
77                                                          <link linkend="int">int</link> x,
78                                                          <link linkend="int">int</link> y);
79 <link linkend="void">void</link>                <link linkend="pango-xft-render-layout">pango_xft_render_layout</link>             (<link linkend="XftDraw">XftDraw</link> *draw,
80                                                          <link linkend="XftColor">XftColor</link> *color,
81                                                          <link linkend="PangoLayout">PangoLayout</link> *layout,
82                                                          <link linkend="int">int</link> x,
83                                                          <link linkend="int">int</link> y);
84 </synopsis>
85 </refsynopsisdiv>
86
87 <refsect1 id="pango-Xft-Fonts-and-Rendering.object-hierarchy" role="object_hierarchy">
88 <title role="object_hierarchy.title">Object Hierarchy</title>
89 <synopsis>
90   <link linkend="GObject">GObject</link>
91    +----<link linkend="PangoFont">PangoFont</link>
92          +----<link linkend="PangoFcFont">PangoFcFont</link>
93                +----PangoXftFont
94 </synopsis>
95 <synopsis>
96   <link linkend="GObject">GObject</link>
97    +----<link linkend="PangoFontMap">PangoFontMap</link>
98          +----<link linkend="PangoFcFontMap">PangoFcFontMap</link>
99                +----PangoXftFontMap
100 </synopsis>
101 <synopsis>
102   <link linkend="GObject">GObject</link>
103    +----<link linkend="PangoRenderer">PangoRenderer</link>
104          +----PangoXftRenderer
105 </synopsis>
106 </refsect1>
107
108
109
110
111
112 <refsect1 id="pango-Xft-Fonts-and-Rendering.properties" role="properties">
113 <title role="properties.title">Properties</title>
114 <synopsis>
115   &quot;<link linkend="PangoXftRenderer--display">display</link>&quot;                  <link linkend="gpointer">gpointer</link>              : Write / Construct Only
116   &quot;<link linkend="PangoXftRenderer--screen">screen</link>&quot;                   <link linkend="gint">gint</link>                  : Write / Construct Only
117 </synopsis>
118 </refsect1>
119
120
121
122 <refsect1 id="pango-Xft-Fonts-and-Rendering.description" role="desc">
123 <title role="desc.title">Description</title>
124 <para>
125 The Xft library is a library for displaying fonts on the X window
126 system; internally it uses the fontconfig library to locate font
127 files, and the FreeType library to load and render fonts. The
128 Xft backend is the recommended Pango font backend for screen
129 display with X. (The <link linkend="pango-Cairo-Rendering">Cairo back end</link> is another possibility.)
130 </para>
131 <para>
132 Using the Xft backend is generally straightforward;
133 <link linkend="pango-xft-get-context"><function>pango_xft_get_context()</function></link> creates a context for a specified display
134 and screen. You can then create a <link linkend="PangoLayout"><type>PangoLayout</type></link> with that context
135 and render it with <link linkend="pango-xft-render-layout"><function>pango_xft_render_layout()</function></link>. At a more advanced
136 level, the low-level fontconfig options used for rendering fonts
137 can be affected using <link linkend="pango-xft-set-default-substitute"><function>pango_xft_set_default_substitute()</function></link>, and
138 <link linkend="pango-xft-substitute-changed"><function>pango_xft_substitute_changed()</function></link>.
139 </para>
140 <para>
141 A range of functions for drawing pieces of a layout, such as
142 individual layout lines and glyphs strings are provided.  You can also
143 directly create a <link linkend="PangoXftRenderer"><type>PangoXftRenderer</type></link>. Finally, in some advanced cases, it
144 is useful to derive from <link linkend="PangoXftRenderer"><type>PangoXftRenderer</type></link>. Deriving from
145 <link linkend="PangoXftRenderer"><type>PangoXftRenderer</type></link> is useful for two reasons. One reason is be to
146 support custom attributes by overriding <link linkend="PangoRendererClass"><type>PangoRendererClass</type></link> virtual
147 functions like 'prepare_run' or 'draw_shape'. The reason is to
148 customize exactly how the final bits are drawn to the destination by
149 overriding the <link linkend="PangoXftRendererClass"><type>PangoXftRendererClass</type></link> virtual functions
150 'composite_glyphs' and 'composite_trapezoids'.
151 </para>
152 </refsect1>
153
154 <refsect1 id="pango-Xft-Fonts-and-Rendering.details" role="details">
155 <title role="details.title">Details</title>
156 <refsect2 id="PangoXftFont-struct" role="struct">
157 <title>PangoXftFont</title>
158 <indexterm zone="PangoXftFont-struct"><primary sortas="PangoXftFont">PangoXftFont</primary></indexterm><programlisting>typedef struct _PangoXftFont PangoXftFont;</programlisting>
159 <para>
160 <link linkend="PangoXftFont"><type>PangoXftFont</type></link> is an implementation of <link linkend="PangoFcFont"><type>PangoFcFont</type></link> using the Xft
161 library for rendering.  It is used in conjunction with <link linkend="PangoXftFontMap"><type>PangoXftFontMap</type></link>.
162 </para></refsect2>
163 <refsect2 id="PangoXftFontMap-struct" role="struct">
164 <title>PangoXftFontMap</title>
165 <indexterm zone="PangoXftFontMap-struct"><primary sortas="PangoXftFontMap">PangoXftFontMap</primary></indexterm><programlisting>typedef struct _PangoXftFontMap PangoXftFontMap;</programlisting>
166 <para>
167 <link linkend="PangoXftFontMap"><type>PangoXftFontMap</type></link> is an implementation of <link linkend="PangoFcFontMap"><type>PangoFcFontMap</type></link> suitable for
168 the Xft library as the renderer.  It is used in to create fonts of
169 type <link linkend="PangoXftFont"><type>PangoXftFont</type></link>.
170 </para></refsect2>
171 <refsect2 id="PANGO-RENDER-TYPE-XFT--CAPS" role="macro" condition="deprecated:">
172 <title>PANGO_RENDER_TYPE_XFT</title>
173 <indexterm zone="PANGO-RENDER-TYPE-XFT--CAPS" role="deprecated"><primary sortas="PANGO_RENDER_TYPE_XFT">PANGO_RENDER_TYPE_XFT</primary></indexterm><programlisting>#define PANGO_RENDER_TYPE_XFT "PangoRenderXft"
174 </programlisting>
175 <warning><para><literal>PANGO_RENDER_TYPE_XFT</literal> is deprecated and should not be used in newly-written code.</para></warning>
176 <para>
177 A string constant that was used to identify shape engines that work
178 with the Xft backend. See <link linkend="PANGO-RENDER-TYPE-FC--CAPS"><literal>PANGO_RENDER_TYPE_FC</literal></link> for the replacement.
179 </para></refsect2>
180 <refsect2 id="pango-xft-get-context" role="function" condition="deprecated">
181 <title>pango_xft_get_context ()</title>
182 <indexterm zone="pango-xft-get-context" role="deprecated"><primary sortas="pango_xft_get_context">pango_xft_get_context</primary></indexterm><programlisting><link linkend="PangoContext">PangoContext</link> *      pango_xft_get_context               (<link linkend="Display">Display</link> *display,
183                                                          <link linkend="int">int</link> screen);</programlisting>
184 <warning><para><literal>pango_xft_get_context</literal> has been deprecated since version 1.22 and should not be used in newly-written code. Use <link linkend="pango-xft-get-font-map"><function>pango_xft_get_font_map()</function></link> followed by
185 <link linkend="pango-font-map-create-context"><function>pango_font_map_create_context()</function></link> instead.</para></warning>
186 <para>
187 Retrieves a <link linkend="PangoContext"><type>PangoContext</type></link> appropriate for rendering with
188 Xft fonts on the given screen of the given display.</para>
189 <para>
190 </para><variablelist role="params">
191 <varlistentry><term><parameter>display</parameter>&#160;:</term>
192 <listitem><simpara> an X display.
193 </simpara></listitem></varlistentry>
194 <varlistentry><term><parameter>screen</parameter>&#160;:</term>
195 <listitem><simpara> an X screen.
196 </simpara></listitem></varlistentry>
197 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="PangoContext"><type>PangoContext</type></link>.
198
199 </simpara></listitem></varlistentry>
200 </variablelist></refsect2>
201 <refsect2 id="pango-xft-get-font-map" role="function" condition="since:1.2">
202 <title>pango_xft_get_font_map ()</title>
203 <indexterm zone="pango-xft-get-font-map" role="1.2"><primary sortas="pango_xft_get_font_map">pango_xft_get_font_map</primary></indexterm><programlisting><link linkend="PangoFontMap">PangoFontMap</link> *      pango_xft_get_font_map              (<link linkend="Display">Display</link> *display,
204                                                          <link linkend="int">int</link> screen);</programlisting>
205 <para>
206 Returns the <link linkend="PangoXftFontmap"><type>PangoXftFontmap</type></link> for the given display and screen.
207 The fontmap is owned by Pango and will be valid until
208 the display is closed.</para>
209 <para>
210 </para><variablelist role="params">
211 <varlistentry><term><parameter>display</parameter>&#160;:</term>
212 <listitem><simpara> an X display
213 </simpara></listitem></varlistentry>
214 <varlistentry><term><parameter>screen</parameter>&#160;:</term>
215 <listitem><simpara> the screen number of a screen within <parameter>display</parameter>
216 </simpara></listitem></varlistentry>
217 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="PangoFontMap"><type>PangoFontMap</type></link> object, owned by Pango.
218
219 </simpara></listitem></varlistentry>
220 </variablelist><para role="since">Since 1.2</para></refsect2>
221 <refsect2 id="pango-xft-set-default-substitute" role="function" condition="since:1.2">
222 <title>pango_xft_set_default_substitute ()</title>
223 <indexterm zone="pango-xft-set-default-substitute" role="1.2"><primary sortas="pango_xft_set_default_substitute">pango_xft_set_default_substitute</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_set_default_substitute    (<link linkend="Display">Display</link> *display,
224                                                          <link linkend="int">int</link> screen,
225                                                          <link linkend="PangoXftSubstituteFunc">PangoXftSubstituteFunc</link> func,
226                                                          <link linkend="gpointer">gpointer</link> data,
227                                                          <link linkend="GDestroyNotify">GDestroyNotify</link> notify);</programlisting>
228 <para>
229 Sets a function that will be called to do final configuration
230 substitution on a <link linkend="FcPattern"><type>FcPattern</type></link> before it is used to load
231 the font. This function can be used to do things like set
232 hinting and antialiasing options.</para>
233 <para>
234 </para><variablelist role="params">
235 <varlistentry><term><parameter>display</parameter>&#160;:</term>
236 <listitem><simpara> an X Display
237 </simpara></listitem></varlistentry>
238 <varlistentry><term><parameter>screen</parameter>&#160;:</term>
239 <listitem><simpara> the screen number of a screen within <parameter>display</parameter>
240 </simpara></listitem></varlistentry>
241 <varlistentry><term><parameter>func</parameter>&#160;:</term>
242 <listitem><simpara> function to call to to do final config tweaking
243        on <link linkend="FcPattern"><type>FcPattern</type></link> objects.
244 </simpara></listitem></varlistentry>
245 <varlistentry><term><parameter>data</parameter>&#160;:</term>
246 <listitem><simpara> data to pass to <parameter>func</parameter>
247 </simpara></listitem></varlistentry>
248 <varlistentry><term><parameter>notify</parameter>&#160;:</term>
249 <listitem><simpara> function to call when <parameter>data</parameter> is no longer used.
250 </simpara></listitem></varlistentry>
251 </variablelist><para role="since">Since 1.2</para></refsect2>
252 <refsect2 id="PangoXftSubstituteFunc" role="function">
253 <title>PangoXftSubstituteFunc ()</title>
254 <indexterm zone="PangoXftSubstituteFunc"><primary sortas="PangoXftSubstituteFunc">PangoXftSubstituteFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*PangoXftSubstituteFunc)           (<link linkend="FcPattern">FcPattern</link> *pattern,
255                                                          <link linkend="gpointer">gpointer</link> data);</programlisting>
256 <para>
257 Function type for doing final config tweaking on prepared FcPatterns.
258 </para><variablelist role="params">
259 <varlistentry><term><parameter>pattern</parameter>&#160;:</term>
260 <listitem><simpara>the FcPattern to tweak.
261 </simpara></listitem></varlistentry>
262 <varlistentry><term><parameter>data</parameter>&#160;:</term>
263 <listitem><simpara>user data.
264 </simpara></listitem></varlistentry>
265 </variablelist></refsect2>
266 <refsect2 id="pango-xft-substitute-changed" role="function" condition="since:1.2">
267 <title>pango_xft_substitute_changed ()</title>
268 <indexterm zone="pango-xft-substitute-changed" role="1.2"><primary sortas="pango_xft_substitute_changed">pango_xft_substitute_changed</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_substitute_changed        (<link linkend="Display">Display</link> *display,
269                                                          <link linkend="int">int</link> screen);</programlisting>
270 <para>
271 Call this function any time the results of the
272 default substitution function set with
273 <link linkend="pango-xft-set-default-substitute"><function>pango_xft_set_default_substitute()</function></link> change.
274 That is, if your substitution function will return different
275 results for the same input pattern, you must call this function.</para>
276 <para>
277 </para><variablelist role="params">
278 <varlistentry><term><parameter>display</parameter>&#160;:</term>
279 <listitem><simpara> an X Display
280 </simpara></listitem></varlistentry>
281 <varlistentry><term><parameter>screen</parameter>&#160;:</term>
282 <listitem><simpara> the screen number of a screen within <parameter>display</parameter>
283 </simpara></listitem></varlistentry>
284 </variablelist><para role="since">Since 1.2</para></refsect2>
285 <refsect2 id="pango-xft-shutdown-display" role="function" condition="since:1.2">
286 <title>pango_xft_shutdown_display ()</title>
287 <indexterm zone="pango-xft-shutdown-display" role="1.2"><primary sortas="pango_xft_shutdown_display">pango_xft_shutdown_display</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_shutdown_display          (<link linkend="Display">Display</link> *display,
288                                                          <link linkend="int">int</link> screen);</programlisting>
289 <para>
290 Release any resources that have been cached for the
291 combination of <parameter>display</parameter> and <parameter>screen</parameter>. Note that when the
292 X display is closed, resources are released automatically,
293 without needing to call this function.</para>
294 <para>
295 </para><variablelist role="params">
296 <varlistentry><term><parameter>display</parameter>&#160;:</term>
297 <listitem><simpara> an X display
298 </simpara></listitem></varlistentry>
299 <varlistentry><term><parameter>screen</parameter>&#160;:</term>
300 <listitem><simpara> the screen number of a screen within <parameter>display</parameter>
301 </simpara></listitem></varlistentry>
302 </variablelist><para role="since">Since 1.2</para></refsect2>
303 <refsect2 id="pango-xft-font-get-font" role="function">
304 <title>pango_xft_font_get_font ()</title>
305 <indexterm zone="pango-xft-font-get-font"><primary sortas="pango_xft_font_get_font">pango_xft_font_get_font</primary></indexterm><programlisting><link linkend="XftFont">XftFont</link> *           pango_xft_font_get_font             (<link linkend="PangoFont">PangoFont</link> *font);</programlisting>
306 <para>
307 Returns the XftFont of a font.</para>
308 <para>
309 </para><variablelist role="params">
310 <varlistentry><term><parameter>font</parameter>&#160;:</term>
311 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>.
312 </simpara></listitem></varlistentry>
313 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the XftFont associated to <parameter>font</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if <parameter>font</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
314 </simpara></listitem></varlistentry>
315 </variablelist></refsect2>
316 <refsect2 id="pango-xft-font-get-display" role="function">
317 <title>pango_xft_font_get_display ()</title>
318 <indexterm zone="pango-xft-font-get-display"><primary sortas="pango_xft_font_get_display">pango_xft_font_get_display</primary></indexterm><programlisting><link linkend="Display">Display</link> *           pango_xft_font_get_display          (<link linkend="PangoFont">PangoFont</link> *font);</programlisting>
319 <para>
320 Returns the X display of the XftFont of a font.</para>
321 <para>
322 </para><variablelist role="params">
323 <varlistentry><term><parameter>font</parameter>&#160;:</term>
324 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>.
325 </simpara></listitem></varlistentry>
326 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the X display of the XftFont associated to <parameter>font</parameter>.
327 </simpara></listitem></varlistentry>
328 </variablelist></refsect2>
329 <refsect2 id="pango-xft-font-has-char" role="function" condition="deprecated:|since:1.2">
330 <title>pango_xft_font_has_char ()</title>
331 <indexterm zone="pango-xft-font-has-char" role="deprecated"><primary sortas="pango_xft_font_has_char">pango_xft_font_has_char</primary></indexterm><indexterm zone="pango-xft-font-has-char" role="1.2"><primary sortas="pango_xft_font_has_char">pango_xft_font_has_char</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pango_xft_font_has_char             (<link linkend="PangoFont">PangoFont</link> *font,
332                                                          <link linkend="gunichar">gunichar</link> wc);</programlisting>
333 <warning><para><literal>pango_xft_font_has_char</literal> is deprecated and should not be used in newly-written code.</para></warning>
334 <para>
335 Determines whether <parameter>font</parameter> has a glyph for the codepoint <parameter>wc</parameter>.
336 </para>
337 <para>
338 Use <link linkend="pango-fc-font-has-char"><function>pango_fc_font_has_char()</function></link> instead.</para>
339 <para>
340 </para><variablelist role="params">
341 <varlistentry><term><parameter>font</parameter>&#160;:</term>
342 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link> for the Xft backend
343 </simpara></listitem></varlistentry>
344 <varlistentry><term><parameter>wc</parameter>&#160;:</term>
345 <listitem><simpara> Unicode codepoint to look up
346 </simpara></listitem></varlistentry>
347 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>font</parameter> has the requested codepoint.
348
349 </simpara></listitem></varlistentry>
350 </variablelist><para role="since">Since 1.2</para></refsect2>
351 <refsect2 id="pango-xft-font-lock-face" role="function" condition="deprecated:|since:1.2">
352 <title>pango_xft_font_lock_face ()</title>
353 <indexterm zone="pango-xft-font-lock-face" role="deprecated"><primary sortas="pango_xft_font_lock_face">pango_xft_font_lock_face</primary></indexterm><indexterm zone="pango-xft-font-lock-face" role="1.2"><primary sortas="pango_xft_font_lock_face">pango_xft_font_lock_face</primary></indexterm><programlisting><link linkend="FT-Face">FT_Face</link>             pango_xft_font_lock_face            (<link linkend="PangoFont">PangoFont</link> *font);</programlisting>
354 <warning><para><literal>pango_xft_font_lock_face</literal> is deprecated and should not be used in newly-written code.</para></warning>
355 <para>
356 Gets the FreeType <type>FT_Face</type> associated with a font,
357 This face will be kept around until you call
358 <link linkend="pango-xft-font-unlock-face"><function>pango_xft_font_unlock_face()</function></link>.
359 </para>
360 <para>
361 Use <link linkend="pango-fc-font-lock-face"><function>pango_fc_font_lock_face()</function></link> instead.</para>
362 <para>
363 </para><variablelist role="params">
364 <varlistentry><term><parameter>font</parameter>&#160;:</term>
365 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>.
366 </simpara></listitem></varlistentry>
367 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the FreeType <type>FT_Face</type> associated with <parameter>font</parameter>.
368
369 </simpara></listitem></varlistentry>
370 </variablelist><para role="since">Since 1.2</para></refsect2>
371 <refsect2 id="pango-xft-font-unlock-face" role="function" condition="deprecated:|since:1.2">
372 <title>pango_xft_font_unlock_face ()</title>
373 <indexterm zone="pango-xft-font-unlock-face" role="deprecated"><primary sortas="pango_xft_font_unlock_face">pango_xft_font_unlock_face</primary></indexterm><indexterm zone="pango-xft-font-unlock-face" role="1.2"><primary sortas="pango_xft_font_unlock_face">pango_xft_font_unlock_face</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_font_unlock_face          (<link linkend="PangoFont">PangoFont</link> *font);</programlisting>
374 <warning><para><literal>pango_xft_font_unlock_face</literal> is deprecated and should not be used in newly-written code.</para></warning>
375 <para>
376 Releases a font previously obtained with
377 <link linkend="pango-xft-font-lock-face"><function>pango_xft_font_lock_face()</function></link>.
378 </para>
379 <para>
380 Use <link linkend="pango-fc-font-unlock-face"><function>pango_fc_font_unlock_face()</function></link> instead.</para>
381 <para>
382 </para><variablelist role="params">
383 <varlistentry><term><parameter>font</parameter>&#160;:</term>
384 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>.
385 </simpara></listitem></varlistentry>
386 </variablelist><para role="since">Since 1.2</para></refsect2>
387 <refsect2 id="pango-xft-font-get-glyph" role="function" condition="deprecated:|since:1.2">
388 <title>pango_xft_font_get_glyph ()</title>
389 <indexterm zone="pango-xft-font-get-glyph" role="deprecated"><primary sortas="pango_xft_font_get_glyph">pango_xft_font_get_glyph</primary></indexterm><indexterm zone="pango-xft-font-get-glyph" role="1.2"><primary sortas="pango_xft_font_get_glyph">pango_xft_font_get_glyph</primary></indexterm><programlisting><link linkend="guint">guint</link>               pango_xft_font_get_glyph            (<link linkend="PangoFont">PangoFont</link> *font,
390                                                          <link linkend="gunichar">gunichar</link> wc);</programlisting>
391 <warning><para><literal>pango_xft_font_get_glyph</literal> is deprecated and should not be used in newly-written code.</para></warning>
392 <para>
393 Gets the glyph index for a given Unicode character
394 for <parameter>font</parameter>. If you only want to determine
395 whether the font has the glyph, use <link linkend="pango-xft-font-has-char"><function>pango_xft_font_has_char()</function></link>.
396 </para>
397 <para>
398 Use <link linkend="pango-fc-font-get-glyph"><function>pango_fc_font_get_glyph()</function></link> instead.</para>
399 <para>
400 </para><variablelist role="params">
401 <varlistentry><term><parameter>font</parameter>&#160;:</term>
402 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link> for the Xft backend
403 </simpara></listitem></varlistentry>
404 <varlistentry><term><parameter>wc</parameter>&#160;:</term>
405 <listitem><simpara> Unicode codepoint to look up
406 </simpara></listitem></varlistentry>
407 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the glyph index, or 0, if the Unicode
408  character does not exist in the font.
409
410 </simpara></listitem></varlistentry>
411 </variablelist><para role="since">Since 1.2</para></refsect2>
412 <refsect2 id="pango-xft-font-get-unknown-glyph" role="function" condition="deprecated:">
413 <title>pango_xft_font_get_unknown_glyph ()</title>
414 <indexterm zone="pango-xft-font-get-unknown-glyph" role="deprecated"><primary sortas="pango_xft_font_get_unknown_glyph">pango_xft_font_get_unknown_glyph</primary></indexterm><programlisting><link linkend="PangoGlyph">PangoGlyph</link>          pango_xft_font_get_unknown_glyph    (<link linkend="PangoFont">PangoFont</link> *font,
415                                                          <link linkend="gunichar">gunichar</link> wc);</programlisting>
416 <warning><para><literal>pango_xft_font_get_unknown_glyph</literal> is deprecated and should not be used in newly-written code.</para></warning>
417 <para>
418 Returns the index of a glyph suitable for drawing <parameter>wc</parameter> as an
419 unknown character.
420 </para>
421 <para>
422 Use <link linkend="PANGO-GET-UNKNOWN-GLYPH--CAPS"><function>PANGO_GET_UNKNOWN_GLYPH()</function></link> instead.</para>
423 <para>
424 </para><variablelist role="params">
425 <varlistentry><term><parameter>font</parameter>&#160;:</term>
426 <listitem><simpara> a <link linkend="PangoFont"><type>PangoFont</type></link>.
427 </simpara></listitem></varlistentry>
428 <varlistentry><term><parameter>wc</parameter>&#160;:</term>
429 <listitem><simpara> the Unicode character for which a glyph is needed.
430 </simpara></listitem></varlistentry>
431 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a glyph index into <parameter>font</parameter>.
432 </simpara></listitem></varlistentry>
433 </variablelist></refsect2>
434 <refsect2 id="PangoXftRenderer-struct" role="struct">
435 <title>PangoXftRenderer</title>
436 <indexterm zone="PangoXftRenderer-struct" role="1.8"><primary sortas="PangoXftRenderer">PangoXftRenderer</primary></indexterm><programlisting>typedef struct _PangoXftRenderer PangoXftRenderer;</programlisting>
437 <para>
438 <link linkend="PangoXftRenderer"><type>PangoXftRenderer</type></link> is a subclass of <link linkend="PangoRenderer"><type>PangoRenderer</type></link> used for rendering
439 with Pango's Xft backend. It can be used directly, or it can be
440 further subclassed to modify exactly how drawing of individual
441 elements occurs.</para>
442 <para>
443 </para><para role="since">Since 1.8</para></refsect2>
444 <refsect2 id="PangoXftRendererClass" role="struct" condition="since:1.8">
445 <title>PangoXftRendererClass</title>
446 <indexterm zone="PangoXftRendererClass" role="1.8"><primary sortas="PangoXftRendererClass">PangoXftRendererClass</primary></indexterm><programlisting>typedef struct {
447   void (*composite_trapezoids) (PangoXftRenderer *xftrenderer,
448                                 PangoRenderPart   part,
449                                 XTrapezoid       *trapezoids,
450                                 int               n_trapezoids);
451   void (*composite_glyphs)     (PangoXftRenderer *xftrenderer,
452                                 XftFont          *xft_font,
453                                 XftGlyphSpec     *glyphs,
454                                 int               n_glyphs);
455 } PangoXftRendererClass;
456 </programlisting>
457 <para>
458 The class structure for <link linkend="PangoXftRenderer"><type>PangoXftRenderer</type></link></para>
459 <para>
460 </para><variablelist role="struct">
461 <varlistentry>
462 <term><structfield>composite_trapezoids</structfield>&#160;()</term>
463 <listitem><simpara> draw the specified trapezoids using
464   the current color and other attributes for <parameter>part</parameter>
465 </simpara></listitem>
466 </varlistentry>
467 <varlistentry>
468 <term><structfield>composite_glyphs</structfield>&#160;()</term>
469 <listitem><simpara> draw the specified glyphs using
470   the current foreground color and other foreground
471   attributes
472 </simpara></listitem>
473 </varlistentry>
474 </variablelist><para role="since">Since 1.8</para></refsect2>
475 <refsect2 id="pango-xft-renderer-new" role="function" condition="since:1.8">
476 <title>pango_xft_renderer_new ()</title>
477 <indexterm zone="pango-xft-renderer-new" role="1.8"><primary sortas="pango_xft_renderer_new">pango_xft_renderer_new</primary></indexterm><programlisting><link linkend="PangoRenderer">PangoRenderer</link> *     pango_xft_renderer_new              (<link linkend="Display">Display</link> *display,
478                                                          <link linkend="int">int</link> screen);</programlisting>
479 <para>
480 Create a new <link linkend="PangoXftRenderer"><type>PangoXftRenderer</type></link> to allow rendering Pango objects
481 with the Xft library. You must call <link linkend="pango-xft-renderer-set-draw"><function>pango_xft_renderer_set_draw()</function></link> before
482 using the renderer.</para>
483 <para>
484 </para><variablelist role="params">
485 <varlistentry><term><parameter>display</parameter>&#160;:</term>
486 <listitem><simpara> an X display
487 </simpara></listitem></varlistentry>
488 <varlistentry><term><parameter>screen</parameter>&#160;:</term>
489 <listitem><simpara>   the index of the screen for <parameter>display</parameter> to which rendering will be done
490 </simpara></listitem></varlistentry>
491 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the newly created <link linkend="PangoXftRenderer"><type>PangoXftRenderer</type></link>, which should
492               be freed with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.
493
494 </simpara></listitem></varlistentry>
495 </variablelist><para role="since">Since 1.8</para></refsect2>
496 <refsect2 id="pango-xft-renderer-set-draw" role="function" condition="since:1.8">
497 <title>pango_xft_renderer_set_draw ()</title>
498 <indexterm zone="pango-xft-renderer-set-draw" role="1.8"><primary sortas="pango_xft_renderer_set_draw">pango_xft_renderer_set_draw</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_renderer_set_draw         (<link linkend="PangoXftRenderer">PangoXftRenderer</link> *xftrenderer,
499                                                          <link linkend="XftDraw">XftDraw</link> *draw);</programlisting>
500 <para>
501 Sets the <link linkend="XftDraw"><type>XftDraw</type></link> object that the renderer is drawing to.
502 The renderer must not be currently active.</para>
503 <para>
504 </para><variablelist role="params">
505 <varlistentry><term><parameter>xftrenderer</parameter>&#160;:</term>
506 <listitem><simpara> a <link linkend="PangoXftRenderer"><type>PangoXftRenderer</type></link>
507 </simpara></listitem></varlistentry>
508 <varlistentry><term><parameter>draw</parameter>&#160;:</term>
509 <listitem><simpara> a <link linkend="XftDraw"><type>XftDraw</type></link>
510 </simpara></listitem></varlistentry>
511 </variablelist><para role="since">Since 1.8</para></refsect2>
512 <refsect2 id="pango-xft-renderer-set-default-color" role="function" condition="since:1.8">
513 <title>pango_xft_renderer_set_default_color ()</title>
514 <indexterm zone="pango-xft-renderer-set-default-color" role="1.8"><primary sortas="pango_xft_renderer_set_default_color">pango_xft_renderer_set_default_color</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_renderer_set_default_color
515                                                         (<link linkend="PangoXftRenderer">PangoXftRenderer</link> *xftrenderer,
516                                                          <link linkend="PangoColor">PangoColor</link> *default_color);</programlisting>
517 <para>
518 Sets the default foreground color for a <link linkend="XftRenderer"><type>XftRenderer</type></link>.</para>
519 <para>
520 </para><variablelist role="params">
521 <varlistentry><term><parameter>xftrenderer</parameter>&#160;:</term>
522 <listitem><simpara> a <link linkend="XftRenderer"><type>XftRenderer</type></link>
523 </simpara></listitem></varlistentry>
524 <varlistentry><term><parameter>default_color</parameter>&#160;:</term>
525 <listitem><simpara> the default foreground color
526 </simpara></listitem></varlistentry>
527 </variablelist><para role="since">Since 1.8</para></refsect2>
528 <refsect2 id="pango-xft-render" role="function">
529 <title>pango_xft_render ()</title>
530 <indexterm zone="pango-xft-render"><primary sortas="pango_xft_render">pango_xft_render</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_render                    (<link linkend="XftDraw">XftDraw</link> *draw,
531                                                          <link linkend="XftColor">XftColor</link> *color,
532                                                          <link linkend="PangoFont">PangoFont</link> *font,
533                                                          <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
534                                                          <link linkend="gint">gint</link> x,
535                                                          <link linkend="gint">gint</link> y);</programlisting>
536 <para>
537 Renders a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link> onto an <type>XftDraw</type> object wrapping an X drawable.</para>
538 <para>
539 </para><variablelist role="params">
540 <varlistentry><term><parameter>draw</parameter>&#160;:</term>
541 <listitem><simpara>    the <type>XftDraw</type> object.
542 </simpara></listitem></varlistentry>
543 <varlistentry><term><parameter>color</parameter>&#160;:</term>
544 <listitem><simpara>   the color in which to draw the string
545 </simpara></listitem></varlistentry>
546 <varlistentry><term><parameter>font</parameter>&#160;:</term>
547 <listitem><simpara>    the font in which to draw the string
548 </simpara></listitem></varlistentry>
549 <varlistentry><term><parameter>glyphs</parameter>&#160;:</term>
550 <listitem><simpara>  the glyph string to draw
551 </simpara></listitem></varlistentry>
552 <varlistentry><term><parameter>x</parameter>&#160;:</term>
553 <listitem><simpara>       the x position of start of string (in pixels)
554 </simpara></listitem></varlistentry>
555 <varlistentry><term><parameter>y</parameter>&#160;:</term>
556 <listitem><simpara>       the y position of baseline (in pixels)
557 </simpara></listitem></varlistentry>
558 </variablelist></refsect2>
559 <refsect2 id="pango-xft-picture-render" role="function">
560 <title>pango_xft_picture_render ()</title>
561 <indexterm zone="pango-xft-picture-render"><primary sortas="pango_xft_picture_render">pango_xft_picture_render</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_picture_render            (<link linkend="Display">Display</link> *display,
562                                                          <link linkend="Picture">Picture</link> src_picture,
563                                                          <link linkend="Picture">Picture</link> dest_picture,
564                                                          <link linkend="PangoFont">PangoFont</link> *font,
565                                                          <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
566                                                          <link linkend="gint">gint</link> x,
567                                                          <link linkend="gint">gint</link> y);</programlisting>
568 <para>
569 Renders a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link> onto an Xrender <type>Picture</type> object.</para>
570 <para>
571 </para><variablelist role="params">
572 <varlistentry><term><parameter>display</parameter>&#160;:</term>
573 <listitem><simpara>      an X display
574 </simpara></listitem></varlistentry>
575 <varlistentry><term><parameter>src_picture</parameter>&#160;:</term>
576 <listitem><simpara>  the source picture to draw the string with
577 </simpara></listitem></varlistentry>
578 <varlistentry><term><parameter>dest_picture</parameter>&#160;:</term>
579 <listitem><simpara> the destination picture to draw the string onto
580 </simpara></listitem></varlistentry>
581 <varlistentry><term><parameter>font</parameter>&#160;:</term>
582 <listitem><simpara>         the font in which to draw the string
583 </simpara></listitem></varlistentry>
584 <varlistentry><term><parameter>glyphs</parameter>&#160;:</term>
585 <listitem><simpara>       the glyph string to draw
586 </simpara></listitem></varlistentry>
587 <varlistentry><term><parameter>x</parameter>&#160;:</term>
588 <listitem><simpara>            the x position of start of string (in pixels)
589 </simpara></listitem></varlistentry>
590 <varlistentry><term><parameter>y</parameter>&#160;:</term>
591 <listitem><simpara>            the y position of baseline (in pixels)
592 </simpara></listitem></varlistentry>
593 </variablelist></refsect2>
594 <refsect2 id="pango-xft-render-transformed" role="function" condition="since:1.8">
595 <title>pango_xft_render_transformed ()</title>
596 <indexterm zone="pango-xft-render-transformed" role="1.8"><primary sortas="pango_xft_render_transformed">pango_xft_render_transformed</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_render_transformed        (<link linkend="XftDraw">XftDraw</link> *draw,
597                                                          <link linkend="XftColor">XftColor</link> *color,
598                                                          <link linkend="PangoMatrix">PangoMatrix</link> *matrix,
599                                                          <link linkend="PangoFont">PangoFont</link> *font,
600                                                          <link linkend="PangoGlyphString">PangoGlyphString</link> *glyphs,
601                                                          <link linkend="int">int</link> x,
602                                                          <link linkend="int">int</link> y);</programlisting>
603 <para>
604 Renders a <link linkend="PangoGlyphString"><type>PangoGlyphString</type></link> onto a <link linkend="XftDraw"><type>XftDraw</type></link>, possibly
605 transforming the layed-out coordinates through a transformation
606 matrix. Note that the transformation matrix for <parameter>font</parameter> is not
607 changed, so to produce correct rendering results, the <parameter>font</parameter>
608 must have been loaded using a <link linkend="PangoContext"><type>PangoContext</type></link> with an identical
609 transformation matrix to that passed in to this function.</para>
610 <para>
611 </para><variablelist role="params">
612 <varlistentry><term><parameter>draw</parameter>&#160;:</term>
613 <listitem><simpara>    an <link linkend="XftDraw"><type>XftDraw</type></link>
614 </simpara></listitem></varlistentry>
615 <varlistentry><term><parameter>color</parameter>&#160;:</term>
616 <listitem><simpara>   the color in which to draw the glyphs
617 </simpara></listitem></varlistentry>
618 <varlistentry><term><parameter>matrix</parameter>&#160;:</term>
619 <listitem><simpara>  a <link linkend="PangoMatrix"><type>PangoMatrix</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to use an identity transformation
620 </simpara></listitem></varlistentry>
621 <varlistentry><term><parameter>font</parameter>&#160;:</term>
622 <listitem><simpara>    the font in which to draw the string
623 </simpara></listitem></varlistentry>
624 <varlistentry><term><parameter>glyphs</parameter>&#160;:</term>
625 <listitem><simpara>  the glyph string to draw
626 </simpara></listitem></varlistentry>
627 <varlistentry><term><parameter>x</parameter>&#160;:</term>
628 <listitem><simpara>       the x position of the start of the string (in Pango
629           units in user space coordinates)
630 </simpara></listitem></varlistentry>
631 <varlistentry><term><parameter>y</parameter>&#160;:</term>
632 <listitem><simpara>       the y position of the baseline (in Pango units
633           in user space coordinates)
634 </simpara></listitem></varlistentry>
635 </variablelist><para role="since">Since 1.8</para></refsect2>
636 <refsect2 id="pango-xft-render-layout-line" role="function" condition="since:1.8">
637 <title>pango_xft_render_layout_line ()</title>
638 <indexterm zone="pango-xft-render-layout-line" role="1.8"><primary sortas="pango_xft_render_layout_line">pango_xft_render_layout_line</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_render_layout_line        (<link linkend="XftDraw">XftDraw</link> *draw,
639                                                          <link linkend="XftColor">XftColor</link> *color,
640                                                          <link linkend="PangoLayoutLine">PangoLayoutLine</link> *line,
641                                                          <link linkend="int">int</link> x,
642                                                          <link linkend="int">int</link> y);</programlisting>
643 <para>
644 Render a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link> onto a <link linkend="XftDraw"><type>XftDraw</type></link></para>
645 <para>
646 </para><variablelist role="params">
647 <varlistentry><term><parameter>draw</parameter>&#160;:</term>
648 <listitem><simpara>      an <link linkend="XftDraw"><type>XftDraw</type></link>
649 </simpara></listitem></varlistentry>
650 <varlistentry><term><parameter>color</parameter>&#160;:</term>
651 <listitem><simpara>     the foreground color in which to draw the layout line
652             (may be overridden by color attributes)
653 </simpara></listitem></varlistentry>
654 <varlistentry><term><parameter>line</parameter>&#160;:</term>
655 <listitem><simpara>      a <link linkend="PangoLayoutLine"><type>PangoLayoutLine</type></link>
656 </simpara></listitem></varlistentry>
657 <varlistentry><term><parameter>x</parameter>&#160;:</term>
658 <listitem><simpara>         the x position of start of string (in Pango units)
659 </simpara></listitem></varlistentry>
660 <varlistentry><term><parameter>y</parameter>&#160;:</term>
661 <listitem><simpara>         the y position of baseline (in Pango units)
662 </simpara></listitem></varlistentry>
663 </variablelist><para role="since">Since 1.8</para></refsect2>
664 <refsect2 id="pango-xft-render-layout" role="function" condition="since:1.8">
665 <title>pango_xft_render_layout ()</title>
666 <indexterm zone="pango-xft-render-layout" role="1.8"><primary sortas="pango_xft_render_layout">pango_xft_render_layout</primary></indexterm><programlisting><link linkend="void">void</link>                pango_xft_render_layout             (<link linkend="XftDraw">XftDraw</link> *draw,
667                                                          <link linkend="XftColor">XftColor</link> *color,
668                                                          <link linkend="PangoLayout">PangoLayout</link> *layout,
669                                                          <link linkend="int">int</link> x,
670                                                          <link linkend="int">int</link> y);</programlisting>
671 <para>
672 Render a <link linkend="PangoLayout"><type>PangoLayout</type></link> onto a <link linkend="XftDraw"><type>XftDraw</type></link></para>
673 <para>
674 </para><variablelist role="params">
675 <varlistentry><term><parameter>draw</parameter>&#160;:</term>
676 <listitem><simpara>      an <link linkend="XftDraw"><type>XftDraw</type></link>
677 </simpara></listitem></varlistentry>
678 <varlistentry><term><parameter>color</parameter>&#160;:</term>
679 <listitem><simpara>     the foreground color in which to draw the layout
680             (may be overridden by color attributes)
681 </simpara></listitem></varlistentry>
682 <varlistentry><term><parameter>layout</parameter>&#160;:</term>
683 <listitem><simpara>    a <link linkend="PangoLayout"><type>PangoLayout</type></link>
684 </simpara></listitem></varlistentry>
685 <varlistentry><term><parameter>x</parameter>&#160;:</term>
686 <listitem><simpara>         the X position of the left of the layout (in Pango units)
687 </simpara></listitem></varlistentry>
688 <varlistentry><term><parameter>y</parameter>&#160;:</term>
689 <listitem><simpara>         the Y position of the top of the layout (in Pango units)
690 </simpara></listitem></varlistentry>
691 </variablelist><para role="since">Since 1.8</para></refsect2>
692
693 </refsect1>
694 <refsect1 id="pango-Xft-Fonts-and-Rendering.property-details" role="property_details">
695 <title role="property_details.title">Property Details</title>
696 <refsect2 id="PangoXftRenderer--display" role="property"><title>The <literal>&quot;display&quot;</literal> property</title>
697 <indexterm zone="PangoXftRenderer--display"><primary sortas="PangoXftRenderer:display">PangoXftRenderer:display</primary></indexterm><programlisting>  &quot;display&quot;                  <link linkend="gpointer">gpointer</link>              : Write / Construct Only</programlisting>
698 <para>The display being rendered to.</para></refsect2>
699 <refsect2 id="PangoXftRenderer--screen" role="property"><title>The <literal>&quot;screen&quot;</literal> property</title>
700 <indexterm zone="PangoXftRenderer--screen"><primary sortas="PangoXftRenderer:screen">PangoXftRenderer:screen</primary></indexterm><programlisting>  &quot;screen&quot;                   <link linkend="gint">gint</link>                  : Write / Construct Only</programlisting>
701 <para>The screen being rendered to.</para><para>Allowed values: &gt;= 0</para>
702 <para>Default value: 0</para>
703 </refsect2>
704 </refsect1>
705
706
707
708
709 </refentry>