~ubuntu-branches/ubuntu/vivid/clutter-1.0/vivid-proposed

« back to all changes in this revision

Viewing changes to doc/reference/clutter/html/clutter-Utilities.html

  • Committer: Package Import Robot
  • Author(s): Michael Biebl
  • Date: 2012-05-01 16:49:06 UTC
  • mfrom: (1.3.25)
  • mto: This revision was merged to the branch mainline in revision 18.
  • Revision ID: package-import@ubuntu.com-20120501164906-ubqqkuxd8t1vakbh
Tags: 1.10.4-1
* New upstream release.
* debian/watch: Track stable releases.

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="ch11.html" title="General purpose API">
9
9
<link rel="prev" href="clutter-Unit-conversion.html" title="Unit conversion">
10
10
<link rel="next" href="clutter-Versioning-Macros.html" title="Versioning Macros">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
37
37
</tr></table></div>
38
38
<div class="refsynopsisdiv">
39
39
<a name="clutter-Utilities.synopsis"></a><h2>Synopsis</h2>
40
 
<pre class="synopsis"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="clutter-Utilities.html#clutter-util-next-p2" title="clutter_util_next_p2 ()">clutter_util_next_p2</a>                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> a</code></em>);
 
40
<pre class="synopsis"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="clutter-Utilities.html#clutter-util-next-p2" title="clutter_util_next_p2 ()">clutter_util_next_p2</a>                (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> a</code></em>);
41
41
 
42
 
