libclutter-1.0-doc 1.24.2-1 / usr / share / gtk-doc / html / clutter / clutter-Utilities.html

This file is indexed.

/usr/share/gtk-doc/html/clutter/clutter-Utilities.html is in libclutter-1.0-doc 1.24.2-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Utilities: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch10.html" title="General purpose API">
<link rel="prev" href="clutter-Cairo-integration.html" title="Cairo integration">
<link rel="next" href="clutter-Versioning-Macros.html" title="Versioning Macros">
<meta name="generator" content="GTK-Doc V1.24 (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-Utilities.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#clutter-Utilities.object-hierarchy" class="shortcut">Object Hierarchy</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="clutter-Cairo-integration.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="clutter-Versioning-Macros.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="clutter-Utilities"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="clutter-Utilities.top_of_page"></a>Utilities</span></h2>
<p>Utilities — Utility functions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="clutter-Utilities.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="clutter-Utilities.html#clutter-util-next-p2" title="clutter_util_next_p2 ()">clutter_util_next_p2</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ClutterTimeoutPool</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-Utilities.html#clutter-timeout-pool-new" title="clutter_timeout_pool_new ()">clutter_timeout_pool_new</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-Utilities.html#clutter-timeout-pool-add" title="clutter_timeout_pool_add ()">clutter_timeout_pool_add</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-Utilities.html#clutter-timeout-pool-remove" title="clutter_timeout_pool_remove ()">clutter_timeout_pool_remove</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-Utilities.html#clutter-frame-source-add" title="clutter_frame_source_add ()">clutter_frame_source_add</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-Utilities.html#clutter-frame-source-add-full" title="clutter_frame_source_add_full ()">clutter_frame_source_add_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GParamSpec</span> *
</td>
<td class="function_name">
<a class="link" href="clutter-Utilities.html#clutter-param-spec-fixed" title="clutter_param_spec_fixed ()">clutter_param_spec_fixed</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="clutter-Utilities.html#CLUTTER-VALUE-HOLDS-FIXED:CAPS" title="CLUTTER_VALUE_HOLDS_FIXED()">CLUTTER_VALUE_HOLDS_FIXED</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-Utilities.html#clutter-value-set-fixed" title="clutter_value_set_fixed ()">clutter_value_set_fixed</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglFixed</span>
</td>
<td class="function_name">
<a class="link" href="clutter-Utilities.html#clutter-value-get-fixed" title="clutter_value_get_fixed ()">clutter_value_get_fixed</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="ClutterParamSpecFixed"></a><div class="refsect1">
<a name="clutter-Utilities.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="clutter-Utilities.html#ClutterParamSpecFixed-struct" title="struct ClutterParamSpecFixed">ClutterParamSpecFixed</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-Utilities.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GParam
    <span class="lineart">╰──</span> ClutterParamSpecFixed
