update to 1.10.4
[profile/ivi/clutter.git] / doc / reference / clutter / html / clutter-ClutterX11TexturePixmap.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>ClutterX11TexturePixmap</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="clutterbackends.html" title="Part VII. Clutter Backends">
9 <link rel="prev" href="clutter-X11-Specific-Support.html" title="X11 Specific Support">
10 <link rel="next" href="clutter-ClutterGLXTexturePixmap.html" title="ClutterGLXTexturePixmap">
11 <meta name="generator" content="GTK-Doc V1.18.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="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="clutter-X11-Specific-Support.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="clutterbackends.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="clutter-ClutterGLXTexturePixmap.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#clutter-ClutterX11TexturePixmap.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#clutter-ClutterX11TexturePixmap.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="clutter-ClutterX11TexturePixmap"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="clutter-ClutterX11TexturePixmap.top_of_page"></a>ClutterX11TexturePixmap</span></h2>
34 <p>ClutterX11TexturePixmap — A texture which displays the content of an X Pixmap.</p>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="clutter-ClutterX11TexturePixmap.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">struct              <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap">ClutterX11TexturePixmap</a>;
41 struct              <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmapClass" title="struct ClutterX11TexturePixmapClass">ClutterX11TexturePixmapClass</a>;
42 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-new" title="clutter_x11_texture_pixmap_new ()">clutter_x11_texture_pixmap_new</a>      (<em class="parameter"><code><span class="type">void</span></code></em>);
43 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-new-with-pixmap" title="clutter_x11_texture_pixmap_new_with_pixmap ()">clutter_x11_texture_pixmap_new_with_pixmap</a>
44                                                         (<em class="parameter"><code><span class="type">Pixmap</span> pixmap</code></em>);
45 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-new-with-window" title="clutter_x11_texture_pixmap_new_with_window ()">clutter_x11_texture_pixmap_new_with_window</a>
46                                                         (<em class="parameter"><code><span class="type">Window</span> window</code></em>);
47 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-set-pixmap" title="clutter_x11_texture_pixmap_set_pixmap ()">clutter_x11_texture_pixmap_set_pixmap</a>
48                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> *texture</code></em>,
49                                                          <em class="parameter"><code><span class="type">Pixmap</span> pixmap</code></em>);
50 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-set-window" title="clutter_x11_texture_pixmap_set_window ()">clutter_x11_texture_pixmap_set_window</a>
51                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> *texture</code></em>,
52                                                          <em class="parameter"><code><span class="type">Window</span> window</code></em>,
53                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> automatic</code></em>);
54 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-sync-window" title="clutter_x11_texture_pixmap_sync_window ()">clutter_x11_texture_pixmap_sync_window</a>
55                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> *texture</code></em>);
56 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-update-area" title="clutter_x11_texture_pixmap_update_area ()">clutter_x11_texture_pixmap_update_area</a>
57                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> *texture</code></em>,
58                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
59                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
60                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
61                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>);
62 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-set-automatic" title="clutter_x11_texture_pixmap_set_automatic ()">clutter_x11_texture_pixmap_set_automatic</a>
63                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> *texture</code></em>,
64                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> setting</code></em>);
65 </pre>
66 </div>
67 <div class="refsect1">
68 <a name="clutter-ClutterX11TexturePixmap.description"></a><h2>Description</h2>
69 <p>
70 <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> is a class for displaying the content of an
71 X Pixmap as a ClutterActor. Used together with the X Composite extension,
72 it allows to display the content of X Windows inside Clutter.
73 </p>
74 <p>
75 The class uses the GLX_EXT_texture_from_pixmap OpenGL extension
76 (http://people.freedesktop.org/~davidr/GLX_EXT_texture_from_pixmap.txt)
77 if available
78 </p>
79 </div>
80 <div class="refsect1">
81 <a name="clutter-ClutterX11TexturePixmap.details"></a><h2>Details</h2>
82 <div class="refsect2">
83 <a name="ClutterX11TexturePixmap"></a><h3>struct ClutterX11TexturePixmap</h3>
84 <pre class="programlisting">struct ClutterX11TexturePixmap {
85 };
86 </pre>
87 <p>
88 The <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> structure contains only private data
89 </p>
90 <p class="since">Since 0.8</p>
91 </div>
92 <hr>
93 <div class="refsect2">
94 <a name="ClutterX11TexturePixmapClass"></a><h3>struct ClutterX11TexturePixmapClass</h3>
95 <pre class="programlisting">struct ClutterX11TexturePixmapClass {
96   void (* update_area) (ClutterX11TexturePixmap *texture,
97                         gint                     x,
98                         gint                     y,
99                         gint                     width,
100                         gint                     height);
101 };
102 </pre>
103 <p>
104 The <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmapClass" title="struct ClutterX11TexturePixmapClass"><span class="type">ClutterX11TexturePixmapClass</span></a> structure contains only private data
105 </p>
106 <div class="variablelist"><table border="0">
107 <col align="left" valign="top">
108 <tbody><tr>
109 <td><p><span class="term"><em class="structfield"><code><a name="ClutterX11TexturePixmapClass.update-area"></a>update_area</code></em> ()</span></p></td>
110 <td>virtual function for updating the area of the texture</td>
111 </tr></tbody>
112 </table></div>
113 <p class="since">Since 0.8</p>
114 </div>
115 <hr>
116 <div class="refsect2">
117 <a name="clutter-x11-texture-pixmap-new"></a><h3>clutter_x11_texture_pixmap_new ()</h3>
118 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_x11_texture_pixmap_new      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
119 <p>
120 Creates a new <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> which can be used to display the
121 contents of an X11 Pixmap inside a Clutter scene graph
122 </p>
123 <div class="variablelist"><table border="0">
124 <col align="left" valign="top">
125 <tbody><tr>
126 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
127 <td>A new <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a>
128 </td>
129 </tr></tbody>
130 </table></div>
131 <p class="since">Since 0.8</p>
132 </div>
133 <hr>
134 <div class="refsect2">
135 <a name="clutter-x11-texture-pixmap-new-with-pixmap"></a><h3>clutter_x11_texture_pixmap_new_with_pixmap ()</h3>
136 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_x11_texture_pixmap_new_with_pixmap
137                                                         (<em class="parameter"><code><span class="type">Pixmap</span> pixmap</code></em>);</pre>
138 <p>
139 Creates a new <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> for <em class="parameter"><code>pixmap</code></em>
140 </p>
141 <div class="variablelist"><table border="0">
142 <col align="left" valign="top">
143 <tbody>
144 <tr>
145 <td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td>
146 <td>the X Pixmap to which this texture should be bound</td>
147 </tr>
148 <tr>
149 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
150 <td>A new <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> bound to the given X Pixmap</td>
151 </tr>
152 </tbody>
153 </table></div>
154 <p class="since">Since 0.8</p>
155 </div>
156 <hr>
157 <div class="refsect2">
158 <a name="clutter-x11-texture-pixmap-new-with-window"></a><h3>clutter_x11_texture_pixmap_new_with_window ()</h3>
159 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_x11_texture_pixmap_new_with_window
160                                                         (<em class="parameter"><code><span class="type">Window</span> window</code></em>);</pre>
161 <p>
162 Creates a new <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> for <em class="parameter"><code>window</code></em>
163 </p>
164 <div class="variablelist"><table border="0">
165 <col align="left" valign="top">
166 <tbody>
167 <tr>
168 <td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
169 <td>the X window to which this texture should be bound</td>
170 </tr>
171 <tr>
172 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
173 <td>A new <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> bound to the given X window.</td>
174 </tr>
175 </tbody>
176 </table></div>
177 <p class="since">Since 0.8</p>
178 </div>
179 <hr>
180 <div class="refsect2">
181 <a name="clutter-x11-texture-pixmap-set-pixmap"></a><h3>clutter_x11_texture_pixmap_set_pixmap ()</h3>
182 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_x11_texture_pixmap_set_pixmap
183                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> *texture</code></em>,
184                                                          <em class="parameter"><code><span class="type">Pixmap</span> pixmap</code></em>);</pre>
185 <p>
186 Sets the X Pixmap to which the texture should be bound.
187 </p>
188 <div class="variablelist"><table border="0">
189 <col align="left" valign="top">
190 <tbody>
191 <tr>
192 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
193 <td>the texture to bind</td>
194 </tr>
195 <tr>
196 <td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td>
197 <td>the X Pixmap to which the texture should be bound</td>
198 </tr>
199 </tbody>
200 </table></div>
201 <p class="since">Since 0.8</p>
202 </div>
203 <hr>
204 <div class="refsect2">
205 <a name="clutter-x11-texture-pixmap-set-window"></a><h3>clutter_x11_texture_pixmap_set_window ()</h3>
206 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_x11_texture_pixmap_set_window
207                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> *texture</code></em>,
208                                                          <em class="parameter"><code><span class="type">Window</span> window</code></em>,
209                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> automatic</code></em>);</pre>
210 <p>
211 Sets up a suitable pixmap for the window, using the composite and damage
212 extensions if possible, and then calls
213 <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-set-pixmap" title="clutter_x11_texture_pixmap_set_pixmap ()"><code class="function">clutter_x11_texture_pixmap_set_pixmap()</code></a>.
214 </p>
215 <p>
216 If you want to display a window in a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>, you probably want
217 this function, or its older sister, <code class="function">clutter_glx_texture_pixmap_set_window()</code>.
218 </p>
219 <p>
220 This function has no effect unless the XComposite extension is available.
221 </p>
222 <div class="variablelist"><table border="0">
223 <col align="left" valign="top">
224 <tbody>
225 <tr>
226 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
227 <td>the texture to bind</td>
228 </tr>
229 <tr>
230 <td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
231 <td>the X window to which the texture should be bound</td>
232 </tr>
233 <tr>
234 <td><p><span class="term"><em class="parameter"><code>automatic</code></em> :</span></p></td>
235 <td>
236 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for automatic window updates, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> for manual.</td>
237 </tr>
238 </tbody>
239 </table></div>
240 <p class="since">Since 0.8</p>
241 </div>
242 <hr>
243 <div class="refsect2">
244 <a name="clutter-x11-texture-pixmap-sync-window"></a><h3>clutter_x11_texture_pixmap_sync_window ()</h3>
245 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_x11_texture_pixmap_sync_window
246                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> *texture</code></em>);</pre>
247 <p>
248 Resets the texture's pixmap from its window, perhaps in response to the
249 pixmap's invalidation as the window changed size.
250 </p>
251 <div class="variablelist"><table border="0">
252 <col align="left" valign="top">
253 <tbody><tr>
254 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
255 <td>the texture to bind</td>
256 </tr></tbody>
257 </table></div>
258 <p class="since">Since 0.8</p>
259 </div>
260 <hr>
261 <div class="refsect2">
262 <a name="clutter-x11-texture-pixmap-update-area"></a><h3>clutter_x11_texture_pixmap_update_area ()</h3>
263 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_x11_texture_pixmap_update_area
264                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> *texture</code></em>,
265                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> x</code></em>,
266                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> y</code></em>,
267                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
268                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>);</pre>
269 <p>
270 Performs the actual binding of texture to the current content of
271 the pixmap. Can be called to update the texture if the pixmap
272 content has changed.
273 </p>
274 <div class="variablelist"><table border="0">
275 <col align="left" valign="top">
276 <tbody>
277 <tr>
278 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
279 <td>The texture whose content shall be updated.</td>
280 </tr>
281 <tr>
282 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
283 <td>the X coordinate of the area to update</td>
284 </tr>
285 <tr>
286 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
287 <td>the Y coordinate of the area to update</td>
288 </tr>
289 <tr>
290 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
291 <td>the width of the area to update</td>
292 </tr>
293 <tr>
294 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
295 <td>the height of the area to update</td>
296 </tr>
297 </tbody>
298 </table></div>
299 <p class="since">Since 0.8</p>
300 </div>
301 <hr>
302 <div class="refsect2">
303 <a name="clutter-x11-texture-pixmap-set-automatic"></a><h3>clutter_x11_texture_pixmap_set_automatic ()</h3>
304 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_x11_texture_pixmap_set_automatic
305                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> *texture</code></em>,
306                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> setting</code></em>);</pre>
307 <p>
308 Enables or disables the automatic updates ot <em class="parameter"><code>texture</code></em> in case the backing
309 pixmap or window is damaged
310 </p>
311 <div class="variablelist"><table border="0">
312 <col align="left" valign="top">
313 <tbody>
314 <tr>
315 <td><p><span class="term"><em class="parameter"><code>texture</code></em> :</span></p></td>
316 <td>a <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a>
317 </td>
318 </tr>
319 <tr>
320 <td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
321 <td>
322 <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to enable automatic updates</td>
323 </tr>
324 </tbody>
325 </table></div>
326 <p class="since">Since 0.8</p>
327 </div>
328 </div>
329 </div>
330 <div class="footer">
331 <hr>
332           Generated by GTK-Doc V1.18.1</div>
333 </body>
334 </html>