RubyGems - clutter - Versions diffs - 2.2.4-x64-mingw32 - Mend

clutter 2.2.4-x64-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (744) hide show

data/vendor/local/share/gtk-doc/html/clutter/clutter-General.html ADDED Viewed

@@ -0,0 +1,2112 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Clutter Reference Manual: General</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="ch10.html" title="General purpose API">
+<link rel="prev" href="ClutterInputDevice.html" title="ClutterInputDevice">
+<link rel="next" href="ClutterPath.html" title="ClutterPath">
+<meta name="generator" content="GTK-Doc V1.20.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-General.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="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="ClutterInputDevice.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="ClutterPath.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="clutter-General"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="clutter-General.top_of_page"></a>General</span></h2>
+<p>General — Various 'global' Clutter functions.</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="clutter-General.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="define_keyword">#define</td>
+<td class="function_name"><a class="link" href="clutter-General.html#CLUTTER-PRIORITY-REDRAW:CAPS" title="CLUTTER_PRIORITY_REDRAW">CLUTTER_PRIORITY_REDRAW</a></td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="clutter-General.html#ClutterInitError" title="enum ClutterInitError"><span class="returnvalue">ClutterInitError</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()">clutter_init</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="clutter-General.html#ClutterInitError" title="enum ClutterInitError"><span class="returnvalue">ClutterInitError</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="clutter-General.html#clutter-init-with-args" title="clutter_init_with_args ()">clutter_init_with_args</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GOptionGroup</span> *
+</td>
+<td class="function_name">
+<a class="link" href="clutter-General.html#clutter-get-option-group" title="clutter_get_option_group ()">clutter_get_option_group</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GOptionGroup</span> *
+</td>
+<td class="function_name">
+<a class="link" href="clutter-General.html#clutter-get-option-group-without-init" title="clutter_get_option_group_without_init ()">clutter_get_option_group_without_init</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-General.html#clutter-main" title="clutter_main ()">clutter_main</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-General.html#clutter-main-quit" title="clutter_main_quit ()">clutter_main_quit</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-General.html#clutter-main-level" title="clutter_main_level ()">clutter_main_level</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-General.html#clutter-get-debug-enabled" title="clutter_get_debug_enabled ()">clutter_get_debug_enabled</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-General.html#clutter-get-show-fps" title="clutter_get_show_fps ()">clutter_get_show_fps</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gulong</span>
+</td>
+<td class="function_name">
+<a class="link" href="clutter-General.html#clutter-get-timestamp" title="clutter_get_timestamp ()">clutter_get_timestamp</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<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-General.html#clutter-get-actor-by-gid" title="clutter_get_actor_by_gid ()">clutter_get_actor_by_gid</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-General.html#clutter-set-default-frame-rate" title="clutter_set_default_frame_rate ()">clutter_set_default_frame_rate</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-General.html#clutter-get-default-frame-rate" title="clutter_get_default_frame_rate ()">clutter_get_default_frame_rate</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-General.html#clutter-set-motion-events-enabled" title="clutter_set_motion_events_enabled ()">clutter_set_motion_events_enabled</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-General.html#clutter-get-motion-events-enabled" title="clutter_get_motion_events_enabled ()">clutter_get_motion_events_enabled</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-General.html#clutter-clear-glyph-cache" title="clutter_clear_glyph_cache ()">clutter_clear_glyph_cache</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-General.html#clutter-set-font-flags" title="clutter_set_font_flags ()">clutter_set_font_flags</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="clutter-General.html#ClutterFontFlags" title="enum ClutterFontFlags"><span class="returnvalue">ClutterFontFlags</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="clutter-General.html#clutter-get-font-flags" title="clutter_get_font_flags ()">clutter_get_font_flags</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">PangoFontMap</span> *
+</td>
+<td class="function_name">
+<a class="link" href="clutter-General.html#clutter-get-font-map" title="clutter_get_font_map ()">clutter_get_font_map</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="clutter-General.html#ClutterTextDirection" title="enum ClutterTextDirection"><span class="returnvalue">ClutterTextDirection</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="clutter-General.html#clutter-get-default-text-direction" title="clutter_get_default_text_direction ()">clutter_get_default_text_direction</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-General.html#clutter-get-accessibility-enabled" title="clutter_get_accessibility_enabled ()">clutter_get_accessibility_enabled</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-General.html#clutter-disable-accessibility" title="clutter_disable_accessibility ()">clutter_disable_accessibility</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-General.html#clutter-threads-set-lock-functions" title="clutter_threads_set_lock_functions ()">clutter_threads_set_lock_functions</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-General.html#clutter-threads-init" title="clutter_threads_init ()">clutter_threads_init</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-General.html#clutter-threads-enter" title="clutter_threads_enter ()">clutter_threads_enter</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-General.html#clutter-threads-leave" title="clutter_threads_leave ()">clutter_threads_leave</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-General.html#clutter-threads-add-idle" title="clutter_threads_add_idle ()">clutter_threads_add_idle</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-General.html#clutter-threads-add-idle-full" title="clutter_threads_add_idle_full ()">clutter_threads_add_idle_full</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-General.html#clutter-threads-add-timeout" title="clutter_threads_add_timeout ()">clutter_threads_add_timeout</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-General.html#clutter-threads-add-timeout-full" title="clutter_threads_add_timeout_full ()">clutter_threads_add_timeout_full</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-General.html#clutter-threads-add-frame-source" title="clutter_threads_add_frame_source ()">clutter_threads_add_frame_source</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-General.html#clutter-threads-add-frame-source-full" title="clutter_threads_add_frame_source_full ()">clutter_threads_add_frame_source_full</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-General.html#clutter-threads-add-repaint-func" title="clutter_threads_add_repaint_func ()">clutter_threads_add_repaint_func</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-General.html#clutter-threads-add-repaint-func-full" title="clutter_threads_add_repaint_func_full ()">clutter_threads_add_repaint_func_full</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-General.html#clutter-threads-remove-repaint-func" title="clutter_threads_remove_repaint_func ()">clutter_threads_remove_repaint_func</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<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-General.html#clutter-get-keyboard-grab" title="clutter_get_keyboard_grab ()">clutter_get_keyboard_grab</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<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-General.html#clutter-get-pointer-grab" title="clutter_get_pointer_grab ()">clutter_get_pointer_grab</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-General.html#clutter-grab-keyboard" title="clutter_grab_keyboard ()">clutter_grab_keyboard</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-General.html#clutter-grab-pointer" title="clutter_grab_pointer ()">clutter_grab_pointer</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-General.html#clutter-ungrab-keyboard" title="clutter_ungrab_keyboard ()">clutter_ungrab_keyboard</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-General.html#clutter-ungrab-pointer" title="clutter_ungrab_pointer ()">clutter_ungrab_pointer</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-General.html#clutter-grab-pointer-for-device" title="clutter_grab_pointer_for_device ()">clutter_grab_pointer_for_device</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-General.html#clutter-ungrab-pointer-for-device" title="clutter_ungrab_pointer_for_device ()">clutter_ungrab_pointer_for_device</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-General.html#clutter-do-event" title="clutter_do_event ()">clutter_do_event</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="clutter-General.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">enum</td>
+<td class="function_name"><a class="link" href="clutter-General.html#ClutterInitError" title="enum ClutterInitError">ClutterInitError</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">enum</td>
+<td class="function_name"><a class="link" href="clutter-General.html#ClutterFontFlags" title="enum ClutterFontFlags">ClutterFontFlags</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">enum</td>
+<td class="function_name"><a class="link" href="clutter-General.html#ClutterTextDirection" title="enum ClutterTextDirection">ClutterTextDirection</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword">enum</td>
+<td class="function_name"><a class="link" href="clutter-General.html#ClutterRepaintFlags" title="enum ClutterRepaintFlags">ClutterRepaintFlags</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="clutter-General.description"></a><h2>Description</h2>
+<p>Functions to retrieve various global Clutter resources and other utility
+functions for mainloops, events and threads</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.5.3"></a><h4>The Clutter Threading Model</h4>
+<p>Clutter is *thread-aware*: all operations performed by Clutter are assumed
+to be under the Big Clutter Lock, which is created when the threading is
+initialized through <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>, and entered when calling user-related
+code during event handling and actor drawing.</p>
+<p>The only safe and portable way to use the Clutter API in a multi-threaded
+environment is to only access the Clutter API from a thread that did called
+<a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a> and <a class="link" href="clutter-General.html#clutter-main" title="clutter_main ()"><code class="function">clutter_main()</code></a>.</p>
+<p>The common pattern for using threads with Clutter is to use worker threads
+to perform blocking operations and then install idle or timeout sources with
+the result when the thread finishes, and update the UI from those callbacks.</p>
+<p>For a working example of how to use a worker thread to update the UI, see
+<a class="ulink" href="https://git.gnome.org/browse/clutter/tree/examples/threads.c?h=clutter-1.18" target="_top">threads.c</a></p>
+</div>
+</div>
+<div class="refsect1">
+<a name="clutter-General.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="CLUTTER-PRIORITY-REDRAW:CAPS"></a><h3>CLUTTER_PRIORITY_REDRAW</h3>
+<pre class="programlisting">#define CLUTTER_PRIORITY_REDRAW         (G_PRIORITY_HIGH_IDLE + 50)
+</pre>
+<p>Priority of the redraws. This is chosen to be lower than the GTK+
+redraw and resize priorities, because in application with both
+GTK+ and Clutter it's more likely that the Clutter part will be
+continually animating (and thus able to starve GTK+) than
+vice-versa.</p>
+<p class="since">Since 0.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-init"></a><h3>clutter_init ()</h3>
+<pre class="programlisting"><a class="link" href="clutter-General.html#ClutterInitError" title="enum ClutterInitError"><span class="returnvalue">ClutterInitError</span></a>
+clutter_init (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
+              <em class="parameter"><code><span class="type">char</span> ***argv</code></em>);</pre>
+<p>Initialises everything needed to operate with Clutter and parses some
+standard command line options; <em class="parameter"><code>argc</code></em>
+ and <em class="parameter"><code>argv</code></em>
+ are adjusted accordingly
+so your own code will never see those standard arguments.</p>
+<p>It is safe to call this function multiple times.</p>
+<p>This function will not abort in case of errors during
+initialization; <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a> will print out the error message on
+stderr, and will return an error code. It is up to the application
+code to handle this case. If you need to display the error message
+yourself, you can use <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>, which takes a <span class="type">GError</span>
+pointer.</p>
+<p>If this function fails, and returns an error code, any subsequent
+Clutter API will have undefined behaviour - including segmentation
+faults and assertion failures. Make sure to handle the returned
+<a class="link" href="clutter-General.html#ClutterInitError" title="enum ClutterInitError"><span class="type">ClutterInitError</span></a> enumeration value.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.3.8"></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>argc</p></td>
+<td class="parameter_description"><p> The number of arguments in <em class="parameter"><code>argv</code></em>
+. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>argv</p></td>
+<td class="parameter_description"><p> A pointer to an array
+of arguments. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc][<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.3.9"></a><h4>Returns</h4>
+<p> a <a class="link" href="clutter-General.html#ClutterInitError" title="enum ClutterInitError"><span class="type">ClutterInitError</span></a> value</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-init-with-args"></a><h3>clutter_init_with_args ()</h3>
+<pre class="programlisting"><a class="link" href="clutter-General.html#ClutterInitError" title="enum ClutterInitError"><span class="returnvalue">ClutterInitError</span></a>
+clutter_init_with_args (<em class="parameter"><code><span class="type">int</span> *argc</code></em>,
+                        <em class="parameter"><code><span class="type">char</span> ***argv</code></em>,
+                        <em class="parameter"><code>const <span class="type">char</span> *parameter_string</code></em>,
+                        <em class="parameter"><code><span class="type">GOptionEntry</span> *entries</code></em>,
+                        <em class="parameter"><code>const <span class="type">char</span> *translation_domain</code></em>,
+                        <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
+<p>This function does the same work as <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>. Additionally,
+it allows you to add your own command line options, and it
+automatically generates nicely formatted &lt;option&gt;--help&lt;/option&gt;
+output. Note that your program will be terminated after writing
+out the help output. Also note that, in case of error, the
+error message will be placed inside <em class="parameter"><code>error</code></em>
+ instead of being
+printed on the display.</p>
+<p>Just like <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>, if this function returns an error code then
+any subsequent call to any other Clutter API will result in undefined
+behaviour - including segmentation faults.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.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>argc</p></td>
+<td class="parameter_description"><p> a pointer to the number of command line arguments. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>argv</p></td>
+<td class="parameter_description"><p> a pointer to the array
+of command line arguments. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=argc][<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>parameter_string</p></td>
+<td class="parameter_description"><p> a string which is displayed in the
+first line of &lt;option&gt;--help&lt;/option&gt; output, after
+&lt;literal&gt;&lt;replaceable&gt;programname&lt;/replaceable&gt; [OPTION...]&lt;/literal&gt;. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>entries</p></td>
+<td class="parameter_description"><p> a <code class="literal">NULL</code> terminated array of
+<span class="type">GOptionEntry</span>&lt;!-- --&gt;s describing the options of your program. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>translation_domain</p></td>
+<td class="parameter_description"><p> a translation domain to use for
+translating the &lt;option&gt;--help&lt;/option&gt; output for the options in
+<em class="parameter"><code>entries</code></em>
+with <code class="function">gettext()</code>, or <code class="literal">NULL</code>. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+<tr>
+<td class="parameter_name"><p>error</p></td>
+<td class="parameter_description"><p> a return location for a <span class="type">GError</span>. </p></td>
+<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.4.7"></a><h4>Returns</h4>
+<p> <a class="link" href="clutter-General.html#CLUTTER-INIT-SUCCESS:CAPS"><code class="literal">CLUTTER_INIT_SUCCESS</code></a> if Clutter has been successfully
+initialised, or other values or <a class="link" href="clutter-General.html#ClutterInitError" title="enum ClutterInitError"><span class="type">ClutterInitError</span></a> in case of
+error.</p>
+<p></p>
+</div>
+<p class="since">Since 0.2</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-option-group"></a><h3>clutter_get_option_group ()</h3>
+<pre class="programlisting"><span class="returnvalue">GOptionGroup</span> *
+clutter_get_option_group (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Returns a <span class="type">GOptionGroup</span> for the command line arguments recognized
+by Clutter. You should add this group to your <span class="type">GOptionContext</span> with
+<code class="function">g_option_context_add_group()</code>, if you are using <code class="function">g_option_context_parse()</code>
+to parse your commandline arguments.</p>
+<p>Calling <code class="function">g_option_context_parse()</code> with Clutter's <span class="type">GOptionGroup</span> will result
+in Clutter's initialization. That is, the following code:</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="function">g_option_context_set_main_group</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="function"><a href="clutter-General.html#clutter-get-option-group">clutter_get_option_group</a></span><span class="normal"> </span><span class="symbol">());</span>
+<span class="normal">res </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_option_context_parse</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">context</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> NULL</span><span class="symbol">);</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p></p>
+<p>is functionally equivalent to:</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="function"><a href="clutter-General.html#clutter-init">clutter_init</a></span><span class="normal"> </span><span class="symbol">(&amp;</span><span class="normal">argc</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">argv</span><span class="symbol">);</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p></p>
+<p>After <code class="function">g_option_context_parse()</code> on a <span class="type">GOptionContext</span> containing the
+Clutter <span class="type">GOptionGroup</span> has returned <code class="literal">TRUE</code>, Clutter is guaranteed to be
+initialized.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.5.12"></a><h4>Returns</h4>
+<p> a <span class="type">GOptionGroup</span> for the commandline arguments
+recognized by Clutter. </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 0.2</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-option-group-without-init"></a><h3>clutter_get_option_group_without_init ()</h3>
+<pre class="programlisting"><span class="returnvalue">GOptionGroup</span> *
+clutter_get_option_group_without_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Returns a <span class="type">GOptionGroup</span> for the command line arguments recognized
+by Clutter. You should add this group to your <span class="type">GOptionContext</span> with
+<code class="function">g_option_context_add_group()</code>, if you are using <code class="function">g_option_context_parse()</code>
+to parse your commandline arguments.</p>
+<p>Unlike <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>, calling <code class="function">g_option_context_parse()</code> with
+the <span class="type">GOptionGroup</span> returned by this function requires a subsequent explicit
+call to <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>; use this function when needing to set foreign
+display connection with <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>, or with
+<code class="literal"><code class="function">gtk_clutter_init()</code></code>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.6.6"></a><h4>Returns</h4>
+<p> a <span class="type">GOptionGroup</span> for the commandline arguments
+recognized by Clutter. </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 0.8.2</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-main"></a><h3>clutter_main ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_main (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Starts the Clutter mainloop.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-main-quit"></a><h3>clutter_main_quit ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_main_quit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Terminates the Clutter mainloop.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-main-level"></a><h3>clutter_main_level ()</h3>
+<pre class="programlisting"><span class="returnvalue">gint</span>
+clutter_main_level (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Retrieves the depth of the Clutter mainloop.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.9.5"></a><h4>Returns</h4>
+<p> The level of the mainloop.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-debug-enabled"></a><h3>clutter_get_debug_enabled ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_get_debug_enabled (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_get_debug_enabled</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>This function does not do anything.</p>
+</div>
+<p>Check if Clutter has debugging enabled.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.10.6"></a><h4>Returns</h4>
+<p> <code class="literal">FALSE</code></p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-show-fps"></a><h3>clutter_get_show_fps ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_get_show_fps (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_get_show_fps</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>This function does not do anything. Use the environment
+  variable or the configuration file to determine whether Clutter should
+  print out the FPS counter on the console.</p>
+</div>
+<p>Returns whether Clutter should print out the frames per second on the
+console. You can enable this setting either using the
+&lt;literal&gt;CLUTTER_SHOW_FPS&lt;/literal&gt; environment variable or passing
+the &lt;literal&gt;--clutter-show-fps&lt;/literal&gt; command line argument. *</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.11.7"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if Clutter should show the FPS.</p>
+<p></p>
+</div>
+<p class="since">Since 0.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-timestamp"></a><h3>clutter_get_timestamp ()</h3>
+<pre class="programlisting"><span class="returnvalue">gulong</span>
+clutter_get_timestamp (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_get_timestamp</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>Use <span class="type">GTimer</span> or <code class="function">g_get_monotonic_time()</code> for a proper
+  timing source</p>
+</div>
+<p>Returns the approximate number of microseconds passed since Clutter was
+intialised.</p>
+<p>This function shdould not be used by application code.</p>
+<p>The output of this function depends on whether Clutter was configured to
+enable its debugging code paths, so it's less useful than intended.</p>
+<p>Since Clutter 1.10, this function is an alias to <code class="function">g_get_monotonic_time()</code>
+if Clutter was configured to enable the debugging code paths.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.12.9"></a><h4>Returns</h4>
+<p> Number of microseconds since <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a> was called, or
+zero if Clutter was not configured with debugging code paths.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-actor-by-gid"></a><h3>clutter_get_actor_by_gid ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
+clutter_get_actor_by_gid (<em class="parameter"><code><span class="type">guint32</span> id_</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_get_actor_by_gid</code> has been deprecated since version 1.8 and should not be used in newly-written code.</p>
+<p>The id is not used any longer.</p>
+</div>
+<p>Retrieves the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> with <em class="parameter"><code>id_</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.13.7"></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>id_</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> unique id.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.13.8"></a><h4>Returns</h4>
+<p> the actor with the passed id or <code class="literal">NULL</code>.
+The returned actor does not have its reference count increased. </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 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-set-default-frame-rate"></a><h3>clutter_set_default_frame_rate ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_set_default_frame_rate (<em class="parameter"><code><span class="type">guint</span> frames_per_sec</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_set_default_frame_rate</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>This function does not do anything any more.</p>
+</div>
+<p>Sets the default frame rate. This frame rate will be used to limit
+the number of frames drawn if Clutter is not able to synchronize
+with the vertical refresh rate of the display. When synchronization
+is possible, this value is ignored.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.14.7"></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>frames_per_sec</p></td>
+<td class="parameter_description"><p>the new default frame rate</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-default-frame-rate"></a><h3>clutter_get_default_frame_rate ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+clutter_get_default_frame_rate (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Retrieves the default frame rate. See <a class="link" href="clutter-General.html#clutter-set-default-frame-rate" title="clutter_set_default_frame_rate ()"><code class="function">clutter_set_default_frame_rate()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.15.5"></a><h4>Returns</h4>
+<p> the default frame rate</p>
+<p></p>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-set-motion-events-enabled"></a><h3>clutter_set_motion_events_enabled ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_set_motion_events_enabled (<em class="parameter"><code><span class="type">gboolean</span> enable</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_set_motion_events_enabled</code> has been deprecated since version 1.8 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="ClutterStage.html#clutter-stage-set-motion-events-enabled" title="clutter_stage_set_motion_events_enabled ()"><code class="function">clutter_stage_set_motion_events_enabled()</code></a> instead.</p>
+</div>
+<p>Sets whether per-actor motion events should be enabled or not on
+all <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>&lt;!-- --&gt;s managed by Clutter.</p>
+<p>If <em class="parameter"><code>enable</code></em>
+ is <code class="literal">FALSE</code> the following events will not work:</p>
+<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
+<li class="listitem"><p>ClutterActor::motion-event, except on the <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a></p></li>
+<li class="listitem"><p>ClutterActor::enter-event</p></li>
+<li class="listitem"><p>ClutterActor::leave-event</p></li>
+</ul></div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.16.9"></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>enable</p></td>
+<td class="parameter_description"><p><code class="literal">TRUE</code> to enable per-actor motion events</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-motion-events-enabled"></a><h3>clutter_get_motion_events_enabled ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_get_motion_events_enabled (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_get_motion_events_enabled</code> has been deprecated since version 1.8 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="ClutterStage.html#clutter-stage-get-motion-events-enabled" title="clutter_stage_get_motion_events_enabled ()"><code class="function">clutter_stage_get_motion_events_enabled()</code></a> instead.</p>
+</div>
+<p>Gets whether the per-actor motion events are enabled.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.17.7"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the motion events are enabled</p>
+<p></p>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-clear-glyph-cache"></a><h3>clutter_clear_glyph_cache ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_clear_glyph_cache (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_clear_glyph_cache</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="clutter-General.html#clutter-get-font-map" title="clutter_get_font_map ()"><code class="function">clutter_get_font_map()</code></a> and
+  <code class="function">cogl_pango_font_map_clear_glyph_cache()</code> instead.</p>
+</div>
+<p>Clears the internal cache of glyphs used by the Pango
+renderer. This will free up some memory and GL texture
+resources. The cache will be automatically refilled as more text is
+drawn.</p>
+<p class="since">Since 0.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-set-font-flags"></a><h3>clutter_set_font_flags ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_set_font_flags (<em class="parameter"><code><a class="link" href="clutter-General.html#ClutterFontFlags" title="enum ClutterFontFlags"><span class="type">ClutterFontFlags</span></a> flags</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_set_font_flags</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="ClutterBackend.html#clutter-backend-set-font-options" title="clutter_backend_set_font_options ()"><code class="function">clutter_backend_set_font_options()</code></a> and the
+  <span class="type">cairo_font_option_t</span> API.</p>
+</div>
+<p>Sets the font quality options for subsequent text rendering
+operations.</p>
+<p>Using mipmapped textures will improve the quality for scaled down
+text but will use more texture memory.</p>
+<p>Enabling hinting improves text quality for static text but may
+introduce some artifacts if the text is animated.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.19.9"></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>flags</p></td>
+<td class="parameter_description"><p>The new flags</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p class="since">Since 1.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-font-flags"></a><h3>clutter_get_font_flags ()</h3>
+<pre class="programlisting"><a class="link" href="clutter-General.html#ClutterFontFlags" title="enum ClutterFontFlags"><span class="returnvalue">ClutterFontFlags</span></a>
+clutter_get_font_flags (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_get_font_flags</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="ClutterBackend.html#clutter-backend-get-font-options" title="clutter_backend_get_font_options ()"><code class="function">clutter_backend_get_font_options()</code></a> and the
+  <span class="type">cairo_font_options_t</span> API.</p>
+</div>
+<p>Gets the current font flags for rendering text. See
+<a class="link" href="clutter-General.html#clutter-set-font-flags" title="clutter_set_font_flags ()"><code class="function">clutter_set_font_flags()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.20.7"></a><h4>Returns</h4>
+<p> The font flags</p>
+<p></p>
+</div>
+<p class="since">Since 1.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-font-map"></a><h3>clutter_get_font_map ()</h3>
+<pre class="programlisting"><span class="returnvalue">PangoFontMap</span> *
+clutter_get_font_map (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Retrieves the <span class="type">PangoFontMap</span> instance used by Clutter.
+You can use the global font map object with the COGL
+Pango API.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.21.5"></a><h4>Returns</h4>
+<p> the <span class="type">PangoFontMap</span> instance. The returned
+value is owned by Clutter and it should never be unreferenced. </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 1.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-default-text-direction"></a><h3>clutter_get_default_text_direction ()</h3>
+<pre class="programlisting"><a class="link" href="clutter-General.html#ClutterTextDirection" title="enum ClutterTextDirection"><span class="returnvalue">ClutterTextDirection</span></a>
+clutter_get_default_text_direction (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Retrieves the default direction for the text. The text direction is
+determined by the locale and/or by the &lt;varname&gt;CLUTTER_TEXT_DIRECTION&lt;/varname&gt;
+environment variable.</p>
+<p>The default text direction can be overridden on a per-actor basis by using
+<a class="link" href="ClutterActor.html#clutter-actor-set-text-direction" title="clutter_actor_set_text_direction ()"><code class="function">clutter_actor_set_text_direction()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.22.6"></a><h4>Returns</h4>
+<p> the default text direction</p>
+<p></p>
+</div>
+<p class="since">Since 1.2</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-accessibility-enabled"></a><h3>clutter_get_accessibility_enabled ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+clutter_get_accessibility_enabled (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Returns whether Clutter has accessibility support enabled.  As
+least, a value of TRUE means that there are a proper AtkUtil
+implementation available</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.23.5"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if Clutter has accessibility support enabled</p>
+<p></p>
+</div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-disable-accessibility"></a><h3>clutter_disable_accessibility ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_disable_accessibility (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Disable loading the accessibility support. It has the same effect
+as setting the environment variable
+CLUTTER_DISABLE_ACCESSIBILITY. For the same reason, this method
+should be called before <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>.</p>
+<p class="since">Since 1.14</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-set-lock-functions"></a><h3>clutter_threads_set_lock_functions ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_threads_set_lock_functions (<em class="parameter"><code><span class="type">GCallback</span> enter_fn</code></em>,
+                                    <em class="parameter"><code><span class="type">GCallback</span> leave_fn</code></em>);</pre>
+<p>Allows the application to replace the standard method that
+Clutter uses to protect its data structures. Normally, Clutter
+creates a single <span class="type">GMutex</span> that is locked by <a class="link" href="clutter-General.html#clutter-threads-enter" title="clutter_threads_enter ()"><code class="function">clutter_threads_enter()</code></a>,
+and released by <a class="link" href="clutter-General.html#clutter-threads-leave" title="clutter_threads_leave ()"><code class="function">clutter_threads_leave()</code></a>; using this function an
+application provides, instead, a function <em class="parameter"><code>enter_fn</code></em>
+ that is
+called by <a class="link" href="clutter-General.html#clutter-threads-enter" title="clutter_threads_enter ()"><code class="function">clutter_threads_enter()</code></a> and a function <em class="parameter"><code>leave_fn</code></em>
+ that is
+called by <a class="link" href="clutter-General.html#clutter-threads-leave" title="clutter_threads_leave ()"><code class="function">clutter_threads_leave()</code></a>.</p>
+<p>The functions must provide at least same locking functionality
+as the default implementation, but can also do extra application
+specific processing.</p>
+<p>As an example, consider an application that has its own recursive
+lock that when held, holds the Clutter lock as well. When Clutter
+unlocks the Clutter lock when entering a recursive main loop, the
+application must temporarily release its lock as well.</p>
+<p>Most threaded Clutter apps won't need to use this method.</p>
+<p>This method must be called before <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a>, and cannot
+be called multiple times.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.25.9"></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>enter_fn</p></td>
+<td class="parameter_description"><p>function called when aquiring the Clutter main lock</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>leave_fn</p></td>
+<td class="parameter_description"><p>function called when releasing the Clutter main lock</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-init"></a><h3>clutter_threads_init ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_threads_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_threads_init</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>This function does not do anything. Threading support
+  is initialized when Clutter is initialized.</p>
+</div>
+<p>Initialises the Clutter threading mechanism, so that Clutter API can be
+called by multiple threads, using <a class="link" href="clutter-General.html#clutter-threads-enter" title="clutter_threads_enter ()"><code class="function">clutter_threads_enter()</code></a> and
+<a class="link" href="clutter-General.html#clutter-threads-leave" title="clutter_threads_leave ()"><code class="function">clutter_threads_leave()</code></a> to mark the critical sections.</p>
+<p>You must call <code class="function">g_thread_init()</code> before this function.</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>It is safe to call this function multiple times.</p>
+<p class="since">Since 0.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-enter"></a><h3>clutter_threads_enter ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_threads_enter (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_threads_enter</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
+<p>This function should not be used by application
+  code; marking critical sections is not portable on various
+  platforms. Instead of acquiring the Clutter lock, schedule UI
+  updates from the main loop using <a class="link" href="clutter-General.html#clutter-threads-add-idle" title="clutter_threads_add_idle ()"><code class="function">clutter_threads_add_idle()</code></a> or
+  <a class="link" href="clutter-General.html#clutter-threads-add-timeout" title="clutter_threads_add_timeout ()"><code class="function">clutter_threads_add_timeout()</code></a>.</p>
+</div>
+<p>Locks the Clutter thread lock.</p>
+<p class="since">Since 0.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-leave"></a><h3>clutter_threads_leave ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_threads_leave (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_threads_leave</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
+<p>This function should not be used by application
+  code; marking critical sections is not portable on various
+  platforms. Instead of acquiring the Clutter lock, schedule UI
+  updates from the main loop using <a class="link" href="clutter-General.html#clutter-threads-add-idle" title="clutter_threads_add_idle ()"><code class="function">clutter_threads_add_idle()</code></a> or
+  <a class="link" href="clutter-General.html#clutter-threads-add-timeout" title="clutter_threads_add_timeout ()"><code class="function">clutter_threads_add_timeout()</code></a>.</p>
+</div>
+<p>Unlocks the Clutter thread lock.</p>
+<p class="since">Since 0.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-add-idle"></a><h3>clutter_threads_add_idle ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+clutter_threads_add_idle (<em class="parameter"><code><span class="type">GSourceFunc</span> func</code></em>,
+                          <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
+<p>Simple wrapper around <a class="link" href="clutter-General.html#clutter-threads-add-idle-full" title="clutter_threads_add_idle_full ()"><code class="function">clutter_threads_add_idle_full()</code></a> using the
+default priority.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.29.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>func</p></td>
+<td class="parameter_description"><p>function to call</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p>data to pass to the function</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.29.6"></a><h4>Returns</h4>
+<p> the ID (greater than 0) of the event source.</p>
+<p></p>
+</div>
+<p class="since">Since 0.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-add-idle-full"></a><h3>clutter_threads_add_idle_full ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+clutter_threads_add_idle_full (<em class="parameter"><code><span class="type">gint</span> priority</code></em>,
+                               <em class="parameter"><code><span class="type">GSourceFunc</span> func</code></em>,
+                               <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
+                               <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
+<p>Adds a function to be called whenever there are no higher priority
+events pending. If the function returns <code class="literal">FALSE</code> it is automatically
+removed from the list of event sources and will not be called again.</p>
+<p>This function can be considered a thread-safe variant of <code class="function">g_idle_add_full()</code>:
+it will call <em class="parameter"><code>function</code></em>
+ while holding the Clutter lock. It is logically
+equivalent to the following implementation:</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28
+29
+30
+31
+32
+33</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> gboolean</span>
+<span class="function">idle_safe_callback</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">gpointer</span><span class="normal"> data</span><span class="symbol">)</span>
+<span class="cbracket">{</span>
+<span class="normal">   </span><span class="usertype">SafeClosure</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">closure </span><span class="symbol">=</span><span class="normal"> data</span><span class="symbol">;</span>
+<span class="normal">   </span><span class="usertype">gboolean</span><span class="normal"> res </span><span class="symbol">=</span><span class="normal"> FALSE</span><span class="symbol">;</span>
+<span class="normal">   </span><span class="comment">// mark the critical section //</span>
+<span class="normal">   </span><span class="function"><a href="clutter-General.html#clutter-threads-enter">clutter_threads_enter</a></span><span class="symbol">();</span>
+<span class="normal">   </span><span class="comment">// the callback does not need to acquire the Clutter</span>
+<span class="normal">    </span><span class="symbol">/</span><span class="normal"> </span><span class="usertype">lock</span><span class="normal"> itself</span><span class="symbol">,</span><span class="normal"> as it is held by the this proxy handler</span>
+<span class="normal">    </span><span class="comment">//</span>
+<span class="normal">   res </span><span class="symbol">=</span><span class="normal"> closure</span><span class="symbol">-&gt;</span><span class="function">callback</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">closure</span><span class="symbol">-&gt;</span><span class="normal">data</span><span class="symbol">);</span>
+<span class="normal">   </span><span class="function"><a href="clutter-General.html#clutter-threads-leave">clutter_threads_leave</a></span><span class="symbol">();</span>
+<span class="normal">   </span><span class="keyword">return</span><span class="normal"> res</span><span class="symbol">;</span>
+<span class="cbracket">}</span>
+<span class="keyword">static</span><span class="normal"> gulong</span>
+<span class="function">add_safe_idle</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">GSourceFunc</span><span class="normal"> callback</span><span class="symbol">,</span>
+<span class="normal">               </span><span class="usertype">gpointer</span><span class="normal">    data</span><span class="symbol">)</span>
+<span class="cbracket">{</span>
+<span class="normal">  </span><span class="usertype">SafeClosure</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">closure </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_new0</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">SafeClosure</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1</span><span class="symbol">);</span>
+<span class="normal">  closure</span><span class="symbol">-&gt;</span><span class="normal">callback </span><span class="symbol">=</span><span class="normal"> callback</span><span class="symbol">;</span>
+<span class="normal">  closure</span><span class="symbol">-&gt;</span><span class="normal">data </span><span class="symbol">=</span><span class="normal"> data</span><span class="symbol">;</span>
+<span class="normal">  </span><span class="keyword">return</span><span class="normal"> </span><span class="function">g_idle_add_full</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">G_PRIORITY_DEFAULT_IDLE</span><span class="symbol">,</span>
+<span class="normal">                          idle_safe_callback</span><span class="symbol">,</span>
+<span class="normal">                          closure</span><span class="symbol">,</span>
+<span class="normal">                          g_free</span><span class="symbol">)</span>
+<span class="cbracket">}</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p></p>
+<p>This function should be used by threaded applications to make sure
+that <em class="parameter"><code>func</code></em>
+ is emitted under the Clutter threads lock and invoked
+from the same thread that started the Clutter main loop. For instance,
+it can be used to update the UI using the results from a worker
+thread:</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20
+21
+22
+23
+24
+25
+26
+27
+28</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> gboolean</span>
+<span class="function">update_ui</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">gpointer</span><span class="normal"> data</span><span class="symbol">)</span>
+<span class="cbracket">{</span>
+<span class="normal">  </span><span class="usertype">SomeClosure</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">closure </span><span class="symbol">=</span><span class="normal"> data</span><span class="symbol">;</span>
+<span class="normal">  </span><span class="comment">// it is safe to call Clutter API from this function because</span>
+<span class="normal">   </span><span class="symbol">/</span><span class="normal"> it is invoked from the same thread that started the main</span>
+<span class="normal">   </span><span class="symbol">/</span><span class="normal"> loop and under the Clutter thread lock</span>
+<span class="normal">   </span><span class="comment">//</span>
+<span class="normal">  </span><span class="function">clutter_label_set_text</span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_LABEL</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">closure</span><span class="symbol">-&gt;</span><span class="normal">label</span><span class="symbol">),</span>
+<span class="normal">                          closure</span><span class="symbol">-&gt;</span><span class="normal">text</span><span class="symbol">);</span>
+<span class="normal">  </span><span class="function">g_object_unref</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">closure</span><span class="symbol">-&gt;</span><span class="normal">label</span><span class="symbol">);</span>
+<span class="normal">  </span><span class="function">g_free</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">closure</span><span class="symbol">);</span>
+<span class="normal">  </span><span class="keyword">return</span><span class="normal"> FALSE</span><span class="symbol">;</span>
+<span class="cbracket">}</span>
+<span class="normal">  </span><span class="comment">// within another thread //</span>
+<span class="normal">  closure </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_new0</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">SomeClosure</span><span class="symbol">,</span><span class="normal"> </span><span class="number">1</span><span class="symbol">);</span>
+<span class="normal">  </span><span class="comment">// always take a reference on GObject instances //</span>
+<span class="normal">  closure</span><span class="symbol">-&gt;</span><span class="normal">label </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_object_ref</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">my_application</span><span class="symbol">-&gt;</span><span class="normal">label</span><span class="symbol">);</span>
+<span class="normal">  closure</span><span class="symbol">-&gt;</span><span class="normal">text </span><span class="symbol">=</span><span class="normal"> </span><span class="function">g_strdup</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">processed_text_to_update_the_label</span><span class="symbol">);</span>
+<span class="normal">  </span><span class="function"><a href="clutter-General.html#clutter-threads-add-idle-full">clutter_threads_add_idle_full</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">G_PRIORITY_HIGH_IDLE</span><span class="symbol">,</span>
+<span class="normal">                                 update_ui</span><span class="symbol">,</span>
+<span class="normal">                                 closure</span><span class="symbol">,</span>
+<span class="normal">                                 NULL</span><span class="symbol">);</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p></p>
+<p>Rename to: clutter_threads_add_idle</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.30.12"></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>priority</p></td>
+<td class="parameter_description"><p>the priority of the timeout source. Typically this will be in the
+range between <span class="type">G_PRIORITY_DEFAULT_IDLE</span> and <span class="type">G_PRIORITY_HIGH_IDLE</span></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>func</p></td>
+<td class="parameter_description"><p>function to call</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p>data to pass to the function</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>notify</p></td>
+<td class="parameter_description"><p>functio to call when the idle source is removed</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.30.13"></a><h4>Returns</h4>
+<p> the ID (greater than 0) of the event source.</p>
+<p></p>
+</div>
+<p class="since">Since 0.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-add-timeout"></a><h3>clutter_threads_add_timeout ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+clutter_threads_add_timeout (<em class="parameter"><code><span class="type">guint</span> interval</code></em>,
+                             <em class="parameter"><code><span class="type">GSourceFunc</span> func</code></em>,
+                             <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
+<p>Simple wrapper around <a class="link" href="clutter-General.html#clutter-threads-add-timeout-full" title="clutter_threads_add_timeout_full ()"><code class="function">clutter_threads_add_timeout_full()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.31.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>interval</p></td>
+<td class="parameter_description"><p>the time between calls to the function, in milliseconds</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>func</p></td>
+<td class="parameter_description"><p>function to call</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p>data to pass to the function</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.31.6"></a><h4>Returns</h4>
+<p> the ID (greater than 0) of the event source.</p>
+<p></p>
+</div>
+<p class="since">Since 0.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-add-timeout-full"></a><h3>clutter_threads_add_timeout_full ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+clutter_threads_add_timeout_full (<em class="parameter"><code><span class="type">gint</span> priority</code></em>,
+                                  <em class="parameter"><code><span class="type">guint</span> interval</code></em>,
+                                  <em class="parameter"><code><span class="type">GSourceFunc</span> func</code></em>,
+                                  <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
+                                  <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
+<p>Sets a function to be called at regular intervals holding the Clutter
+threads lock, with the given priority. The function is called repeatedly
+until it returns <code class="literal">FALSE</code>, at which point the timeout is automatically
+removed and the function will not be called again. The <em class="parameter"><code>notify</code></em>
+ function
+is called when the timeout is removed.</p>
+<p>The first call to the function will be at the end of the first <em class="parameter"><code>interval</code></em>
+.</p>
+<p>It is important to note that, due to how the Clutter main loop is
+implemented, the timing will not be accurate and it will not try to
+"keep up" with the interval.</p>
+<p>See also <a class="link" href="clutter-General.html#clutter-threads-add-idle-full" title="clutter_threads_add_idle_full ()"><code class="function">clutter_threads_add_idle_full()</code></a>.</p>
+<p>Rename to: clutter_threads_add_timeout</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.32.9"></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>priority</p></td>
+<td class="parameter_description"><p>the priority of the timeout source. Typically this will be in the
+range between <span class="type">G_PRIORITY_DEFAULT</span> and <span class="type">G_PRIORITY_HIGH</span>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>interval</p></td>
+<td class="parameter_description"><p>the time between calls to the function, in milliseconds</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>func</p></td>
+<td class="parameter_description"><p>function to call</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p>data to pass to the function</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>notify</p></td>
+<td class="parameter_description"><p>function to call when the timeout source is removed</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.32.10"></a><h4>Returns</h4>
+<p> the ID (greater than 0) of the event source.</p>
+<p></p>
+</div>
+<p class="since">Since 0.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-add-frame-source"></a><h3>clutter_threads_add_frame_source ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+clutter_threads_add_frame_source (<em class="parameter"><code><span class="type">guint</span> fps</code></em>,
+                                  <em class="parameter"><code><span class="type">GSourceFunc</span> func</code></em>,
+                                  <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
+<div class="warning"><p><code class="literal">clutter_threads_add_frame_source</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
+<p>Simple wrapper around <a class="link" href="clutter-General.html#clutter-threads-add-frame-source-full" title="clutter_threads_add_frame_source_full ()"><code class="function">clutter_threads_add_frame_source_full()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.33.7"></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>fps</p></td>
+<td class="parameter_description"><p>the number of times per second to call the function</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>func</p></td>
+<td class="parameter_description"><p>function to call</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p>data to pass to the function</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.33.8"></a><h4>Returns</h4>
+<p> the ID (greater than 0) of the event source.</p>
+<p></p>
+</div>
+<p class="since">Since 0.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-add-frame-source-full"></a><h3>clutter_threads_add_frame_source_full ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+clutter_threads_add_frame_source_full (<em class="parameter"><code><span class="type">gint</span> priority</code></em>,
+                                       <em class="parameter"><code><span class="type">guint</span> fps</code></em>,
+                                       <em class="parameter"><code><span class="type">GSourceFunc</span> func</code></em>,
+                                       <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
+                                       <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
+<div class="warning"><p><code class="literal">clutter_threads_add_frame_source_full</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
+<p>Sets a function to be called at regular intervals holding the Clutter
+threads lock, with the given priority. The function is called repeatedly
+until it returns <code class="literal">FALSE</code>, at which point the timeout is automatically
+removed and the function will not be called again. The <em class="parameter"><code>notify</code></em>
+ function
+is called when the timeout is removed.</p>
+<p>This function is similar to <a class="link" href="clutter-General.html#clutter-threads-add-timeout-full" title="clutter_threads_add_timeout_full ()"><code class="function">clutter_threads_add_timeout_full()</code></a>
+except that it will try to compensate for delays. For example, if
+<em class="parameter"><code>func</code></em>
+ takes half the interval time to execute then the function
+will be called again half the interval time after it finished. In
+contrast <a class="link" href="clutter-General.html#clutter-threads-add-timeout-full" title="clutter_threads_add_timeout_full ()"><code class="function">clutter_threads_add_timeout_full()</code></a> would not fire until a
+full interval after the function completes so the delay between
+calls would be <em class="parameter"><code>interval</code></em>
+ * 1.5. This function does not however try
+to invoke the function multiple times to catch up missing frames if
+<em class="parameter"><code>func</code></em>
+ takes more than <em class="parameter"><code>interval</code></em>
+ ms to execute.</p>
+<p>See also <a class="link" href="clutter-General.html#clutter-threads-add-idle-full" title="clutter_threads_add_idle_full ()"><code class="function">clutter_threads_add_idle_full()</code></a>.</p>
+<p>Rename to: clutter_threads_add_frame_source</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.34.10"></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>priority</p></td>
+<td class="parameter_description"><p>the priority of the frame source. Typically this will be in the
+range between <code class="literal">G_PRIORITY_DEFAULT</code> and <code class="literal">G_PRIORITY_HIGH</code>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>fps</p></td>
+<td class="parameter_description"><p>the number of times per second to call the function</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>func</p></td>
+<td class="parameter_description"><p>function to call</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p>data to pass to the function</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>notify</p></td>
+<td class="parameter_description"><p>function to call when the timeout source is removed</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.34.11"></a><h4>Returns</h4>
+<p> the ID (greater than 0) of the event source.</p>
+<p></p>
+</div>
+<p class="since">Since 0.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-add-repaint-func"></a><h3>clutter_threads_add_repaint_func ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+clutter_threads_add_repaint_func (<em class="parameter"><code><span class="type">GSourceFunc</span> func</code></em>,
+                                  <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
+                                  <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
+<p>Adds a function to be called whenever Clutter is processing a new
+frame.</p>
+<p>If the function returns <code class="literal">FALSE</code> it is automatically removed from the
+list of repaint functions and will not be called again.</p>
+<p>This function is guaranteed to be called from within the same thread
+that called <a class="link" href="clutter-General.html#clutter-main" title="clutter_main ()"><code class="function">clutter_main()</code></a>, and while the Clutter lock is being held;
+the function will be called within the main loop, so it is imperative
+that it does not block, otherwise the frame time budget may be lost.</p>
+<p>A repaint function is useful to ensure that an update of the scenegraph
+is performed before the scenegraph is repainted; for instance, uploading
+a frame from a video into a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>. By default, a repaint
+function added using this function will be invoked prior to the frame
+being processed.</p>
+<p>Adding a repaint function does not automatically ensure that a new
+frame will be queued.</p>
+<p>When the repaint function is removed (either because it returned <code class="literal">FALSE</code>
+or because <a class="link" href="clutter-General.html#clutter-threads-remove-repaint-func" title="clutter_threads_remove_repaint_func ()"><code class="function">clutter_threads_remove_repaint_func()</code></a> has been called) the
+<em class="parameter"><code>notify</code></em>
+ function will be called, if any is set.</p>
+<p>See also: <a class="link" href="clutter-General.html#clutter-threads-add-repaint-func-full" title="clutter_threads_add_repaint_func_full ()"><code class="function">clutter_threads_add_repaint_func_full()</code></a></p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.35.11"></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>func</p></td>
+<td class="parameter_description"><p>the function to be called within the paint cycle</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p>data to be passed to the function, or <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>notify</p></td>
+<td class="parameter_description"><p>function to be called when removing the repaint
+function, or <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.35.12"></a><h4>Returns</h4>
+<p> the ID (greater than 0) of the repaint function. You
+can use the returned integer to remove the repaint function by
+calling <a class="link" href="clutter-General.html#clutter-threads-remove-repaint-func" title="clutter_threads_remove_repaint_func ()"><code class="function">clutter_threads_remove_repaint_func()</code></a>.</p>
+<p></p>
+</div>
+<p class="since">Since 1.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-add-repaint-func-full"></a><h3>clutter_threads_add_repaint_func_full ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint</span>
+clutter_threads_add_repaint_func_full (<em class="parameter"><code><a class="link" href="clutter-General.html#ClutterRepaintFlags" title="enum ClutterRepaintFlags"><span class="type">ClutterRepaintFlags</span></a> flags</code></em>,
+                                       <em class="parameter"><code><span class="type">GSourceFunc</span> func</code></em>,
+                                       <em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
+                                       <em class="parameter"><code><span class="type">GDestroyNotify</span> notify</code></em>);</pre>
+<p>Adds a function to be called whenever Clutter is processing a new
+frame.</p>
+<p>If the function returns <code class="literal">FALSE</code> it is automatically removed from the
+list of repaint functions and will not be called again.</p>
+<p>This function is guaranteed to be called from within the same thread
+that called <a class="link" href="clutter-General.html#clutter-main" title="clutter_main ()"><code class="function">clutter_main()</code></a>, and while the Clutter lock is being held;
+the function will be called within the main loop, so it is imperative
+that it does not block, otherwise the frame time budget may be lost.</p>
+<p>A repaint function is useful to ensure that an update of the scenegraph
+is performed before the scenegraph is repainted; for instance, uploading
+a frame from a video into a <a class="link" href="ClutterTexture.html" title="ClutterTexture"><span class="type">ClutterTexture</span></a>. The <em class="parameter"><code>flags</code></em>
+ passed to this
+function will determine the section of the frame processing that will
+result in <em class="parameter"><code>func</code></em>
+ being called.</p>
+<p>Adding a repaint function does not automatically ensure that a new
+frame will be queued.</p>
+<p>When the repaint function is removed (either because it returned <code class="literal">FALSE</code>
+or because <a class="link" href="clutter-General.html#clutter-threads-remove-repaint-func" title="clutter_threads_remove_repaint_func ()"><code class="function">clutter_threads_remove_repaint_func()</code></a> has been called) the
+<em class="parameter"><code>notify</code></em>
+ function will be called, if any is set.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.36.10"></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>flags</p></td>
+<td class="parameter_description"><p>flags for the repaint function</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>func</p></td>
+<td class="parameter_description"><p>the function to be called within the paint cycle</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>data</p></td>
+<td class="parameter_description"><p>data to be passed to the function, or <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>notify</p></td>
+<td class="parameter_description"><p>function to be called when removing the repaint
+function, or <code class="literal">NULL</code></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.36.11"></a><h4>Returns</h4>
+<p> the ID (greater than 0) of the repaint function. You
+can use the returned integer to remove the repaint function by
+calling <a class="link" href="clutter-General.html#clutter-threads-remove-repaint-func" title="clutter_threads_remove_repaint_func ()"><code class="function">clutter_threads_remove_repaint_func()</code></a>.</p>
+<p></p>
+</div>
+<p class="since">Since 1.10</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-threads-remove-repaint-func"></a><h3>clutter_threads_remove_repaint_func ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_threads_remove_repaint_func (<em class="parameter"><code><span class="type">guint</span> handle_id</code></em>);</pre>
+<p>Removes the repaint function with <em class="parameter"><code>handle_id</code></em>
+ as its id</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.37.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>handle_id</p></td>
+<td class="parameter_description"><p>an unsigned integer greater than zero</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p class="since">Since 1.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-keyboard-grab"></a><h3>clutter_get_keyboard_grab ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
+clutter_get_keyboard_grab (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Queries the current keyboard grab of clutter.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.38.5"></a><h4>Returns</h4>
+<p> the actor currently holding the keyboard grab, or NULL if there is no grab. </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 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-get-pointer-grab"></a><h3>clutter_get_pointer_grab ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
+clutter_get_pointer_grab (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Queries the current pointer grab of clutter.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.39.5"></a><h4>Returns</h4>
+<p> the actor currently holding the pointer grab, or NULL if there is no grab. </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 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-grab-keyboard"></a><h3>clutter_grab_keyboard ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_grab_keyboard (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
+<p>Grabs keyboard events, after the grab is done keyboard
+events (<a class="link" href="ClutterActor.html#ClutterActor-key-press-event" title="The “key-press-event” signal"><span class="type">“key-press-event”</span></a> and <a class="link" href="ClutterActor.html#ClutterActor-key-release-event" title="The “key-release-event” signal"><span class="type">“key-release-event”</span></a>)
+are delivered to this actor directly. The source set in the event will be
+the actor that would have received the event if the keyboard grab was not
+in effect.</p>
+<p>Like pointer grabs, keyboard grabs should only be used as a last
+resource.</p>
+<p>See also <a class="link" href="ClutterStage.html#clutter-stage-set-key-focus" title="clutter_stage_set_key_focus ()"><code class="function">clutter_stage_set_key_focus()</code></a> and <a class="link" href="ClutterActor.html#clutter-actor-grab-key-focus" title="clutter_actor_grab_key_focus ()"><code class="function">clutter_actor_grab_key_focus()</code></a>
+to perform a "soft" key grab and assign key focus to a specific actor.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.40.7"></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>actor</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-grab-pointer"></a><h3>clutter_grab_pointer ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_grab_pointer (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>);</pre>
+<p>Grabs pointer events, after the grab is done all pointer related events
+(press, motion, release, enter, leave and scroll) are delivered to this
+actor directly without passing through both capture and bubble phases of
+the event delivery chain. The source set in the event will be the actor
+that would have received the event if the pointer grab was not in effect.</p>
+<p>Grabs completely override the entire event delivery chain
+done by Clutter. Pointer grabs should only be used as a last resource;
+using the <a class="link" href="ClutterActor.html#ClutterActor-captured-event" title="The “captured-event” signal"><span class="type">“captured-event”</span></a> signal should always be the
+preferred way to intercept event delivery to reactive actors.</p>
+<p>This function should rarely be used.</p>
+<p>If a grab is required, you are strongly encouraged to use a specific
+input device by calling <a class="link" href="ClutterInputDevice.html#clutter-input-device-grab" title="clutter_input_device_grab ()"><code class="function">clutter_input_device_grab()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.41.8"></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>actor</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-ungrab-keyboard"></a><h3>clutter_ungrab_keyboard ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_ungrab_keyboard (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Removes an existing grab of the keyboard.</p>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-ungrab-pointer"></a><h3>clutter_ungrab_pointer ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_ungrab_pointer (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>Removes an existing grab of the pointer.</p>
+<p class="since">Since 0.6</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-grab-pointer-for-device"></a><h3>clutter_grab_pointer_for_device ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_grab_pointer_for_device (<em class="parameter"><code><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> *actor</code></em>,
+                                 <em class="parameter"><code><span class="type">gint</span> id_</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_grab_pointer_for_device</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="ClutterInputDevice.html#clutter-input-device-grab" title="clutter_input_device_grab ()"><code class="function">clutter_input_device_grab()</code></a> instead.</p>
+</div>
+<p>Grabs all the pointer events coming from the device <em class="parameter"><code>id</code></em>
+ for <em class="parameter"><code>actor</code></em>
+.</p>
+<p>If <em class="parameter"><code>id</code></em>
+ is -1 then this function is equivalent to <a class="link" href="clutter-General.html#clutter-grab-pointer" title="clutter_grab_pointer ()"><code class="function">clutter_grab_pointer()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.44.8"></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>actor</p></td>
+<td class="parameter_description"><p>a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>id_</p></td>
+<td class="parameter_description"><p>a device id, or -1</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-ungrab-pointer-for-device"></a><h3>clutter_ungrab_pointer_for_device ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_ungrab_pointer_for_device (<em class="parameter"><code><span class="type">gint</span> id_</code></em>);</pre>
+<div class="warning">
+<p><code class="literal">clutter_ungrab_pointer_for_device</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
+<p>Use <a class="link" href="ClutterInputDevice.html#clutter-input-device-ungrab" title="clutter_input_device_ungrab ()"><code class="function">clutter_input_device_ungrab()</code></a> instead.</p>
+</div>
+<p>Removes an existing grab of the pointer events for device <em class="parameter"><code>id_</code></em>
+.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.45.7"></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>id_</p></td>
+<td class="parameter_description"><p>a device id</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p class="since">Since 0.8</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-do-event"></a><h3>clutter_do_event ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>
+clutter_do_event (<em class="parameter"><code><a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> *event</code></em>);</pre>
+<p>Processes an event.</p>
+<p>The <em class="parameter"><code>event</code></em>
+ must be a valid <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a> and have a <a class="link" href="ClutterStage.html" title="ClutterStage"><span class="type">ClutterStage</span></a>
+associated to it.</p>
+<p>This function is only useful when embedding Clutter inside another
+toolkit, and it should never be called by applications.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.6.46.7"></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>event</p></td>
+<td class="parameter_description"><p>a <a class="link" href="clutter-Events.html#ClutterEvent" title="union ClutterEvent"><span class="type">ClutterEvent</span></a>.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<p class="since">Since 0.4</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="clutter-General.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="ClutterInitError"></a><h3>enum ClutterInitError</h3>
+<p>Error conditions returned by <a class="link" href="clutter-General.html#clutter-init" title="clutter_init ()"><code class="function">clutter_init()</code></a> and <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>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.7.2.4"></a><h4>Members</h4>
+<div class="informaltable"><table 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-INIT-SUCCESS:CAPS"></a>CLUTTER_INIT_SUCCESS</p></td>
+<td class="enum_member_description">
+<p>Initialisation successful</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-INIT-ERROR-UNKNOWN:CAPS"></a>CLUTTER_INIT_ERROR_UNKNOWN</p></td>
+<td class="enum_member_description">
+<p>Unknown error</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-INIT-ERROR-THREADS:CAPS"></a>CLUTTER_INIT_ERROR_THREADS</p></td>
+<td class="enum_member_description">
+<p>Thread initialisation failed</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-INIT-ERROR-BACKEND:CAPS"></a>CLUTTER_INIT_ERROR_BACKEND</p></td>
+<td class="enum_member_description">
+<p>Backend initialisation failed</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-INIT-ERROR-INTERNAL:CAPS"></a>CLUTTER_INIT_ERROR_INTERNAL</p></td>
+<td class="enum_member_description">
+<p>Internal error</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 0.2</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterFontFlags"></a><h3>enum ClutterFontFlags</h3>
+<p>Runtime flags to change the font quality. To be used with
+<a class="link" href="clutter-General.html#clutter-set-font-flags" title="clutter_set_font_flags ()"><code class="function">clutter_set_font_flags()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.7.3.4"></a><h4>Members</h4>
+<div class="informaltable"><table 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-FONT-MIPMAPPING:CAPS"></a>CLUTTER_FONT_MIPMAPPING</p></td>
+<td class="enum_member_description">
+<p>Set to use mipmaps for the glyph cache textures.</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-FONT-HINTING:CAPS"></a>CLUTTER_FONT_HINTING</p></td>
+<td class="enum_member_description">
+<p>Set to enable hinting on the glyphs.</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 1.0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterTextDirection"></a><h3>enum ClutterTextDirection</h3>
+<p>The text direction to be used by <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>&lt;!-- --&gt;s</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.7.4.4"></a><h4>Members</h4>
+<div class="informaltable"><table 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-TEXT-DIRECTION-DEFAULT:CAPS"></a>CLUTTER_TEXT_DIRECTION_DEFAULT</p></td>
+<td class="enum_member_description">
+<p>Use the default setting, as returned
+  by <a class="link" href="clutter-General.html#clutter-get-default-text-direction" title="clutter_get_default_text_direction ()"><code class="function">clutter_get_default_text_direction()</code></a></p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-TEXT-DIRECTION-LTR:CAPS"></a>CLUTTER_TEXT_DIRECTION_LTR</p></td>
+<td class="enum_member_description">
+<p>Use left-to-right text direction</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-TEXT-DIRECTION-RTL:CAPS"></a>CLUTTER_TEXT_DIRECTION_RTL</p></td>
+<td class="enum_member_description">
+<p>Use right-to-left text direction</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 1.2</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterRepaintFlags"></a><h3>enum ClutterRepaintFlags</h3>
+<p>Flags to pass to <a class="link" href="clutter-General.html#clutter-threads-add-repaint-func-full" title="clutter_threads_add_repaint_func_full ()"><code class="function">clutter_threads_add_repaint_func_full()</code></a>.</p>
+<div class="refsect3">
+<a name="id-1.7.2.9.7.5.4"></a><h4>Members</h4>
+<div class="informaltable"><table 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-REPAINT-FLAGS-PRE-PAINT:CAPS"></a>CLUTTER_REPAINT_FLAGS_PRE_PAINT</p></td>
+<td class="enum_member_description">
+<p>Run the repaint function prior to
+  painting the stages</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-REPAINT-FLAGS-POST-PAINT:CAPS"></a>CLUTTER_REPAINT_FLAGS_POST_PAINT</p></td>
+<td class="enum_member_description">
+<p>Run the repaint function after
+  painting the stages</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+<tr>
+<td class="enum_member_name"><p><a name="CLUTTER-REPAINT-FLAGS-QUEUE-REDRAW-ON-ADD:CAPS"></a>CLUTTER_REPAINT_FLAGS_QUEUE_REDRAW_ON_ADD</p></td>
+<td class="enum_member_description">
+<p>Ensure that a new frame
+  is queued after adding the repaint function</p>
+</td>
+<td class="enum_member_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<p class="since">Since 1.10</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20.1</div>
+</body>
+</html>