</pre>
</div>
<div class="refsect1">
<a name="clutter-Utilities.description"></a><h2>Description</h2>
<p>Various miscellaneous utilility functions.</p>
</div>
<div class="refsect1">
<a name="clutter-Utilities.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-util-next-p2"></a><h3>clutter_util_next_p2 ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
clutter_util_next_p2 (<em class="parameter"><code><span class="type">gint</span> a</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_util_next_p2</code> has been deprecated since version 1.2 and should not be used in newly-written code.</p></div>
<p>Calculates the nearest power of two, greater than or equal to <em class="parameter"><code>a</code></em>
.</p>
<div class="refsect3">
<a name="id-1.7.2.16.8.2.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>a</p></td>
<td class="parameter_description"><p>Value to get the next power</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.16.8.2.7"></a><h4>Returns</h4>
<p> The nearest power of two, greater or equal to <em class="parameter"><code>a</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="clutter-timeout-pool-new"></a><h3>clutter_timeout_pool_new ()</h3>
<pre class="programlisting"><span class="returnvalue">ClutterTimeoutPool</span> *
clutter_timeout_pool_new (<em class="parameter"><code><span class="type">gint</span> priority</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_timeout_pool_new</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this API</p>
</div>
<p>Creates a new timeout pool source. A timeout pool should be used when
multiple timeout functions, running at the same priority, are needed and
the <code class="function">g_timeout_add()</code> API might lead to starvation of the time slice of
the main loop. A timeout pool allocates a single time slice of the main
loop and runs every timeout function inside it. The timeout pool is
always sorted, so that the extraction of the next timeout function is
a constant time operation.</p>
<div class="refsect3">
<a name="id-1.7.2.16.8.3.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>priority</p></td>
<td class="parameter_description"><p>the priority of the timeout pool. Typically this will
be <span class="type">G_PRIORITY_DEFAULT</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.16.8.3.8"></a><h4>Returns</h4>
<p> the newly created <span class="type">ClutterTimeoutPool</span>. The created pool
is owned by the GLib default context and will be automatically
destroyed when the context is destroyed. It is possible to force
the destruction of the timeout pool using <code class="function">g_source_destroy()</code></p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-timeout-pool-add"></a><h3>clutter_timeout_pool_add ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_timeout_pool_add (<em class="parameter"><code><span class="type">ClutterTimeoutPool</span> *pool</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_timeout_pool_add</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this API</p>
</div>
<p>Sets a function to be called at regular intervals, and puts it inside
the <em class="parameter"><code>pool</code></em>
. The function is repeatedly called until it returns <code class="literal">FALSE</code>,
at which point the timeout is automatically destroyed and the function
won't be called again. If <em class="parameter"><code>notify</code></em>
 is not <code class="literal">NULL</code>, the <em class="parameter"><code>notify</code></em>
 function
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>
.</p>
<p>Since Clutter 0.8 this 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. Before version 0.8 it 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>
<div class="refsect3">
<a name="id-1.7.2.16.8.4.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>pool</p></td>
<td class="parameter_description"><p>a <span class="type">ClutterTimeoutPool</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fps</p></td>
<td class="parameter_description"><p>the time between calls to the function, in frames per second</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, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>notify</p></td>
<td class="parameter_description"><p>function to call when the timeout is removed, 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.16.8.4.9"></a><h4>Returns</h4>
<p> the ID (greater than 0) of the timeout inside the pool.
Use <a class="link" href="clutter-Utilities.html#clutter-timeout-pool-remove" title="clutter_timeout_pool_remove ()"><code class="function">clutter_timeout_pool_remove()</code></a> to stop the timeout.</p>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-timeout-pool-remove"></a><h3>clutter_timeout_pool_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_timeout_pool_remove (<em class="parameter"><code><span class="type">ClutterTimeoutPool</span> *pool</code></em>,
                             <em class="parameter"><code><span class="type">guint</span> id_</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_timeout_pool_remove</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this API</p>
</div>
<p>Removes a timeout function with <em class="parameter"><code>id_</code></em>
 from the timeout pool. The id
is the same returned when adding a function to the timeout pool with
<a class="link" href="clutter-Utilities.html#clutter-timeout-pool-add" title="clutter_timeout_pool_add ()"><code class="function">clutter_timeout_pool_add()</code></a>.</p>
<div class="refsect3">
<a name="id-1.7.2.16.8.5.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>pool</p></td>
<td class="parameter_description"><p>a <span class="type">ClutterTimeoutPool</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>id_</p></td>
<td class="parameter_description"><p>the id of the timeout to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix04.html#api-index-0.4">0.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-frame-source-add"></a><h3>clutter_frame_source_add ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_frame_source_add (<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_frame_source_add</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this API</p>
</div>
<p>Simple wrapper around <a class="link" href="clutter-Utilities.html#clutter-frame-source-add-full" title="clutter_frame_source_add_full ()"><code class="function">clutter_frame_source_add_full()</code></a>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="id-1.7.2.16.8.6.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>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.16.8.6.9"></a><h4>Returns</h4>
<p> the ID (greater than 0) of the event source.</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-frame-source-add-full"></a><h3>clutter_frame_source_add_full ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_frame_source_add_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_frame_source_add_full</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this API.</p>
</div>
<p>Sets a function to be called at regular intervals with the given
priority.  The function is called repeatedly until it returns
<code class="literal">FALSE</code>, at which point the timeout is automatically destroyed and
the function will not be called again.  The <em class="parameter"><code>notify</code></em>
 function is
called when the timeout is destroyed.  The first call to the
function will be at the end of the first <em class="parameter"><code>interval</code></em>
.</p>
<p>This function is similar to <code class="function">g_timeout_add_full()</code> 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
<code class="function">g_timeout_add_full()</code> would not fire until a full interval after the
function completes so the delay between calls would be 1.0 / <em class="parameter"><code>fps</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><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> clutter_frame_source_add]</span></p>
<div class="refsect3">
<a name="id-1.7.2.16.8.7.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 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.16.8.7.10"></a><h4>Returns</h4>
<p> the ID (greater than 0) of the event source.</p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-param-spec-fixed"></a><h3>clutter_param_spec_fixed ()</h3>
<pre class="programlisting"><span class="returnvalue">GParamSpec</span> *
clutter_param_spec_fixed (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                          <em class="parameter"><code>const <span class="type">gchar</span> *nick</code></em>,
                          <em class="parameter"><code>const <span class="type">gchar</span> *blurb</code></em>,
                          <em class="parameter"><code><span class="type">CoglFixed</span> minimum</code></em>,
                          <em class="parameter"><code><span class="type">CoglFixed</span> maximum</code></em>,
                          <em class="parameter"><code><span class="type">CoglFixed</span> default_value</code></em>,
                          <em class="parameter"><code><span class="type">GParamFlags</span> flags</code></em>);</pre>
<div class="warning">
<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.</p>
<p>Use <span class="type">GParamSpecInt</span> instead.</p>
</div>
<p>Creates a <span class="type">GParamSpec</span> for properties using <span class="type">CoglFixed</span> values</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="id-1.7.2.16.8.8.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>name</p></td>
<td class="parameter_description"><p>name of the property</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>nick</p></td>
<td class="parameter_description"><p>short name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>blurb</p></td>
<td class="parameter_description"><p>description (can be translatable)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minimum</p></td>
<td class="parameter_description"><p>lower boundary</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>maximum</p></td>
<td class="parameter_description"><p>higher boundary</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>default_value</p></td>
<td class="parameter_description"><p>default value</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>flags for the param spec</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.16.8.8.9"></a><h4>Returns</h4>
<p> the newly created <span class="type">GParamSpec</span>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VALUE-HOLDS-FIXED:CAPS"></a><h3>CLUTTER_VALUE_HOLDS_FIXED()</h3>
<pre class="programlisting">#define CLUTTER_VALUE_HOLDS_FIXED(x)    (G_VALUE_HOLDS ((x), COGL_TYPE_FIXED))
</pre>
<div class="warning">
<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.</p>
<p>Use <code class="literal">G_VALUE_HOLDS_INT</code> instead</p>
</div>
<p>Evaluates to <code class="literal">TRUE</code> if <em class="parameter"><code>x</code></em>
 holds a <span class="type">CoglFixed</span>   .</p>
<div class="refsect3">
<a name="id-1.7.2.16.8.9.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>x</p></td>
<td class="parameter_description"><p>a <span class="type">GValue</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-value-set-fixed"></a><h3>clutter_value_set_fixed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_value_set_fixed (<em class="parameter"><code><span class="type">GValue</span> *value</code></em>,
                         <em class="parameter"><code><span class="type">CoglFixed</span> fixed_</code></em>);</pre>
