doc/reference/clutter/html/clutter-ClutterGLXTexturePixmap.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>ClutterGLXTexturePixmap</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-ClutterX11TexturePixmap.html" title="ClutterX11TexturePixmap">
  10 <link rel="next" href="clutter-Win32-Specific-Support.html" title="Win32 Specific Support">
  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-ClutterX11TexturePixmap.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-Win32-Specific-Support.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-ClutterGLXTexturePixmap.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#clutter-ClutterGLXTexturePixmap.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="clutter-ClutterGLXTexturePixmap"></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-ClutterGLXTexturePixmap.top_of_page"></a>ClutterGLXTexturePixmap</span></h2>
  34 <p>ClutterGLXTexturePixmap — 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-ClutterGLXTexturePixmap.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">                    <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap">ClutterGLXTexturePixmap</a>;
  41 struct              <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmapClass" title="struct ClutterGLXTexturePixmapClass">ClutterGLXTexturePixmapClass</a>;
  42 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="clutter-ClutterGLXTexturePixmap.html#clutter-glx-texture-pixmap-new" title="clutter_glx_texture_pixmap_new ()">clutter_glx_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-ClutterGLXTexturePixmap.html#clutter-glx-texture-pixmap-new-with-pixmap" title="clutter_glx_texture_pixmap_new_with_pixmap ()">clutter_glx_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-ClutterGLXTexturePixmap.html#clutter-glx-texture-pixmap-new-with-window" title="clutter_glx_texture_pixmap_new_with_window ()">clutter_glx_texture_pixmap_new_with_window</a>
  46                                                         (<em class="parameter"><code><span class="type">Window</span> window</code></em>);
  47
  48 <span class="returnvalue">gboolean</span>            <a class="link" href="clutter-ClutterGLXTexturePixmap.html#clutter-glx-texture-pixmap-using-extension" title="clutter_glx_texture_pixmap_using_extension ()">clutter_glx_texture_pixmap_using_extension</a>
  49                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a> *texture</code></em>);
  50 </pre>
  51 </div>
  52 <div class="refsect1">
  53 <a name="clutter-ClutterGLXTexturePixmap.description"></a><h2>Description</h2>
  54 <p>
  55 <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a> is a class for displaying the content of an
  56 X Pixmap as a ClutterActor. Used together with the X Composite extension,
  57 it allows to display the content of X Windows inside Clutter.
  58 </p>
  59 <p>
  60 This class used to be necessary to use the
  61 GLX_EXT_texture_from_pixmap extension to get fast texture
  62 updates. However since Clutter 1.4 the handling of this extension
  63 has moved down to Cogl. ClutterX11TexturePixmap and
  64 ClutterGLXTexturePixmap are now equivalent and either one of them
  65 may use the extension if it is possible.
  66 </p>
  67 </div>
  68 <div class="refsect1">
  69 <a name="clutter-ClutterGLXTexturePixmap.details"></a><h2>Details</h2>
  70 <div class="refsect2">
  71 <a name="ClutterGLXTexturePixmap"></a><h3>ClutterGLXTexturePixmap</h3>
  72 <pre class="programlisting">typedef struct _ClutterGLXTexturePixmap ClutterGLXTexturePixmap;</pre>
  73 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
  74 <h3 class="title">Warning</h3>
  75 <p><code class="literal">ClutterGLXTexturePixmap</code> has been deprecated since version 1.6 and should not be used in newly-written code. Use <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmap" title="struct ClutterX11TexturePixmap"><span class="type">ClutterX11TexturePixmap</span></a> instead</p>
  76 </div>
  77 <p>
  78 The <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a> structure contains only private data
  79 </p>
  80 <p class="since">Since 0.8</p>
  81 </div>
  82 <hr>
  83 <div class="refsect2">
  84 <a name="ClutterGLXTexturePixmapClass"></a><h3>struct ClutterGLXTexturePixmapClass</h3>
  85 <pre class="programlisting">struct ClutterGLXTexturePixmapClass {
  86 };
  87 </pre>
  88 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
  89 <h3 class="title">Warning</h3>
  90 <p><code class="literal">ClutterGLXTexturePixmapClass</code> has been deprecated since version 1.6 and should not be used in newly-written code. Use <a class="link" href="clutter-ClutterX11TexturePixmap.html#ClutterX11TexturePixmapClass" title="struct ClutterX11TexturePixmapClass"><span class="type">ClutterX11TexturePixmapClass</span></a> instead</p>
  91 </div>
  92 <p>
  93 The <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmapClass" title="struct ClutterGLXTexturePixmapClass"><span class="type">ClutterGLXTexturePixmapClass</span></a> structure contains only private data
  94 </p>
  95 <p class="since">Since 0.8</p>
  96 </div>
  97 <hr>
  98 <div class="refsect2">
  99 <a name="clutter-glx-texture-pixmap-new"></a><h3>clutter_glx_texture_pixmap_new ()</h3>
 100 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_glx_texture_pixmap_new      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 101 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 102 <h3 class="title">Warning</h3>
 103 <p><code class="literal">clutter_glx_texture_pixmap_new</code> has been deprecated since version 1.6 and should not be used in newly-written code. Use <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-new" title="clutter_x11_texture_pixmap_new ()"><code class="function">clutter_x11_texture_pixmap_new()</code></a> instead</p>
 104 </div>
 105 <p>
 106 Creates a new, empty <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a>
 107 </p>
 108 <div class="variablelist"><table border="0">
 109 <col align="left" valign="top">
 110 <tbody><tr>
 111 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 112 <td>A new <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a>
 113 </td>
 114 </tr></tbody>
 115 </table></div>
 116 <p class="since">Since 0.8</p>
 117 </div>
 118 <hr>
 119 <div class="refsect2">
 120 <a name="clutter-glx-texture-pixmap-new-with-pixmap"></a><h3>clutter_glx_texture_pixmap_new_with_pixmap ()</h3>
 121 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_glx_texture_pixmap_new_with_pixmap
 122                                                         (<em class="parameter"><code><span class="type">Pixmap</span> pixmap</code></em>);</pre>
 123 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 124 <h3 class="title">Warning</h3>
 125 <p><code class="literal">clutter_glx_texture_pixmap_new_with_pixmap</code> has been deprecated since version 1.6 and should not be used in newly-written code. Use <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-new-with-pixmap" title="clutter_x11_texture_pixmap_new_with_pixmap ()"><code class="function">clutter_x11_texture_pixmap_new_with_pixmap()</code></a> instead</p>
 126 </div>
 127 <p>
 128 Creates a new <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a> for <em class="parameter"><code>pixmap</code></em>
 129 </p>
 130 <div class="variablelist"><table border="0">
 131 <col align="left" valign="top">
 132 <tbody>
 133 <tr>
 134 <td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td>
 135 <td>the X Pixmap to which this texture should be bound</td>
 136 </tr>
 137 <tr>
 138 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 139 <td>A new <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a> bound to the given X Pixmap</td>
 140 </tr>
 141 </tbody>
 142 </table></div>
 143 <p class="since">Since 0.8</p>
 144 </div>
 145 <hr>
 146 <div class="refsect2">
 147 <a name="clutter-glx-texture-pixmap-new-with-window"></a><h3>clutter_glx_texture_pixmap_new_with_window ()</h3>
 148 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_glx_texture_pixmap_new_with_window
 149                                                         (<em class="parameter"><code><span class="type">Window</span> window</code></em>);</pre>
 150 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 151 <h3 class="title">Warning</h3>
 152 <p><code class="literal">clutter_glx_texture_pixmap_new_with_window</code> has been deprecated since version 1.6 and should not be used in newly-written code. Use <a class="link" href="clutter-ClutterX11TexturePixmap.html#clutter-x11-texture-pixmap-new-with-window" title="clutter_x11_texture_pixmap_new_with_window ()"><code class="function">clutter_x11_texture_pixmap_new_with_window()</code></a> instead</p>
 153 </div>
 154 <p>
 155 Creates a new <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a> for <em class="parameter"><code>window</code></em>
 156 </p>
 157 <div class="variablelist"><table border="0">
 158 <col align="left" valign="top">
 159 <tbody>
 160 <tr>
 161 <td><p><span class="term"><em class="parameter"><code>window</code></em> :</span></p></td>
 162 <td>the X window to which this texture should be bound</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 166 <td>A new <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a> bound to the given X window</td>
 167 </tr>
 168 </tbody>
 169 </table></div>
 170 <p class="since">Since 0.8</p>
 171 </div>
 172 <hr>
 173 <div class="refsect2">
 174 <a name="clutter-glx-texture-pixmap-using-extension"></a><h3>clutter_glx_texture_pixmap_using_extension ()</h3>
 175 <pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_glx_texture_pixmap_using_extension
 176                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a> *texture</code></em>);</pre>
 177 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 178 <h3 class="title">Warning</h3>
 179 <p><code class="literal">clutter_glx_texture_pixmap_using_extension</code> has been deprecated since version 1.6 and should not be used in newly-written code. Use <code class="function">cogl_texture_pixmap_x11_is_using_tfp_extension()</code>
 180   on the texture handle instead.</p>
 181 </div>
 182 <p>
 183 Checks whether <em class="parameter"><code>texture</code></em> is using the GLX_EXT_texture_from_pixmap
 184 extension; this extension can be optionally (though it is strongly
 185 encouraged) implemented as a zero-copy between a GLX pixmap and
 186 a GL texture.
 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>A <a class="link" href="clutter-ClutterGLXTexturePixmap.html#ClutterGLXTexturePixmap" title="ClutterGLXTexturePixmap"><span class="type">ClutterGLXTexturePixmap</span></a>
 194 </td>
 195 </tr>
 196 <tr>
 197 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 198 <td>
 199 <code class="literal">TRUE</code> if the texture is using the
 200 GLX_EXT_texture_from_pixmap OpenGL extension or falling back to the
 201 slower software mechanism.</td>
 202 </tr>
 203 </tbody>
 204 </table></div>
 205 <p class="since">Since 0.8</p>
 206 </div>
 207 </div>
 208 </div>
 209 <div class="footer">
 210 <hr>
 211           Generated by GTK-Doc V1.18.1</div>
 212 </body>
 213 </html>