<span class="returnvalue">ClutterTimeoutPool</span> * <a class="link" href="clutter-Utilities.html#clutter-timeout-pool-new" title="clutter_timeout_pool_new ()">clutter_timeout_pool_new</a>           (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>);
43
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="clutter-Utilities.html#clutter-timeout-pool-add" title="clutter_timeout_pool_add ()">clutter_timeout_pool_add</a>            (<em class="parameter"><code><span class="type">ClutterTimeoutPool</span> *pool</code></em>,
44
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
45
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
46
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
47
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
 
42
<span class="returnvalue">ClutterTimeoutPool</span> * <a class="link" href="clutter-Utilities.html#clutter-timeout-pool-new" title="clutter_timeout_pool_new ()">clutter_timeout_pool_new</a>           (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>);
 
43
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="clutter-Utilities.html#clutter-timeout-pool-add" title="clutter_timeout_pool_add ()">clutter_timeout_pool_add</a>            (<em class="parameter"><code><span class="type">ClutterTimeoutPool</span> *pool</code></em>,
 
44
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
 
45
                                                         <em class="parameter"><code><a href="../glib/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
 
46
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
 
47
                                                         <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
48
48
<span class="returnvalue">void</span>                <a class="link" href="clutter-Utilities.html#clutter-timeout-pool-remove" title="clutter_timeout_pool_remove ()">clutter_timeout_pool_remove</a>         (<em class="parameter"><code><span class="type">ClutterTimeoutPool</span> *pool</code></em>,
49
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id_</code></em>);
 
49
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id_</code></em>);
50
50
 
51
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="clutter-Utilities.html#clutter-frame-source-add" title="clutter_frame_source_add ()">clutter_frame_source_add</a>            (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
52
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
53
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
54
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="clutter-Utilities.html#clutter-frame-source-add-full" title="clutter_frame_source_add_full ()">clutter_frame_source_add_full</a>       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>,
55
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
56
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
57
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
58
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
 
51
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="clutter-Utilities.html#clutter-frame-source-add" title="clutter_frame_source_add ()">clutter_frame_source_add</a>            (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
 
52
                                                         <em class="parameter"><code><a href="../glib/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
 
53
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
 
54
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="clutter-Utilities.html#clutter-frame-source-add-full" title="clutter_frame_source_add_full ()">clutter_frame_source_add_full</a>       (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>,
 
55
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
 
56
                                                         <em class="parameter"><code><a href="../glib/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
 
57
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
 
58
                                                         <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);
59
59
 
60
60
struct              <a class="link" href="clutter-Utilities.html#ClutterParamSpecFixed" title="struct ClutterParamSpecFixed">ClutterParamSpecFixed</a>;
61
 
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *        <a class="link" href="clutter-Utilities.html#clutter-param-spec-fixed" title="clutter_param_spec_fixed ()">clutter_param_spec_fixed</a>            (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
62
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nick</code></em>,
63
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *blurb</code></em>,
 
61
<a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *        <a class="link" href="clutter-Utilities.html#clutter-param-spec-fixed" title="clutter_param_spec_fixed ()">clutter_param_spec_fixed</a>            (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 
62
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nick</code></em>,
 
63
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *blurb</code></em>,
64
64
                                                         <em class="parameter"><code><span class="type">CoglFixed</span> minimum</code></em>,
65
65
                                                         <em class="parameter"><code><span class="type">CoglFixed</span> maximum</code></em>,
66
66
                                                         <em class="parameter"><code><span class="type">CoglFixed</span> default_value</code></em>,
67
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</code></em>);
 
67
                                                         <em class="parameter"><code><a href="../gobject/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</code></em>);
68
68
#define             <a class="link" href="clutter-Utilities.html#CLUTTER-VALUE-HOLDS-FIXED:CAPS" title="CLUTTER_VALUE_HOLDS_FIXED()">CLUTTER_VALUE_HOLDS_FIXED</a>           (x)
69
 
<span class="returnvalue">void</span>                <a class="link" href="clutter-Utilities.html#clutter-value-set-fixed" title="clutter_value_set_fixed ()">clutter_value_set_fixed</a>             (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
 
69
<span class="returnvalue">void</span>                <a class="link" href="clutter-Utilities.html#clutter-value-set-fixed" title="clutter_value_set_fixed ()">clutter_value_set_fixed</a>             (<em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
70
70
                                                         <em class="parameter"><code><span class="type">CoglFixed</span> fixed_</code></em>);
71
 
<span class="returnvalue">CoglFixed</span>           <a class="link" href="clutter-Utilities.html#clutter-value-get-fixed" title="clutter_value_get_fixed ()">clutter_value_get_fixed</a>             (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
 
71
<span class="returnvalue">CoglFixed</span>           <a class="link" href="clutter-Utilities.html#clutter-value-get-fixed" title="clutter_value_get_fixed ()">clutter_value_get_fixed</a>             (<em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);
72
72
</pre>
73
73
</div>
74
74
<div class="refsect1">
81
81
<a name="clutter-Utilities.details"></a><h2>Details</h2>
82
82
<div class="refsect2">
83
83
<a name="clutter-util-next-p2"></a><h3>clutter_util_next_p2 ()</h3>
84
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                clutter_util_next_p2                (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> a</code></em>);</pre>
 
84
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                clutter_util_next_p2                (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> a</code></em>);</pre>
85
85
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
86
86
<h3 class="title">Warning</h3>
87
87
<p><code class="literal">clutter_util_next_p2</code> is deprecated and should not be used in newly-written code. 1.2</p>
106
106
<hr>
107
107
<div class="refsect2">
108
108
<a name="clutter-timeout-pool-new"></a><h3>clutter_timeout_pool_new ()</h3>
109
 
<pre class="programlisting"><span class="returnvalue">ClutterTimeoutPool</span> * clutter_timeout_pool_new           (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>);</pre>
 
109
<pre class="programlisting"><span class="returnvalue">ClutterTimeoutPool</span> * clutter_timeout_pool_new           (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>);</pre>
110
110
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
111
111
<h3 class="title">Warning</h3>
112
112
<p><code class="literal">clutter_timeout_pool_new</code> is deprecated and should not be used in newly-written code. 1.6</p>
114
114
<p>
115
115
Creates a new timeout pool source. A timeout pool should be used when
116
116
multiple timeout functions, running at the same priority, are needed and
117
 
the <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-timeout-add"><code class="function">g_timeout_add()</code></a> API might lead to starvation of the time slice of
 
117
the <a href="../glib/glib-The-Main-Event-Loop.html#g-timeout-add"><code class="function">g_timeout_add()</code></a> API might lead to starvation of the time slice of
118
118
the main loop. A timeout pool allocates a single time slice of the main
119
119
loop and runs every timeout function inside it. The timeout pool is
120
120
always sorted, so that the extraction of the next timeout function is
126
126
<tr>
127
127
<td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td>
128
128
<td>the priority of the timeout pool. Typically this will
129
 
be <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"><span class="type">G_PRIORITY_DEFAULT</span></a>
 
129
be <a href="../glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"><span class="type">G_PRIORITY_DEFAULT</span></a>
130
130
</td>
131
131
</tr>
132
132
<tr>
134
134
<td>the newly created <span class="type">ClutterTimeoutPool</span>. The created pool
135
135
is owned by the GLib default context and will be automatically
136
136
destroyed when the context is destroyed. It is possible to force
137
 
the destruction of the timeout pool using <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-source-destroy"><code class="function">g_source_destroy()</code></a>
 
137
the destruction of the timeout pool using <a href="../glib/glib-The-Main-Event-Loop.html#g-source-destroy"><code class="function">g_source_destroy()</code></a>
138
138
</td>
139
139
</tr>
140
140
</tbody>
144
144
<hr>
145
145
<div class="refsect2">
146
146
<a name="clutter-timeout-pool-add"></a><h3>clutter_timeout_pool_add ()</h3>
147
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_timeout_pool_add            (<em class="parameter"><code><span class="type">ClutterTimeoutPool</span> *pool</code></em>,
148
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
149
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
150
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
151
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
 
147
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_timeout_pool_add            (<em class="parameter"><code><span class="type">ClutterTimeoutPool</span> *pool</code></em>,
 
148
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
 
149
                                                         <em class="parameter"><code><a href="../glib/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
 
150
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
 
151
                                                         <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
152
152
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
153
153
<h3 class="title">Warning</h3>
154
154
<p><code class="literal">clutter_timeout_pool_add</code> is deprecated and should not be used in newly-written code. 1.6</p>
155
155
</div>
156
156
<p>
157
157
Sets a function to be called at regular intervals, and puts it inside
158
 
the <em class="parameter"><code>pool</code></em>. The function is repeatedly called until it returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>,
 
158
the <em class="parameter"><code>pool</code></em>. The function is repeatedly called until it returns <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>,
159
159
at which point the timeout is automatically destroyed and the function
160
 
won't be called again. If <em class="parameter"><code>notify</code></em> is not <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, the <em class="parameter"><code>notify</code></em> function
 
160
won't be called again. If <em class="parameter"><code>notify</code></em> is not <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>, the <em class="parameter"><code>notify</code></em> function
161
161
will be called. The first call to <em class="parameter"><code>func</code></em> will be at the end of <em class="parameter"><code>interval</code></em>.
162
162
</p>
163
163
<p>
188
188
</tr>
189
189
<tr>
190
190
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
191
 
<td>data to pass to the function, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
 
191
<td>data to pass to the function, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
192
192
</td>
193
193
</tr>
194
194
<tr>
195
195
<td><p><span class="term"><em class="parameter"><code>notify</code></em> :</span></p></td>
196
 
<td>function to call when the timeout is removed, or <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 
196
<td>function to call when the timeout is removed, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
197
197
</td>
198
198
</tr>
199
199
<tr>
209
209
<div class="refsect2">
210
210
<a name="clutter-timeout-pool-remove"></a><h3>clutter_timeout_pool_remove ()</h3>
211
211
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_timeout_pool_remove         (<em class="parameter"><code><span class="type">ClutterTimeoutPool</span> *pool</code></em>,
212
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id_</code></em>);</pre>
 
212
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id_</code></em>);</pre>
213
213
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
214
214
<h3 class="title">Warning</h3>
215
215
<p><code class="literal">clutter_timeout_pool_remove</code> is deprecated and should not be used in newly-written code. 1.6</p>
238
238
<hr>
239
239
<div class="refsect2">
240
240
<a name="clutter-frame-source-add"></a><h3>clutter_frame_source_add ()</h3>
241
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_frame_source_add            (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
242
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
243
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
 
241
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_frame_source_add            (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
 
242
                                                         <em class="parameter"><code><a href="../glib/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
 
243
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
244
244
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
245
245
<h3 class="title">Warning</h3>
246
246
<p><code class="literal">clutter_frame_source_add</code> is deprecated and should not be used in newly-written code. 1.6</p>
274
274
<hr>
275
275
<div class="refsect2">
276
276
<a name="clutter-frame-source-add-full"></a><h3>clutter_frame_source_add_full ()</h3>
277
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_frame_source_add_full       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>,
278
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
279
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
280
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
281
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
 
277
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               clutter_frame_source_add_full       (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> priority</code></em>,
 
278
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> fps</code></em>,
 
279
                                                         <em class="parameter"><code><a href="../glib/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> func</code></em>,
 
280
                                                         <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
 
281
                                                         <em class="parameter"><code><a href="../glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> notify</code></em>);</pre>
282
282
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
283
283
<h3 class="title">Warning</h3>
284
284
<p><code class="literal">clutter_frame_source_add_full</code> is deprecated and should not be used in newly-written code. 1.6</p>
286
286
<p>
287
287
Sets a function to be called at regular intervals with the given
288
288
priority.  The function is called repeatedly until it returns
289
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, at which point the timeout is automatically destroyed and
 
289
<a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, at which point the timeout is automatically destroyed and
290
290
the function will not be called again.  The <em class="parameter"><code>notify</code></em> function is
291
291
called when the timeout is destroyed.  The first call to the
292
292
function will be at the end of the first <em class="parameter"><code>interval</code></em>.
293
293
</p>
294
294
<p>
295
 
This function is similar to <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-timeout-add-full"><code class="function">g_timeout_add_full()</code></a> except that it
 
295
This function is similar to <a href="../glib/glib-The-Main-Event-Loop.html#g-timeout-add-full"><code class="function">g_timeout_add_full()</code></a> except that it
296
296
will try to compensate for delays. For example, if <em class="parameter"><code>func</code></em> takes half
297
297
the interval time to execute then the function will be called again
298
298
half the interval time after it finished. In contrast
299
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-timeout-add-full"><code class="function">g_timeout_add_full()</code></a> would not fire until a full interval after the
 
299
<a href="../glib/glib-The-Main-Event-Loop.html#g-timeout-add-full"><code class="function">g_timeout_add_full()</code></a> would not fire until a full interval after the
300
300
function completes so the delay between calls would be 1.0 / <em class="parameter"><code>fps</code></em> *
301
301
1.5. This function does not however try to invoke the function
302
302
multiple times to catch up missing frames if <em class="parameter"><code>func</code></em> takes more than
311
311
<tr>
312
312
<td><p><span class="term"><em class="parameter"><code>priority</code></em> :</span></p></td>
313
313
<td>the priority of the frame source. Typically this will be in the
314
 
range between <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"><code class="literal">G_PRIORITY_DEFAULT</code></a> and <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#G-PRIORITY-HIGH:CAPS"><code class="literal">G_PRIORITY_HIGH</code></a>.</td>
 
314
range between <a href="../glib/glib-The-Main-Event-Loop.html#G-PRIORITY-DEFAULT:CAPS"><code class="literal">G_PRIORITY_DEFAULT</code></a> and <a href="../glib/glib-The-Main-Event-Loop.html#G-PRIORITY-HIGH:CAPS"><code class="literal">G_PRIORITY_HIGH</code></a>.</td>
315
315
</tr>
316
316
<tr>
317
317
<td><p><span class="term"><em class="parameter"><code>fps</code></em> :</span></p></td>
348
348
</pre>
349
349
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
350
350
<h3 class="title">Warning</h3>
351
 
<p><code class="literal">ClutterParamSpecFixed</code> is deprecated and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#GParamSpecInt"><span class="type">GParamSpecInt</span></a> instead</p>
 
351
<p><code class="literal">ClutterParamSpecFixed</code> is deprecated and should not be used in newly-written code. Use <a href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#GParamSpecInt"><span class="type">GParamSpecInt</span></a> instead</p>
352
352
</div>
353
353
<p>
354
 
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> subclass for fixed point based properties
 
354
<a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> subclass for fixed point based properties
355
355
</p>
356
356
<div class="variablelist"><table border="0">
357
357
<col align="left" valign="top">
375
375
<hr>
376
376
<div class="refsect2">
377
377
<a name="clutter-param-spec-fixed"></a><h3>clutter_param_spec_fixed ()</h3>
378
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *        clutter_param_spec_fixed            (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
379
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nick</code></em>,
380
 
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *blurb</code></em>,
 
378
<pre class="programlisting"><a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="returnvalue">GParamSpec</span></a> *        clutter_param_spec_fixed            (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 
379
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *nick</code></em>,
 
380
                                                         <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *blurb</code></em>,
381
381
                                                         <em class="parameter"><code><span class="type">CoglFixed</span> minimum</code></em>,
382
382
                                                         <em class="parameter"><code><span class="type">CoglFixed</span> maximum</code></em>,
383
383
                                                         <em class="parameter"><code><span class="type">CoglFixed</span> default_value</code></em>,
384
 
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</code></em>);</pre>
 
384
                                                         <em class="parameter"><code><a href="../gobject/gobject-GParamSpec.html#GParamFlags"><span class="type">GParamFlags</span></a> flags</code></em>);</pre>
385
385
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
386
386
<h3 class="title">Warning</h3>
387
 
<p><code class="literal">clutter_param_spec_fixed</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#GParamSpecInt"><span class="type">GParamSpecInt</span></a> instead.</p>
 
387
<p><code class="literal">clutter_param_spec_fixed</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#GParamSpecInt"><span class="type">GParamSpecInt</span></a> instead.</p>
388
388
</div>
389
389
<p>
390
 
Creates a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> for properties using <span class="type">CoglFixed</span> values
 
390
Creates a <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> for properties using <span class="type">CoglFixed</span> values
391
391
</p>
392
392
<div class="variablelist"><table border="0">
393
393
<col align="left" valign="top">
422
422
</tr>
423
423
<tr>
424
424
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
425
 
<td>the newly created <a href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
425
<td>the newly created <a href="../gobject/gobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
426
426
</td>
427
427
</tr>
428
428
</tbody>
436
436
</pre>
437
437
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
438
438
<h3 class="title">Warning</h3>
439
 
<p><code class="literal">CLUTTER_VALUE_HOLDS_FIXED</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#G-VALUE-HOLDS-INT:CAPS"><code class="literal">G_VALUE_HOLDS_INT</code></a> instead</p>
 
439
<p><code class="literal">CLUTTER_VALUE_HOLDS_FIXED</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#G-VALUE-HOLDS-INT:CAPS"><code class="literal">G_VALUE_HOLDS_INT</code></a> instead</p>
440
440
</div>
441
441
<p>
442
 
Evaluates to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>x</code></em> holds a <span class="type">CoglFixed</span>   .
 
442
Evaluates to <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>x</code></em> holds a <span class="type">CoglFixed</span>   .
443
443
</p>
444
444
<div class="variablelist"><table border="0">
445
445
<col align="left" valign="top">
446
446
<tbody><tr>
447
447
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
448
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>
 
448
<td>a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>
449
449
</td>
450
450
</tr></tbody>
451
451
</table></div>
454
454
<hr>
455
455
<div class="refsect2">
456
456
<a name="clutter-value-set-fixed"></a><h3>clutter_value_set_fixed ()</h3>
457
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_value_set_fixed             (<em class="parameter"><code><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
 
457
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_value_set_fixed             (<em class="parameter"><code><a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>,
458
458
                                                         <em class="parameter"><code><span class="type">CoglFixed</span> fixed_</code></em>);</pre>
459
459
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
460
460
<h3 class="title">Warning</h3>
461
 
<p><code class="literal">clutter_value_set_fixed</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#g-value-set-int"><code class="function">g_value_set_int()</code></a> instead.</p>
 
461
<p><code class="literal">clutter_value_set_fixed</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#g-value-set-int"><code class="function">g_value_set_int()</code></a> instead.</p>
462
462
</div>
463
463
<p>
464
464
Sets <em class="parameter"><code>value</code></em> to <em class="parameter"><code>fixed_</code></em>.
468
468
<tbody>
469
469
<tr>
470
470
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
471
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized to <code class="literal">COGL_TYPE_FIXED</code>
 
471
<td>a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized to <code class="literal">COGL_TYPE_FIXED</code>
472
472
</td>
473
473
</tr>
474
474
<tr>
482
482
<hr>
483
483
<div class="refsect2">
484
484
<a name="clutter-value-get-fixed"></a><h3>clutter_value_get_fixed ()</h3>
485
 
<pre class="programlisting"><span class="returnvalue">CoglFixed</span>           clutter_value_get_fixed             (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
 
485
<pre class="programlisting"><span class="returnvalue">CoglFixed</span>           clutter_value_get_fixed             (<em class="parameter"><code>const <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> *value</code></em>);</pre>
486
486
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
487
487
<h3 class="title">Warning</h3>
488
 
<p><code class="literal">clutter_value_get_fixed</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Standard-Parameter-and-Value-Types.html#g-value-get-int"><code class="function">g_value_get_int()</code></a> instead.</p>
 
488
<p><code class="literal">clutter_value_get_fixed</code> has been deprecated since version 1.10 and should not be used in newly-written code. Use <a href="../gobject/gobject-Standard-Parameter-and-Value-Types.html#g-value-get-int"><code class="function">g_value_get_int()</code></a> instead.</p>
489
489
</div>
490
490
<p>
491
491
Gets the fixed point value stored inside <em class="parameter"><code>value</code></em>.
495
495
<tbody>
496
496
<tr>
497
497
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
498
 
<td>a <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized to <code class="literal">COGL_TYPE_FIXED</code>
 
498
<td>a <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> initialized to <code class="literal">COGL_TYPE_FIXED</code>
499
499
</td>
500
500
</tr>
501
501
<tr>
502
502
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
503
 
<td>the value inside the passed <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>
 
503
<td>the value inside the passed <a href="../gobject/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a>
504
504
</td>
505
505
</tr>
506
506
</tbody>
511
511
</div>
512
512
<div class="footer">
513
513
<hr>
514
 
          Generated by GTK-Doc V1.18</div>
 
514
          Generated by GTK-Doc V1.18.1</div>
515
515
</body>
516
516
</html>
 
 
b'\\ No newline at end of file'