<div class="warning">
<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.</p>
<p>Use <code class="function">g_value_set_int()</code> instead.</p>
</div>
<p>Sets <em class="parameter"><code>value</code></em>
 to <em class="parameter"><code>fixed_</code></em>
.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="id-1.7.2.16.8.10.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>value</p></td>
<td class="parameter_description"><p>a <span class="type">GValue</span> initialized to <code class="literal">COGL_TYPE_FIXED</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fixed_</p></td>
<td class="parameter_description"><p>the fixed point value to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-value-get-fixed"></a><h3>clutter_value_get_fixed ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglFixed</span>
clutter_value_get_fixed (<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
<div class="warning">
<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.</p>
<p>Use <code class="function">g_value_get_int()</code> instead.</p>
</div>
<p>Gets the fixed point value stored inside <em class="parameter"><code>value</code></em>
.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="id-1.7.2.16.8.11.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>value</p></td>
<td class="parameter_description"><p>a <span class="type">GValue</span> initialized to <code class="literal">COGL_TYPE_FIXED</code></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.16.8.11.9"></a><h4>Returns</h4>
<p> the value inside the passed <span class="type">GValue</span></p>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
</div>
<div class="refsect1">
<a name="clutter-Utilities.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterParamSpecFixed-struct"></a><h3>struct ClutterParamSpecFixed</h3>
<pre class="programlisting">struct ClutterParamSpecFixed {
  CoglFixed minimum;
  CoglFixed maximum;
  CoglFixed default_value;
};
</pre>
<div class="warning">
<p><code class="literal">ClutterParamSpecFixed</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>Do not use fixed-point values in public
  API. If you must, use <span class="type">GParamSpecInt</span> instead.</p>
</div>
<p><span class="type">GParamSpec</span> subclass for fixed point based properties</p>
<div class="refsect3">
<a name="id-1.7.2.16.9.2.7"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">CoglFixed</span> <em class="structfield"><code><a name="ClutterParamSpecFixed-struct.minimum"></a>minimum</code></em>;</p></td>
<td class="struct_member_description"><p>lower boundary</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">CoglFixed</span> <em class="structfield"><code><a name="ClutterParamSpecFixed-struct.maximum"></a>maximum</code></em>;</p></td>
<td class="struct_member_description"><p>higher boundary</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">CoglFixed</span> <em class="structfield"><code><a name="ClutterParamSpecFixed-struct.default-value"></a>default_value</code></em>;</p></td>
<td class="struct_member_description"><p>default value</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.