<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>X11 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="ClutterBackend.html" title="ClutterBackend">
<link rel="next" href="ClutterX11TexturePixmap.html" title="ClutterX11TexturePixmap">
<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-X11-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="ClutterBackend.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterX11TexturePixmap.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="clutter-X11-Specific-Support"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="clutter-X11-Specific-Support.top_of_page"></a>X11 Specific Support</span></h2>
<p>X11 Specific Support — X11 specific API</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="clutter-X11-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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-set-display" title="clutter_x11_set_display ()">clutter_x11_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-X11-Specific-Support.html#clutter-x11-disable-event-retrieval" title="clutter_x11_disable_event_retrieval ()">clutter_x11_disable_event_retrieval</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-X11-Specific-Support.html#clutter-x11-has-event-retrieval" title="clutter_x11_has_event_retrieval ()">clutter_x11_has_event_retrieval</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-get-stage-from-window" title="clutter_x11_get_stage_from_window ()">clutter_x11_get_stage_from_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="clutter-X11-Specific-Support.html#ClutterX11FilterReturn" title="enum ClutterX11FilterReturn"><span class="returnvalue">ClutterX11FilterReturn</span></a>
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-handle-event" title="clutter_x11_handle_event ()">clutter_x11_handle_event</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">Display</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-get-default-display" title="clutter_x11_get_default_display ()">clutter_x11_get_default_display</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-get-default-screen" title="clutter_x11_get_default_screen ()">clutter_x11_get_default_screen</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">Window</span>
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-get-root-window" title="clutter_x11_get_root_window ()">clutter_x11_get_root_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">XVisualInfo</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-get-stage-visual" title="clutter_x11_get_stage_visual ()">clutter_x11_get_stage_visual</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">Window</span>
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-get-stage-window" title="clutter_x11_get_stage_window ()">clutter_x11_get_stage_window</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-X11-Specific-Support.html#clutter-x11-set-stage-foreign" title="clutter_x11_set_stage_foreign ()">clutter_x11_set_stage_foreign</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-X11-Specific-Support.html#clutter-x11-trap-x-errors" title="clutter_x11_trap_x_errors ()">clutter_x11_trap_x_errors</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-untrap-x-errors" title="clutter_x11_untrap_x_errors ()">clutter_x11_untrap_x_errors</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-X11-Specific-Support.html#clutter-x11-has-composite-extension" title="clutter_x11_has_composite_extension ()">clutter_x11_has_composite_extension</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">Time</span>
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-get-current-event-time" title="clutter_x11_get_current_event_time ()">clutter_x11_get_current_event_time</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-X11-Specific-Support.html#clutter-x11-set-use-argb-visual" title="clutter_x11_set_use_argb_visual ()">clutter_x11_set_use_argb_visual</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-X11-Specific-Support.html#clutter-x11-get-use-argb-visual" title="clutter_x11_get_use_argb_visual ()">clutter_x11_get_use_argb_visual</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">XVisualInfo</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-get-visual-info" title="clutter_x11_get_visual_info ()">clutter_x11_get_visual_info</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-X11-Specific-Support.html#clutter-x11-get-use-stereo-stage" title="clutter_x11_get_use_stereo_stage ()">clutter_x11_get_use_stereo_stage</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-X11-Specific-Support.html#clutter-x11-set-use-stereo-stage" title="clutter_x11_set_use_stereo_stage ()">clutter_x11_set_use_stereo_stage</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="clutter-X11-Specific-Support.html#ClutterX11FilterReturn" title="enum ClutterX11FilterReturn"><span class="returnvalue">ClutterX11FilterReturn</span></a>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="clutter-X11-Specific-Support.html#ClutterX11FilterFunc" title="ClutterX11FilterFunc ()">*ClutterX11FilterFunc</a><span class="c_punctuation">)</span> <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-X11-Specific-Support.html#clutter-x11-add-filter" title="clutter_x11_add_filter ()">clutter_x11_add_filter</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-X11-Specific-Support.html#clutter-x11-remove-filter" title="clutter_x11_remove_filter ()">clutter_x11_remove_filter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">GSList</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-get-input-devices" title="clutter_x11_get_input_devices ()">clutter_x11_get_input_devices</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-X11-Specific-Support.html#clutter-x11-has-xinput" title="clutter_x11_has_xinput ()">clutter_x11_has_xinput</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-X11-Specific-Support.html#clutter-x11-enable-xinput" title="clutter_x11_enable_xinput ()">clutter_x11_enable_xinput</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-event-get-key-group" title="clutter_x11_event_get_key_group ()">clutter_x11_event_get_key_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-event-sequence-get-touch-detail" title="clutter_x11_event_sequence_get_touch_detail ()">clutter_x11_event_sequence_get_touch_detail</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-X11-Specific-Support.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="clutter-X11-Specific-Support.html#ClutterX11FilterReturn" title="enum ClutterX11FilterReturn">ClutterX11FilterReturn</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-X11-Specific-Support.description"></a><h2>Description</h2>
<p>The X11 backend for Clutter provides some specific API, allowing
integration with the Xlibs API for embedding and manipulating the
stage window, or for trapping X errors.</p>
<p>The ClutterX11 API is available since Clutter 0.6</p>
</div>
<div class="refsect1">
<a name="clutter-X11-Specific-Support.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-x11-set-display"></a><h3>clutter_x11_set_display ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_x11_set_display (<em class="parameter"><code><span class="type">Display</span> *xdpy</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-X11-Specific-Support.html#clutter-x11-set-display" title="clutter_x11_set_display ()"><code class="function">clutter_x11_set_display()</code></a> before <code class="function">g_option_context_parse()</code>.</p>
<div class="refsect3">
<a name="clutter-x11-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>xdpy</p></td>
<td class="parameter_description"><p>pointer to a X display connection.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-disable-event-retrieval"></a><h3>clutter_x11_disable_event_retrieval ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_x11_disable_event_retrieval (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Disables the internal polling of X11 events in the main loop.</p>
<p>Libraries or applications calling this function will be responsible of
polling all X11 events.</p>
<p>You also must call <a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-handle-event" title="clutter_x11_handle_event ()"><code class="function">clutter_x11_handle_event()</code></a> to let Clutter process
events and maintain its internal state.</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>Even with event handling disabled, Clutter will still select
all the events required to maintain its internal state on the stage
Window; compositors using Clutter and input regions to pass events
through to application windows should not rely on an empty input
region, and should instead clear it themselves explicitly using the
XFixes extension.</p>
<p>This function should not be normally used by applications.</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-has-event-retrieval"></a><h3>clutter_x11_has_event_retrieval ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_x11_has_event_retrieval (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Queries the X11 backend to check if event collection has been disabled.</p>
<div class="refsect3">
<a name="clutter-x11-has-event-retrieval.returns"></a><h4>Returns</h4>
<p> TRUE if event retrival has been disabled. FALSE otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-stage-from-window"></a><h3>clutter_x11_get_stage_from_window ()</h3>
<pre class="programlisting"><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="returnvalue">ClutterStage</span></a> *
clutter_x11_get_stage_from_window (<em class="parameter"><code><span class="type">Window</span> win</code></em>);</pre>
<p>Gets the stage for a particular X window.</p>
<div class="refsect3">
<a name="clutter-x11-get-stage-from-window.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>win</p></td>
<td class="parameter_description"><p>an X Window ID</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-x11-get-stage-from-window.returns"></a><h4>Returns</h4>
<p> A <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>, or% NULL if a stage
does not exist for the window. </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="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-handle-event"></a><h3>clutter_x11_handle_event ()</h3>
<pre class="programlisting"><a class="link" href="clutter-X11-Specific-Support.html#ClutterX11FilterReturn" title="enum ClutterX11FilterReturn"><span class="returnvalue">ClutterX11FilterReturn</span></a>
clutter_x11_handle_event (<em class="parameter"><code><span class="type">XEvent</span> *xevent</code></em>);</pre>
<p>This function processes a single X event; it can be used to hook
into external X11 event processing (for example, a GDK filter
function).</p>
<p>If <a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-disable-event-retrieval" title="clutter_x11_disable_event_retrieval ()"><code class="function">clutter_x11_disable_event_retrieval()</code></a> has been called, you must
let this function process events to update Clutter's internal state.</p>
<div class="refsect3">
<a name="clutter-x11-handle-event.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>xevent</p></td>
<td class="parameter_description"><p>pointer to XEvent structure</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-x11-handle-event.returns"></a><h4>Returns</h4>
<p> <a class="link" href="clutter-X11-Specific-Support.html#ClutterX11FilterReturn" title="enum ClutterX11FilterReturn"><span class="type">ClutterX11FilterReturn</span></a>. <a class="link" href="clutter-X11-Specific-Support.html#CLUTTER-X11-FILTER-REMOVE:CAPS"><code class="literal">CLUTTER_X11_FILTER_REMOVE</code></a>
indicates that Clutter has internally handled the event and the
caller should do no further processing. <a class="link" href="clutter-X11-Specific-Support.html#CLUTTER-X11-FILTER-CONTINUE:CAPS"><code class="literal">CLUTTER_X11_FILTER_CONTINUE</code></a>
indicates that Clutter is either not interested in the event,
or has used the event to update internal state without taking
any exclusive action. <a class="link" href="clutter-X11-Specific-Support.html#CLUTTER-X11-FILTER-TRANSLATE:CAPS"><code class="literal">CLUTTER_X11_FILTER_TRANSLATE</code></a> will not
occur.</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-default-display"></a><h3>clutter_x11_get_default_display ()</h3>
<pre class="programlisting"><span class="returnvalue">Display</span> *
clutter_x11_get_default_display (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieves the pointer to the default display.</p>
<div class="refsect3">
<a name="clutter-x11-get-default-display.returns"></a><h4>Returns</h4>
<p> the default display. </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="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-default-screen"></a><h3>clutter_x11_get_default_screen ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
clutter_x11_get_default_screen (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Gets the number of the default X Screen object.</p>
<div class="refsect3">
<a name="clutter-x11-get-default-screen.returns"></a><h4>Returns</h4>
<p> the number of the default screen</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-root-window"></a><h3>clutter_x11_get_root_window ()</h3>
<pre class="programlisting"><span class="returnvalue">Window</span>
clutter_x11_get_root_window (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieves the root window.</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-x11-get-root-window.returns"></a><h4>Returns</h4>
<p> the id of the root window</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-stage-visual"></a><h3>clutter_x11_get_stage_visual ()</h3>
<pre class="programlisting"><span class="returnvalue">XVisualInfo</span> *
clutter_x11_get_stage_visual (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_x11_get_stage_visual</code> has been deprecated since version 1.2 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-get-visual-info" title="clutter_x11_get_visual_info ()"><code class="function">clutter_x11_get_visual_info()</code></a> instead</p>
</div>
<p>Returns an XVisualInfo suitable for creating a foreign window for the given
stage. NOTE: It doesn't do as the name may suggest, which is return the
XVisualInfo that was used to create an existing window for the given stage.</p>
<p>XXX: It might be best to deprecate this function and replace with something
along the lines of <code class="function">clutter_backend_x11_get_foreign_visual()</code> or perhaps
<code class="function">clutter_stage_x11_get_foreign_visual()</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-x11-get-stage-visual.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-x11-get-stage-visual.returns"></a><h4>Returns</h4>
<p> An XVisualInfo suitable for creating a
foreign stage. Use <code class="function">XFree()</code> to free the returned value instead. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-stage-window"></a><h3>clutter_x11_get_stage_window ()</h3>
<pre class="programlisting"><span class="returnvalue">Window</span>
clutter_x11_get_stage_window (<em class="parameter"><code><a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> *stage</code></em>);</pre>
<p>Gets the stages X Window.</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-x11-get-stage-window.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-x11-get-stage-window.returns"></a><h4>Returns</h4>
<p> An XID for the stage window.</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-set-stage-foreign"></a><h3>clutter_x11_set_stage_foreign ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_x11_set_stage_foreign (<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">Window</span> xwindow</code></em>);</pre>
<p>Target the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a> to use an existing external X Window</p>
<div class="refsect3">
<a name="clutter-x11-set-stage-foreign.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>xwindow</p></td>
<td class="parameter_description"><p>an existing X Window id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-x11-set-stage-foreign.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if foreign window is valid</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-trap-x-errors"></a><h3>clutter_x11_trap_x_errors ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_x11_trap_x_errors (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Traps every X error until <a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-untrap-x-errors" title="clutter_x11_untrap_x_errors ()"><code class="function">clutter_x11_untrap_x_errors()</code></a> is called.</p>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-untrap-x-errors"></a><h3>clutter_x11_untrap_x_errors ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
clutter_x11_untrap_x_errors (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Removes the X error trap and returns the current status.</p>
<div class="refsect3">
<a name="clutter-x11-untrap-x-errors.returns"></a><h4>Returns</h4>
<p> the trapped error code, or 0 for success</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-has-composite-extension"></a><h3>clutter_x11_has_composite_extension ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_x11_has_composite_extension (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieves whether Clutter is running on an X11 server with the
XComposite extension</p>
<div class="refsect3">
<a name="clutter-x11-has-composite-extension.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the XComposite extension is available</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-current-event-time"></a><h3>clutter_x11_get_current_event_time ()</h3>
<pre class="programlisting"><span class="returnvalue">Time</span>
clutter_x11_get_current_event_time (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieves the timestamp of the last X11 event processed by
Clutter. This might be different from the timestamp returned
by <a class="link" href="clutter-Events.html#clutter-get-current-event-time" title="clutter_get_current_event_time ()"><code class="function">clutter_get_current_event_time()</code></a>, as Clutter may synthesize
or throttle events.</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-x11-get-current-event-time.returns"></a><h4>Returns</h4>
<p> a timestamp, in milliseconds</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-set-use-argb-visual"></a><h3>clutter_x11_set_use_argb_visual ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_x11_set_use_argb_visual (<em class="parameter"><code><span class="type">gboolean</span> use_argb</code></em>);</pre>
<p>Sets whether the Clutter X11 backend should request ARGB visuals by default
or not.</p>
<p>By default, Clutter requests RGB visuals.</p>
<p>If no ARGB visuals are found, the X11 backend will fall back to
requesting a RGB visual instead.</p>
<p>ARGB visuals are required for the <a class="link" href="ClutterStage.html#ClutterStage--use-alpha" title="The “use-alpha” property"><span class="type">“use-alpha”</span></a> property to work.</p>
<p>This function can only be called once, and before <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a> is
called.</p>
<div class="refsect3">
<a name="clutter-x11-set-use-argb-visual.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>use_argb</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if ARGB visuals should be requested by default</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-use-argb-visual"></a><h3>clutter_x11_get_use_argb_visual ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_x11_get_use_argb_visual (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieves whether the Clutter X11 backend is using ARGB visuals by default</p>
<div class="refsect3">
<a name="clutter-x11-get-use-argb-visual.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if ARGB visuals are queried by default</p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-visual-info"></a><h3>clutter_x11_get_visual_info ()</h3>
<pre class="programlisting"><span class="returnvalue">XVisualInfo</span> *
clutter_x11_get_visual_info (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieves the <code class="literal">XVisualInfo</code> used by the Clutter X11 backend.</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-x11-get-visual-info.returns"></a><h4>Returns</h4>
<p> a <code class="literal">XVisualInfo</code>, or <code class="literal">None</code>.
The returned value should be freed using <code class="literal"><code class="function">XFree()</code></code> when done. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-use-stereo-stage"></a><h3>clutter_x11_get_use_stereo_stage ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_x11_get_use_stereo_stage (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieves whether the Clutter X11 backend will create stereo
stages if possible.</p>
<div class="refsect3">
<a name="clutter-x11-get-use-stereo-stage.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if stereo stages are used if possible</p>
</div>
<p class="since">Since: <a class="link" href="ix18.html#api-index-1.22">1.22</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-set-use-stereo-stage"></a><h3>clutter_x11_set_use_stereo_stage ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_x11_set_use_stereo_stage (<em class="parameter"><code><span class="type">gboolean</span> use_stereo</code></em>);</pre>
<p>Sets whether the backend object for Clutter stages, will,
if possible, be created with the ability to support stereo drawing
(drawing separate images for the left and right eyes).</p>
<p>This function must be called before <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a> is called.
During paint callbacks, <code class="function">cogl_framebuffer_is_stereo()</code> can be called
on the framebuffer retrieved by <code class="function">cogl_get_draw_framebuffer()</code> to
determine if stereo support was successfully enabled, and
<code class="function">cogl_framebuffer_set_stereo_mode()</code> to determine which buffers
will be drawn to.</p>
<p>Note that this function *does not* cause the stage to be drawn
multiple times with different perspective transformations and thus
appear in 3D, it simply enables individual ClutterActors to paint
different images for the left and and right eye.</p>
<div class="refsect3">
<a name="clutter-x11-set-use-stereo-stage.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>use_stereo</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the stereo stages should be used if possible.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix18.html#api-index-1.22">1.22</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterX11FilterFunc"></a><h3>ClutterX11FilterFunc ()</h3>
<pre class="programlisting"><a class="link" href="clutter-X11-Specific-Support.html#ClutterX11FilterReturn" title="enum ClutterX11FilterReturn"><span class="returnvalue">ClutterX11FilterReturn</span></a>
<span class="c_punctuation">(</span>*ClutterX11FilterFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">XEvent</span> *xev</code></em>,
<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *cev</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>Filter function for X11 native events.</p>
<div class="refsect3">
<a name="ClutterX11FilterFunc.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>xev</p></td>
<td class="parameter_description"><p>Native X11 event structure</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cev</p></td>
<td class="parameter_description"><p>Clutter event structure</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p> user data passed to the filter function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ClutterX11FilterFunc.returns"></a><h4>Returns</h4>
<p> the result of the filtering</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-add-filter"></a><h3>clutter_x11_add_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_x11_add_filter (<em class="parameter"><code><a class="link" href="clutter-X11-Specific-Support.html#ClutterX11FilterFunc" title="ClutterX11FilterFunc ()"><span class="type">ClutterX11FilterFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>Adds an event filter function.</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-x11-add-filter.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>func</p></td>
<td class="parameter_description"><p>a filter function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>user data to be passed to the filter function, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-remove-filter"></a><h3>clutter_x11_remove_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_x11_remove_filter (<em class="parameter"><code><a class="link" href="clutter-X11-Specific-Support.html#ClutterX11FilterFunc" title="ClutterX11FilterFunc ()"><span class="type">ClutterX11FilterFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>Removes the given filter function.</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-x11-remove-filter.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>func</p></td>
<td class="parameter_description"><p>a filter function</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>user data to be passed to the filter function, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-get-input-devices"></a><h3>clutter_x11_get_input_devices ()</h3>
<pre class="programlisting">const <span class="returnvalue">GSList</span> *
clutter_x11_get_input_devices (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_x11_get_input_devices</code> has been deprecated since version 1.2 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterDeviceManager.html#clutter-device-manager-peek-devices" title="clutter_device_manager_peek_devices ()"><code class="function">clutter_device_manager_peek_devices()</code></a> instead</p>
</div>
<p>Retrieves a pointer to the list of input devices</p>
<div class="refsect3">
<a name="clutter-x11-get-input-devices.returns"></a><h4>Returns</h4>
<p> a
pointer to the internal list of input devices; the returned list is
owned by Clutter and should not be modified or freed. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Clutter.InputDevice]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-has-xinput"></a><h3>clutter_x11_has_xinput ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_x11_has_xinput (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Gets whether Clutter has XInput support.</p>
<div class="refsect3">
<a name="clutter-x11-has-xinput.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if Clutter was compiled with XInput support
and XInput support is available at run time.</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-enable-xinput"></a><h3>clutter_x11_enable_xinput ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_x11_enable_xinput (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_x11_enable_xinput</code> has been deprecated since version 1.14 and should not be used in newly-written code.</p>
<p>This function does not do anything; XInput support
is enabled by default in Clutter. Use the CLUTTER_DISABLE_XINPUT
environment variable to disable XInput support and use Xlib core
events instead.</p>
</div>
<p>Enables the use of the XInput extension if present on connected
XServer and support built into Clutter. XInput allows for multiple
pointing devices to be used.</p>
<p>This function must be called before <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>.</p>
<p>Since XInput might not be supported by the X server, you might
want to use <a class="link" href="clutter-X11-Specific-Support.html#clutter-x11-has-xinput" title="clutter_x11_has_xinput ()"><code class="function">clutter_x11_has_xinput()</code></a> to see if support was enabled.</p>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-event-get-key-group"></a><h3>clutter_x11_event_get_key_group ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
clutter_x11_event_get_key_group (<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
<p>Retrieves the group for the modifiers set in <em class="parameter"><code>event</code></em>
</p>
<div class="refsect3">
<a name="clutter-x11-event-get-key-group.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>event</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Events.html#ClutterEvent"><span class="type">ClutterEvent</span></a> of type <a class="link" href="clutter-Events.html#CLUTTER-KEY-PRESS:CAPS"><code class="literal">CLUTTER_KEY_PRESS</code></a> or <a class="link" href="clutter-Events.html#CLUTTER-KEY-RELEASE:CAPS"><code class="literal">CLUTTER_KEY_RELEASE</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-x11-event-get-key-group.returns"></a><h4>Returns</h4>
<p> the group id</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-x11-event-sequence-get-touch-detail"></a><h3>clutter_x11_event_sequence_get_touch_detail ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_x11_event_sequence_get_touch_detail
(<em class="parameter"><code>const <a class="link" href="clutter-Events.html#ClutterEventSequence"><span class="type">ClutterEventSequence</span></a> *sequence</code></em>);</pre>
<p>Retrieves the touch detail froma <a class="link" href="clutter-Events.html#ClutterEventSequence"><span class="type">ClutterEventSequence</span></a>.</p>
<div class="refsect3">
<a name="clutter-x11-event-sequence-get-touch-detail.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>sequence</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Events.html#ClutterEventSequence"><span class="type">ClutterEventSequence</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-x11-event-sequence-get-touch-detail.returns"></a><h4>Returns</h4>
<p> the touch detail</p>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
</div>
<div class="refsect1">
<a name="clutter-X11-Specific-Support.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterX11FilterReturn"></a><h3>enum ClutterX11FilterReturn</h3>
<p>Return values for the <a class="link" href="clutter-X11-Specific-Support.html#ClutterX11FilterFunc" title="ClutterX11FilterFunc ()"><span class="type">ClutterX11FilterFunc</span></a> function.</p>
<div class="refsect3">
<a name="ClutterX11FilterReturn.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-X11-FILTER-CONTINUE:CAPS"></a>CLUTTER_X11_FILTER_CONTINUE</p></td>
<td class="enum_member_description">
<p>The event was not handled, continues the
processing</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-X11-FILTER-TRANSLATE:CAPS"></a>CLUTTER_X11_FILTER_TRANSLATE</p></td>
<td class="enum_member_description">
<p>Native event translated into a Clutter
event, stops the processing</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-X11-FILTER-REMOVE:CAPS"></a>CLUTTER_X11_FILTER_REMOVE</p></td>
<td class="enum_member_description">
<p>Remove the event, stops the processing</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>