<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Wayland specific support: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<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-GDK-Specific-Support.html" title="GDK Specific Support">
<link rel="next" href="clutter-Wayland-compositor-specific-support.html" title="Wayland compositor specific support">
<meta name="generator" content="GTK-Doc V1.25.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-Wayland-specific-support.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-GDK-Specific-Support.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="clutter-Wayland-compositor-specific-support.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="clutter-Wayland-specific-support"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="clutter-Wayland-specific-support.top_of_page"></a>Wayland specific support</span></h2>
<p>Wayland specific support — Wayland specific API</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="clutter-Wayland-specific-support.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">struct <span class="returnvalue">wl_seat</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-Wayland-specific-support.html#clutter-wayland-input-device-get-wl-seat" title="clutter_wayland_input_device_get_wl_seat ()">clutter_wayland_input_device_get_wl_seat</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">struct <span class="returnvalue">wl_shell_surface</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-Wayland-specific-support.html#clutter-wayland-stage-get-wl-shell-surface" title="clutter_wayland_stage_get_wl_shell_surface ()">clutter_wayland_stage_get_wl_shell_surface</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-Wayland-specific-support.html#clutter-wayland-stage-get-wl-surface" title="clutter_wayland_stage_get_wl_surface ()">clutter_wayland_stage_get_wl_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-Wayland-specific-support.html#clutter-wayland-stage-set-wl-surface" title="clutter_wayland_stage_set_wl_surface ()">clutter_wayland_stage_set_wl_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-Wayland-specific-support.html#clutter-wayland-set-display" title="clutter_wayland_set_display ()">clutter_wayland_set_display</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-Wayland-specific-support.html#clutter-wayland-disable-event-retrieval" title="clutter_wayland_disable_event_retrieval ()">clutter_wayland_disable_event_retrieval</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-Wayland-specific-support.description"></a><h2>Description</h2>
<p>The Wayland backend for Clutter provides some specific API, allowing
integration with the Wayland client API for acessing the underlying data
structures</p>
<p>The Clutter Wayland API is available since Clutter 1.10</p>
</div>
<div class="refsect1">
<a name="clutter-Wayland-specific-support.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-wayland-input-device-get-wl-seat"></a><h3>clutter_wayland_input_device_get_wl_seat ()</h3>
<pre class="programlisting">struct <span class="returnvalue">wl_seat</span> *
clutter_wayland_input_device_get_wl_seat
(<em class="parameter"><code><a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a> *device</code></em>);</pre>
<p>Access the underlying data structure representing the Wayland device that is
backing this <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a>.</p>
<p>Note: this function can only be called when running on the Wayland platform.
Calling this function at any other time will return <code class="literal">NULL</code>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="clutter-wayland-input-device-get-wl-seat.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>device</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterInputDevice.html" title="ClutterInputDevice"><span class="type">ClutterInputDevice</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-wayland-input-device-get-wl-seat.returns"></a><h4>Returns</h4>
<p> the Wayland input device associated with the
<em class="parameter"><code>device</code></em>
. </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-stage-get-wl-shell-surface"></a><h3>clutter_wayland_stage_get_wl_shell_surface ()</h3>
<pre class="programlisting">struct <span class="returnvalue">wl_shell_surface</span> *
clutter_wayland_stage_get_wl_shell_surface
(<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Access the underlying data structure representing the shell surface that is
backing the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p>
<p>Note: this function can only be called when running on the Wayland
platform. Calling this function at any other time will return <code class="literal">NULL</code>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="clutter-wayland-stage-get-wl-shell-surface.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-wayland-stage-get-wl-shell-surface.returns"></a><h4>Returns</h4>
<p> the Wayland shell surface associated with
<em class="parameter"><code>stage</code></em>
. </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-stage-get-wl-surface"></a><h3>clutter_wayland_stage_get_wl_surface ()</h3>
<pre class="programlisting">struct <span class="returnvalue">wl_surface</span> *
clutter_wayland_stage_get_wl_surface (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Access the underlying data structure representing the surface that is
backing the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p>
<p>Note: this function can only be called when running on the Wayland
platform. Calling this function at any other time will return <code class="literal">NULL</code>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="clutter-wayland-stage-get-wl-surface.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-wayland-stage-get-wl-surface.returns"></a><h4>Returns</h4>
<p> the Wayland surface associated with <em class="parameter"><code>stage</code></em>
. </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-stage-set-wl-surface"></a><h3>clutter_wayland_stage_set_wl_surface ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_wayland_stage_set_wl_surface (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>,
<em class="parameter"><code><span class="type">struct wl_surface</span> *surface</code></em>);</pre>
<p>Allows you to explicitly provide an existing Wayland surface to associate
with <em class="parameter"><code>stage</code></em>
, preventing Cogl from allocating a surface and shell surface for
the stage automatically.</p>
<p>This function must be called before <em class="parameter"><code>stage</code></em>
is shown.</p>
<p>Note: this function can only be called when running on the Wayland
platform. Calling this function at any other time has no effect.</p>
<div class="refsect3">
<a name="clutter-wayland-stage-set-wl-surface.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>stage</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</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 surface to associate with the <em class="parameter"><code>stage</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix15.html#api-index-1.16">1.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-set-display"></a><h3>clutter_wayland_set_display ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_wayland_set_display (<em class="parameter"><code><span class="type">struct wl_display</span> *display</code></em>);</pre>
<p>Sets the display connection Clutter should use; must be called
before <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>, <a class="link" href="clutter-General.html#clutter-init-with-args" title="clutter_init_with_args ()"><code class="function">clutter_init_with_args()</code></a> or other functions
pertaining Clutter's initialization process.</p>
<p>If you are parsing the command line arguments by retrieving Clutter's
<span class="type">GOptionGroup</span> with <a class="link" href="clutter-General.html#clutter-get-option-group" title="clutter_get_option_group ()"><code class="function">clutter_get_option_group()</code></a> and calling
<code class="function">g_option_context_parse()</code> yourself, you should also call
<a class="link" href="clutter-Wayland-specific-support.html#clutter-wayland-set-display" title="clutter_wayland_set_display ()"><code class="function">clutter_wayland_set_display()</code></a> before <code class="function">g_option_context_parse()</code>.</p>
<div class="refsect3">
<a name="clutter-wayland-set-display.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>display</p></td>
<td class="parameter_description"><p>pointer to a wayland display</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix15.html#api-index-1.16">1.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-wayland-disable-event-retrieval"></a><h3>clutter_wayland_disable_event_retrieval ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_wayland_disable_event_retrieval
(<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Disables the dispatch of the events in the main loop.</p>
<p>This is useful for integrating Clutter with another library that will do the
event dispatch; in general only a single source should be acting on changes
on the Wayland file descriptor.</p>
<p>This function can only be called before calling <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>.</p>
<p>This function should not be normally used by applications.</p>
<p class="since">Since: <a class="link" href="ix15.html#api-index-1.16">1.16</a></p>
</div>
</div>
<div class="refsect1">
<a name="clutter-Wayland-specific-support.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>