<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterWaylandSurface: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="clutterbackends.html" title="Part VII. Clutter Backends">
<link rel="prev" href="clutter-Wayland-compositor-specific-support.html" title="Wayland compositor specific support">
<link rel="next" href="clutter-clutter-mir.html" title="clutter-mir">
<meta name="generator" content="GTK-Doc V1.23.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#clutter-ClutterWaylandSurface.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="clutterbackends.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="clutter-Wayland-compositor-specific-support.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="clutter-clutter-mir.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="clutter-ClutterWaylandSurface"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="clutter-ClutterWaylandSurface.top_of_page"></a>ClutterWaylandSurface</span></h2>
<p>ClutterWaylandSurface — An actor which displays the content of a client surface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-new" title="clutter_wayland_surface_new ()">clutter_wayland_surface_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-attach-buffer" title="clutter_wayland_surface_attach_buffer ()">clutter_wayland_surface_attach_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-damage-buffer" title="clutter_wayland_surface_damage_buffer ()">clutter_wayland_surface_damage_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglTexture</span> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <span class="returnvalue">wl_surface</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-get-surface" title="clutter_wayland_surface_get_surface ()">clutter_wayland_surface_get_surface</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="clutter-ClutterWaylandSurface.html#clutter-wayland-surface-set-surface" title="clutter_wayland_surface_set_surface ()">clutter_wayland_surface_set_surface</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface">ClutterWaylandSurface</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurfaceClass" title="struct ClutterWaylandSurfaceClass">ClutterWaylandSurfaceClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.description"></a><h2>Description</h2>
<p><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
surface. It is intended to support developers implementing Clutter based
wayland compositors.</p>
</div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-wayland-surface-new"></a><h3>clutter_wayland_surface_new ()</h3>
<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>
<p>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>
</p>
<div class="refsect3">
<a name="id-1.8.13.6.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>the Wayland surface this actor should represent</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.8.13.6.2.6"></a><h4>Returns</h4>
<p> 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>
</p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-surface-attach-buffer"></a><h3>clutter_wayland_surface_attach_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_wayland_surface_attach_buffer (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">struct wl_resource</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>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>
actor <em class="parameter"><code>self</code></em>
. This will automatically result in <em class="parameter"><code>self</code></em>
being re-drawn
with the new buffer contents.</p>
<div class="refsect3">
<a name="id-1.8.13.6.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> actor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>A compositor side resource representing a wl_buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A <span class="type">GError</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-surface-damage-buffer"></a><h3>clutter_wayland_surface_damage_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_wayland_surface_damage_buffer (<em class="parameter"><code><a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">struct wl_resource</span> *buffer</code></em>,
<em class="parameter"><code><span class="type">gint32</span> x</code></em>,
<em class="parameter"><code><span class="type">gint32</span> y</code></em>,
<em class="parameter"><code><span class="type">gint32</span> width</code></em>,
<em class="parameter"><code><span class="type">gint32</span> height</code></em>);</pre>
<p>This marks a region of the given <em class="parameter"><code>buffer</code></em>
has having been changed by
the client. This will automatically result in the corresponding damaged
region of the actor <em class="parameter"><code>self</code></em>
being redrawn.</p>
<p>If multiple regions are changed then this should be called multiple
times with different damage rectangles.</p>
<div class="refsect3">
<a name="id-1.8.13.6.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>A <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> actor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>A wayland resource for a buffer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>The x coordinate of the damaged rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>The y coordinate of the damaged rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>The width of the damaged rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>The height of the damaged rectangle</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-surface-get-cogl-texture"></a><h3>clutter_wayland_surface_get_cogl_texture ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglTexture</span> *
clutter_wayland_surface_get_cogl_texture
(<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>
<p>Retrieves the Cogl texture with the contents of the Wayland surface.</p>
<div class="refsect3">
<a name="id-1.8.13.6.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.8.13.6.5.6"></a><h4>Returns</h4>
<p> a Cogl texture, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-surface-get-surface"></a><h3>clutter_wayland_surface_get_surface ()</h3>
<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>
<p>Retrieves a point to the Wayland surface used by the actor.</p>
<div class="refsect3">
<a name="id-1.8.13.6.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.8.13.6.6.6"></a><h4>Returns</h4>
<p> a wl_surface pointer, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-surface-set-surface"></a><h3>clutter_wayland_surface_set_surface ()</h3>
<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>,
<em class="parameter"><code><span class="type">struct wl_surface</span> *surface</code></em>);</pre>
<p>Sets the Wayland surface to be used by the actor.</p>
<div class="refsect3">
<a name="id-1.8.13.6.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>surface</p></td>
<td class="parameter_description"><p>a Wayland wl_surface pointer</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
</div>
<div class="refsect1">
<a name="clutter-ClutterWaylandSurface.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterWaylandSurface"></a><h3>struct ClutterWaylandSurface</h3>
<pre class="programlisting">struct ClutterWaylandSurface {
};
</pre>
<p>The <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurface" title="struct ClutterWaylandSurface"><span class="type">ClutterWaylandSurface</span></a> structure contains only private data</p>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterWaylandSurfaceClass"></a><h3>struct ClutterWaylandSurfaceClass</h3>
<pre class="programlisting">struct ClutterWaylandSurfaceClass {
void (*queue_damage_redraw) (ClutterWaylandSurface *texture,
gint x,
gint y,
gint width,
gint height);
};
</pre>
<p>The <a class="link" href="clutter-ClutterWaylandSurface.html#ClutterWaylandSurfaceClass" title="struct ClutterWaylandSurfaceClass"><span class="type">ClutterWaylandSurfaceClass</span></a> structure contains only private data</p>
<div class="refsect3">
<a name="id-1.8.13.7.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterWaylandSurfaceClass.queue-damage-redraw"></a>queue_damage_redraw</code></em> ()</p></td>
<td class="struct_member_description"><p>class handler of the <span class="type">“queue-damage-redraw”</span> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
<p class="stability">Stability Level: <acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.
The Unstable interface level is a warning that these interfaces are subject to
change without warning and should not be used in unbundled products.
Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.23.1</div>
</body>
</html>