Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/gtk-doc/html/cairo/cairo-XLib-XRender-Backend.html @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 68:5028fdace37b
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>XLib-XRender Backend: Cairo: A Vector Graphics Library</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7 <link rel="home" href="index.html" title="Cairo: A Vector Graphics Library">
8 <link rel="up" href="cairo-surfaces.html" title="Surfaces">
9 <link rel="prev" href="cairo-XLib-Surfaces.html" title="XLib Surfaces">
10 <link rel="next" href="cairo-Script-Surfaces.html" title="Script Surfaces">
11 <meta name="generator" content="GTK-Doc V1.27 (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="#cairo-XLib-XRender-Backend.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="cairo-surfaces.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="cairo-XLib-Surfaces.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="cairo-Script-Surfaces.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="cairo-XLib-XRender-Backend"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="cairo-XLib-XRender-Backend.top_of_page"></a>XLib-XRender Backend</span></h2>
30 <p>XLib-XRender Backend — X Window System rendering using XLib and the X Render extension</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="cairo-XLib-XRender-Backend.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
45 </td>
46 <td class="function_name">
47 <a class="link" href="cairo-XLib-XRender-Backend.html#cairo-xlib-surface-create-with-xrender-format" title="cairo_xlib_surface_create_with_xrender_format ()">cairo_xlib_surface_create_with_xrender_format</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">XRenderPictFormat</span> *
53 </td>
54 <td class="function_name">
55 <a class="link" href="cairo-XLib-XRender-Backend.html#cairo-xlib-surface-get-xrender-format" title="cairo_xlib_surface_get_xrender_format ()">cairo_xlib_surface_get_xrender_format</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 </tbody>
59 </table></div>
60 </div>
61 <div class="refsect1">
62 <a name="cairo-XLib-XRender-Backend.other"></a><h2>Types and Values</h2>
63 <div class="informaltable"><table class="informaltable" width="100%" border="0">
64 <colgroup>
65 <col width="150px" class="name">
66 <col class="description">
67 </colgroup>
68 <tbody><tr>
69 <td class="define_keyword">#define</td>
70 <td class="function_name"><a class="link" href="cairo-XLib-XRender-Backend.html#CAIRO-HAS-XLIB-XRENDER-SURFACE:CAPS" title="CAIRO_HAS_XLIB_XRENDER_SURFACE">CAIRO_HAS_XLIB_XRENDER_SURFACE</a></td>
71 </tr></tbody>
72 </table></div>
73 </div>
74 <div class="refsect1">
75 <a name="cairo-XLib-XRender-Backend.description"></a><h2>Description</h2>
76 <p>The XLib surface is used to render cairo graphics to X Window System
77 windows and pixmaps using the XLib and Xrender libraries.</p>
78 <p>Note that the XLib surface automatically takes advantage of X Render extension
79 if it is available.</p>
80 </div>
81 <div class="refsect1">
82 <a name="cairo-XLib-XRender-Backend.functions_details"></a><h2>Functions</h2>
83 <div class="refsect2">
84 <a name="cairo-xlib-surface-create-with-xrender-format"></a><h3>cairo_xlib_surface_create_with_xrender_format ()</h3>
85 <pre class="programlisting"><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="returnvalue">cairo_surface_t</span></a> *
86 cairo_xlib_surface_create_with_xrender_format
87 (<em class="parameter"><code><span class="type">Display</span> *dpy</code></em>,
88 <em class="parameter"><code><span class="type">Drawable</span> drawable</code></em>,
89 <em class="parameter"><code><span class="type">Screen</span> *screen</code></em>,
90 <em class="parameter"><code><span class="type">XRenderPictFormat</span> *format</code></em>,
91 <em class="parameter"><code><span class="type">int</span> width</code></em>,
92 <em class="parameter"><code><span class="type">int</span> height</code></em>);</pre>
93 <p>Creates an Xlib surface that draws to the given drawable.
94 The way that colors are represented in the drawable is specified
95 by the provided picture format.</p>
96 <p>Note: If <em class="parameter"><code>drawable</code></em>
97 is a Window, then the function
98 <a class="link" href="cairo-XLib-Surfaces.html#cairo-xlib-surface-set-size" title="cairo_xlib_surface_set_size ()"><code class="function">cairo_xlib_surface_set_size()</code></a> must be called whenever the size of the
99 window changes.</p>
100 <div class="refsect3">
101 <a name="cairo-xlib-surface-create-with-xrender-format.parameters"></a><h4>Parameters</h4>
102 <div class="informaltable"><table class="informaltable" width="100%" border="0">
103 <colgroup>
104 <col width="150px" class="parameters_name">
105 <col class="parameters_description">
106 <col width="200px" class="parameters_annotations">
107 </colgroup>
108 <tbody>
109 <tr>
110 <td class="parameter_name"><p>dpy</p></td>
111 <td class="parameter_description"><p>an X Display</p></td>
112 <td class="parameter_annotations"> </td>
113 </tr>
114 <tr>
115 <td class="parameter_name"><p>drawable</p></td>
116 <td class="parameter_description"><p>an X Drawable, (a Pixmap or a Window)</p></td>
117 <td class="parameter_annotations"> </td>
118 </tr>
119 <tr>
120 <td class="parameter_name"><p>screen</p></td>
121 <td class="parameter_description"><p>the X Screen associated with <em class="parameter"><code>drawable</code></em>
122 </p></td>
123 <td class="parameter_annotations"> </td>
124 </tr>
125 <tr>
126 <td class="parameter_name"><p>format</p></td>
127 <td class="parameter_description"><p>the picture format to use for drawing to <em class="parameter"><code>drawable</code></em>
128 . The depth
129 of <em class="parameter"><code>format</code></em>
130 must match the depth of the drawable.</p></td>
131 <td class="parameter_annotations"> </td>
132 </tr>
133 <tr>
134 <td class="parameter_name"><p>width</p></td>
135 <td class="parameter_description"><p>the current width of <em class="parameter"><code>drawable</code></em>
136 .</p></td>
137 <td class="parameter_annotations"> </td>
138 </tr>
139 <tr>
140 <td class="parameter_name"><p>height</p></td>
141 <td class="parameter_description"><p>the current height of <em class="parameter"><code>drawable</code></em>
142 .</p></td>
143 <td class="parameter_annotations"> </td>
144 </tr>
145 </tbody>
146 </table></div>
147 </div>
148 <div class="refsect3">
149 <a name="cairo-xlib-surface-create-with-xrender-format.returns"></a><h4>Returns</h4>
150 <p> the newly created surface</p>
151 </div>
152 <p class="since">Since: 1.0</p>
153 </div>
154 <hr>
155 <div class="refsect2">
156 <a name="cairo-xlib-surface-get-xrender-format"></a><h3>cairo_xlib_surface_get_xrender_format ()</h3>
157 <pre class="programlisting"><span class="returnvalue">XRenderPictFormat</span> *
158 cairo_xlib_surface_get_xrender_format (<em class="parameter"><code><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a> *surface</code></em>);</pre>
159 <p>Gets the X Render picture format that <em class="parameter"><code>surface</code></em>
160 uses for rendering with the
161 X Render extension. If the surface was created by
162 <a class="link" href="cairo-XLib-XRender-Backend.html#cairo-xlib-surface-create-with-xrender-format" title="cairo_xlib_surface_create_with_xrender_format ()"><code class="function">cairo_xlib_surface_create_with_xrender_format()</code></a> originally, the return
163 value is the format passed to that constructor.</p>
164 <div class="refsect3">
165 <a name="cairo-xlib-surface-get-xrender-format.parameters"></a><h4>Parameters</h4>
166 <div class="informaltable"><table class="informaltable" width="100%" border="0">
167 <colgroup>
168 <col width="150px" class="parameters_name">
169 <col class="parameters_description">
170 <col width="200px" class="parameters_annotations">
171 </colgroup>
172 <tbody><tr>
173 <td class="parameter_name"><p>surface</p></td>
174 <td class="parameter_description"><p>an xlib surface</p></td>
175 <td class="parameter_annotations"> </td>
176 </tr></tbody>
177 </table></div>
178 </div>
179 <div class="refsect3">
180 <a name="cairo-xlib-surface-get-xrender-format.returns"></a><h4>Returns</h4>
181 <p> the XRenderPictFormat* associated with <em class="parameter"><code>surface</code></em>
182 ,
183 or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the surface is not an xlib surface
184 or if the X Render extension is not available.</p>
185 </div>
186 <p class="since">Since: 1.6</p>
187 </div>
188 </div>
189 <div class="refsect1">
190 <a name="cairo-XLib-XRender-Backend.other_details"></a><h2>Types and Values</h2>
191 <div class="refsect2">
192 <a name="CAIRO-HAS-XLIB-XRENDER-SURFACE:CAPS"></a><h3>CAIRO_HAS_XLIB_XRENDER_SURFACE</h3>
193 <pre class="programlisting">#define CAIRO_HAS_XLIB_XRENDER_SURFACE 1
194 </pre>
195 <p>Defined if the XLib/XRender surface functions are available.
196 This macro can be used to conditionally compile backend-specific code.</p>
197 <p class="since">Since: 1.6</p>
198 </div>
199 </div>
200 <div class="refsect1">
201 <a name="cairo-XLib-XRender-Backend.see-also"></a><h2>See Also</h2>
202 <p><a class="link" href="cairo-cairo-surface-t.html#cairo-surface-t" title="cairo_surface_t"><span class="type">cairo_surface_t</span></a></p>
203 </div>
204 </div>
205 <div class="footer">
206 <hr>Generated by GTK-Doc V1.27</div>
207 </body>
208 </html>