doc/reference/clutter/html/clutter-ClutterWaylandSurface.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>ClutterWaylandSurface</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-Wayland-compositor-specific-support.html" title="Wayland compositor specific support">
  10 <link rel="next" href="additionaldocs.html" title="Part VIII. Additional Documentation">
  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-Wayland-compositor-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="additionaldocs.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-ClutterWaylandSurface.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#clutter-ClutterWaylandSurface.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="clutter-ClutterWaylandSurface"></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-ClutterWaylandSurface.top_of_page"></a>ClutterWaylandSurface</span></h2>
  34 <p>ClutterWaylandSurface — An actor which displays the content of a client surface</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="clutter-ClutterWaylandSurface.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">struct              <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface">ClutterWaylandSurface</a>;
  41 struct              <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurfaceClass" title="struct ClutterWaylandSurfaceClass">ClutterWaylandSurfaceClass</a>;
  42 <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      <a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-new" title="clutter_wayland_surface_new ()">clutter_wayland_surface_new</a>         (<em class="parameter"><code><span class="type">struct wl_surface</span> *surface</code></em>);
  43 <a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-attach-buffer" title="clutter_wayland_surface_attach_buffer ()">clutter_wayland_surface_attach_buffer</a>
  44                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
  45                                                          <em class="parameter"><code><span class="type">struct wl_buffer</span> *buffer</code></em>,
  46                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
  47 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-damage-buffer" title="clutter_wayland_surface_damage_buffer ()">clutter_wayland_surface_damage_buffer</a>
  48                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
  49                                                          <em class="parameter"><code><span class="type">struct wl_buffer</span> *buffer</code></em>,
  50                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> x</code></em>,
  51                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> y</code></em>,
  52                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> width</code></em>,
  53                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> height</code></em>);
  54 <span class="returnvalue">CoglTexture</span> *       <a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-get-cogl-texture" title="clutter_wayland_surface_get_cogl_texture ()">clutter_wayland_surface_get_cogl_texture</a>
  55                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>);
  56 struct <span class="returnvalue">wl_surface</span> * <a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-get-surface" title="clutter_wayland_surface_get_surface ()">clutter_wayland_surface_get_surface</a> (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>);
  57 <span class="returnvalue">void</span>                <a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-set-surface" title="clutter_wayland_surface_set_surface ()">clutter_wayland_surface_set_surface</a> (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
  58                                                          <em class="parameter"><code><span class="type">struct wl_surface</span> *surface</code></em>);
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="clutter-ClutterWaylandSurface.description"></a><h2>Description</h2>
  63 <p>
  64 <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> is an actor for displaying the contents of a client
  65 surface. It is intended to support developers implementing Clutter based
  66 wayland compositors.
  67 </p>
  68 </div>
  69 <div class="refsect1">
  70 <a name="clutter-ClutterWaylandSurface.details"></a><h2>Details</h2>
  71 <div class="refsect2">
  72 <a name="ClutterWaylandSurface"></a><h3>struct ClutterWaylandSurface</h3>
  73 <pre class="programlisting">struct ClutterWaylandSurface {
  74 };
  75 </pre>
  76 <p>
  77 The <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> structure contains only private data
  78 </p>
  79 <p class="since">Since 1.10</p>
  80 <p class="stability">Stability Level: Unstable</p>
  81 </div>
  82 <hr>
  83 <div class="refsect2">
  84 <a name="ClutterWaylandSurfaceClass"></a><h3>struct ClutterWaylandSurfaceClass</h3>
  85 <pre class="programlisting">struct ClutterWaylandSurfaceClass {
  86   void (*queue_damage_redraw) (ClutterWaylandSurface *texture,
  87                                gint x,
  88                                gint y,
  89                                gint width,
  90                                gint height);
  91 };
  92 </pre>
  93 <p>
  94 The <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurfaceClass" title="struct ClutterWaylandSurfaceClass"><span class="type">ClutterWaylandSurfaceClass</span></a> structure contains only private data
  95 </p>
  96 <div class="variablelist"><table border="0">
  97 <col align="left" valign="top">
  98 <tbody><tr>
  99 <td><p><span class="term"><em class="structfield"><code><a name="ClutterWaylandSurfaceClass.queue-damage-redraw"></a>queue_damage_redraw</code></em> ()</span></p></td>
 100 <td>class handler of the <span class="type">"queue-damage-redraw"</span> signal</td>
 101 </tr></tbody>
 102 </table></div>
 103 <p class="since">Since 1.10</p>
 104 <p class="stability">Stability Level: Unstable</p>
 105 </div>
 106 <hr>
 107 <div class="refsect2">
 108 <a name="clutter-wayland-surface-new"></a><h3>clutter_wayland_surface_new ()</h3>
 109 <pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_wayland_surface_new         (<em class="parameter"><code><span class="type">struct wl_surface</span> *surface</code></em>);</pre>
 110 <p>
 111 Creates a new <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> for <em class="parameter"><code>surface</code></em>
 112 </p>
 113 <div class="variablelist"><table border="0">
 114 <col align="left" valign="top">
 115 <tbody>
 116 <tr>
 117 <td><p><span class="term"><em class="parameter"><code>surface</code></em> :</span></p></td>
 118 <td>the Wayland surface this actor should represent</td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 122 <td>A new <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> representing <em class="parameter"><code>surface</code></em>
 123 </td>
 124 </tr>
 125 </tbody>
 126 </table></div>
 127 <p class="since">Since 1.8</p>
 128 <p class="stability">Stability Level: Unstable</p>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="clutter-wayland-surface-attach-buffer"></a><h3>clutter_wayland_surface_attach_buffer ()</h3>
 133 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            clutter_wayland_surface_attach_buffer
 134                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
 135                                                          <em class="parameter"><code><span class="type">struct wl_buffer</span> *buffer</code></em>,
 136                                                          <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 137 <p>
 138 This associates a client's buffer with the <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a>
 139 actor <em class="parameter"><code>self</code></em>. This will automatically result in <em class="parameter"><code>self</code></em> being re-drawn
 140 with the new buffer contents.
 141 </p>
 142 <div class="variablelist"><table border="0">
 143 <col align="left" valign="top">
 144 <tbody>
 145 <tr>
 146 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 147 <td>A <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> actor</td>
 148 </tr>
 149 <tr>
 150 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 151 <td>A compositor side struct wl_buffer pointer</td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 155 <td>A <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 156 </td>
 157 </tr>
 158 </tbody>
 159 </table></div>
 160 <p class="since">Since 1.8</p>
 161 <p class="stability">Stability Level: Unstable</p>
 162 </div>
 163 <hr>
 164 <div class="refsect2">
 165 <a name="clutter-wayland-surface-damage-buffer"></a><h3>clutter_wayland_surface_damage_buffer ()</h3>
 166 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_wayland_surface_damage_buffer
 167                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
 168                                                          <em class="parameter"><code><span class="type">struct wl_buffer</span> *buffer</code></em>,
 169                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> x</code></em>,
 170                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> y</code></em>,
 171                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> width</code></em>,
 172                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint32"><span class="type">gint32</span></a> height</code></em>);</pre>
 173 <p>
 174 This marks a region of the given <em class="parameter"><code>buffer</code></em> has having been changed by
 175 the client. This will automatically result in the corresponding damaged
 176 region of the actor <em class="parameter"><code>self</code></em> being redrawn.
 177 </p>
 178 <p>
 179 If multiple regions are changed then this should be called multiple
 180 times with different damage rectangles.
 181 </p>
 182 <div class="variablelist"><table border="0">
 183 <col align="left" valign="top">
 184 <tbody>
 185 <tr>
 186 <td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
 187 <td>A <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> actor</td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 191 <td>A compositor side struct wl_buffer pointer</td>
 192 </tr>
 193 <tr>
 194 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 195 <td>The x coordinate of the damaged rectangle</td>
 196 </tr>
 197 <tr>
 198 <td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
 199 <td>The y coordinate of the damaged rectangle</td>
 200 </tr>
 201 <tr>
 202 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
 203 <td>The width of the damaged rectangle</td>
 204 </tr>
 205 <tr>
 206 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
 207 <td>The height of the damaged rectangle</td>
 208 </tr>
 209 </tbody>
 210 </table></div>
 211 <p class="since">Since 1.8</p>
 212 <p class="stability">Stability Level: Unstable</p>
 213 </div>
 214 <hr>
 215 <div class="refsect2">
 216 <a name="clutter-wayland-surface-get-cogl-texture"></a><h3>clutter_wayland_surface_get_cogl_texture ()</h3>
 217 <pre class="programlisting"><span class="returnvalue">CoglTexture</span> *       clutter_wayland_surface_get_cogl_texture
 218                                                         (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>);</pre>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="clutter-wayland-surface-get-surface"></a><h3>clutter_wayland_surface_get_surface ()</h3>
 223 <pre class="programlisting">struct <span class="returnvalue">wl_surface</span> * clutter_wayland_surface_get_surface (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>);</pre>
 224 </div>
 225 <hr>
 226 <div class="refsect2">
 227 <a name="clutter-wayland-surface-set-surface"></a><h3>clutter_wayland_surface_set_surface ()</h3>
 228 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_wayland_surface_set_surface (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
 229                                                          <em class="parameter"><code><span class="type">struct wl_surface</span> *surface</code></em>);</pre>
 230 </div>
 231 </div>
 232 </div>
 233 <div class="footer">
 234 <hr>
 235           Generated by GTK-Doc V1.18.1</div>
 236 </body>
 237 </html>