libclutter-1.0-doc 1.20.0-1 / usr / share / gtk-doc / html / clutter / clutter-Versioning-Macros.html

This file is indexed.

/usr/share/gtk-doc/html/clutter/clutter-Versioning-Macros.html is in libclutter-1.0-doc 1.20.0-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
<!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: Versioning Macros</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-Utilities.html" title="Utilities">
<link rel="next" href="ch11.html" title="User interface definition">
<meta name="generator" content="GTK-Doc V1.21 (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-Versioning-Macros.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="clutter-Utilities.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch11.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="clutter-Versioning-Macros"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="clutter-Versioning-Macros.top_of_page"></a>Versioning Macros</span></h2>
<p>Versioning Macros — Versioning utility macros</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="clutter-Versioning-Macros.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-Versioning-Macros.html#CLUTTER-MAJOR-VERSION:CAPS" title="CLUTTER_MAJOR_VERSION">CLUTTER_MAJOR_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-MINOR-VERSION:CAPS" title="CLUTTER_MINOR_VERSION">CLUTTER_MINOR_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-MICRO-VERSION:CAPS" title="CLUTTER_MICRO_VERSION">CLUTTER_MICRO_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-HEX:CAPS" title="CLUTTER_VERSION_HEX">CLUTTER_VERSION_HEX</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="clutter-Versioning-Macros.html#CLUTTER-CHECK-VERSION:CAPS" title="CLUTTER_CHECK_VERSION()">CLUTTER_CHECK_VERSION</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-NO-FPU:CAPS" title="CLUTTER_NO_FPU">CLUTTER_NO_FPU</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-0:CAPS" title="CLUTTER_VERSION_1_0">CLUTTER_VERSION_1_0</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-2:CAPS" title="CLUTTER_VERSION_1_2">CLUTTER_VERSION_1_2</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-4:CAPS" title="CLUTTER_VERSION_1_4">CLUTTER_VERSION_1_4</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-6:CAPS" title="CLUTTER_VERSION_1_6">CLUTTER_VERSION_1_6</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-8:CAPS" title="CLUTTER_VERSION_1_8">CLUTTER_VERSION_1_8</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-10:CAPS" title="CLUTTER_VERSION_1_10">CLUTTER_VERSION_1_10</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-12:CAPS" title="CLUTTER_VERSION_1_12">CLUTTER_VERSION_1_12</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-14:CAPS" title="CLUTTER_VERSION_1_14">CLUTTER_VERSION_1_14</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-16:CAPS" title="CLUTTER_VERSION_1_16">CLUTTER_VERSION_1_16</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-18:CAPS" title="CLUTTER_VERSION_1_18">CLUTTER_VERSION_1_18</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-20:CAPS" title="CLUTTER_VERSION_1_20">CLUTTER_VERSION_1_20</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-MIN-REQUIRED:CAPS" title="CLUTTER_VERSION_MIN_REQUIRED">CLUTTER_VERSION_MIN_REQUIRED</a></td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="clutter-Versioning-Macros.html#clutter-check-version" title="clutter_check_version ()">clutter_check_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-Versioning-Macros.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION:CAPS" title="CLUTTER_VERSION">CLUTTER_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-S:CAPS" title="CLUTTER_VERSION_S">CLUTTER_VERSION_S</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-FLAVOUR:CAPS" title="CLUTTER_FLAVOUR">CLUTTER_FLAVOUR</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-COGL:CAPS" title="CLUTTER_COGL">CLUTTER_COGL</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-MAX-ALLOWED:CAPS" title="CLUTTER_VERSION_MAX_ALLOWED">CLUTTER_VERSION_MAX_ALLOWED</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#clutter-major-version" title="clutter_major_version">clutter_major_version</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#clutter-minor-version" title="clutter_minor_version">clutter_minor_version</a></td>
</tr>
<tr>
<td class="variable_type">extern const guint </td>
<td class="function_name"><a class="link" href="clutter-Versioning-Macros.html#clutter-micro-version" title="clutter_micro_version">clutter_micro_version</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-Versioning-Macros.description"></a><h2>Description</h2>
<p>Clutter offers a set of macros for checking the version of the library
at compile time; it also provides a function to perform the same check
at run time.</p>
<p>Clutter adds version information to both API deprecations and additions;
by definining the macros <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-MIN-REQUIRED:CAPS" title="CLUTTER_VERSION_MIN_REQUIRED"><code class="literal">CLUTTER_VERSION_MIN_REQUIRED</code></a> and
<a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-MAX-ALLOWED:CAPS" title="CLUTTER_VERSION_MAX_ALLOWED"><code class="literal">CLUTTER_VERSION_MAX_ALLOWED</code></a>, you can specify the range of Clutter versions
whose API you want to use. Functions that were deprecated before, or
introduced after, this range will trigger compiler warnings. For instance,
if we define the following symbols:</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">CLUTTER_VERSION_MIN_REQUIRED <span class="gtkdoc opt">=</span> CLUTTER_VERSION_1_6
CLUTTER_VERSION_MAX_ALLOWED  <span class="gtkdoc opt">=</span> CLUTTER_VERSION_1_8</pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>and we have the following functions annotated in the Clutter headers:</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</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">void</span> <span class="function">clutter_function_A</span> <span class="gtkdoc opt">(</span><span class="gtkdoc kwb">void</span><span class="gtkdoc opt">)</span> CLUTTER_DEPRECATED_IN_1_4<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwb">void</span> <span class="function">clutter_function_B</span> <span class="gtkdoc opt">(</span><span class="gtkdoc kwb">void</span><span class="gtkdoc opt">)</span> CLUTTER_DEPRECATED_IN_1_6<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwb">void</span> <span class="function">clutter_function_C</span> <span class="gtkdoc opt">(</span><span class="gtkdoc kwb">void</span><span class="gtkdoc opt">)</span> CLUTTER_AVAILABLE_IN_1_8<span class="gtkdoc opt">;</span>
<span class="gtkdoc kwb">void</span> <span class="function">clutter_function_D</span> <span class="gtkdoc opt">(</span><span class="gtkdoc kwb">void</span><span class="gtkdoc opt">)</span> CLUTTER_AVAILABLE_IN_1_10<span class="gtkdoc opt">;</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>then any application code using the functions above will get the output:</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</pre></td>
        <td class="listing_code"><pre class="programlisting">clutter_function_A<span class="gtkdoc opt">:</span> deprecation warning
clutter_function_B<span class="gtkdoc opt">:</span> no warning
clutter_function_C<span class="gtkdoc opt">:</span> no warning
clutter_function_D<span class="gtkdoc opt">:</span> symbol <span class="keyword">not</span> available warning</pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>It is possible to disable the compiler warnings by defining the macro
<code class="literal">CLUTTER_DISABLE_DEPRECATION_WARNINGS</code> before including the clutter.h
header.</p>
</div>
<div class="refsect1">
<a name="clutter-Versioning-Macros.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="CLUTTER-MAJOR-VERSION:CAPS"></a><h3>CLUTTER_MAJOR_VERSION</h3>
<pre class="programlisting">#define CLUTTER_MAJOR_VERSION   (1)
</pre>
<p>The major version of the Clutter library (1, if <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION:CAPS" title="CLUTTER_VERSION"><code class="literal">CLUTTER_VERSION</code></a> is 1.2.3)</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-MINOR-VERSION:CAPS"></a><h3>CLUTTER_MINOR_VERSION</h3>
<pre class="programlisting">#define CLUTTER_MINOR_VERSION   (20)
</pre>
<p>The minor version of the Clutter library (2, if <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION:CAPS" title="CLUTTER_VERSION"><code class="literal">CLUTTER_VERSION</code></a> is 1.2.3)</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-MICRO-VERSION:CAPS"></a><h3>CLUTTER_MICRO_VERSION</h3>
<pre class="programlisting">#define CLUTTER_MICRO_VERSION   (0)
</pre>
<p>The micro version of the Clutter library (3, if <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION:CAPS" title="CLUTTER_VERSION"><code class="literal">CLUTTER_VERSION</code></a> is 1.2.3)</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-HEX:CAPS"></a><h3>CLUTTER_VERSION_HEX</h3>
<pre class="programlisting">#define             CLUTTER_VERSION_HEX</pre>
<p>Numerically encoded version of the Clutter library, like 0x010203</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-CHECK-VERSION:CAPS"></a><h3>CLUTTER_CHECK_VERSION()</h3>
<pre class="programlisting">#define             CLUTTER_CHECK_VERSION(major,minor,micro)</pre>
<p>Evaluates to <code class="literal">TRUE</code> if the version of the Clutter library is greater
than <em class="parameter"><code>major</code></em>
, <em class="parameter"><code>minor</code></em>
 and <em class="parameter"><code>micro</code></em>
</p>
<div class="refsect3">
<a name="id-1.7.2.16.6.6.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>major</p></td>
<td class="parameter_description"><p>major version, like 1 in 1.2.3</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>minor version, like 2 in 1.2.3</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>micro version, like 3 in 1.2.3</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-NO-FPU:CAPS"></a><h3>CLUTTER_NO_FPU</h3>
<pre class="programlisting">#define CLUTTER_NO_FPU          (0)
</pre>
<div class="warning">
<p><code class="literal">CLUTTER_NO_FPU</code> has been deprecated since version 0.6 and should not be used in newly-written code.</p>
<p>This macro is no longer defined (identical code is used
 regardless the presence of FPU).</p>
</div>
<p>Set to 1 if Clutter was built without FPU (i.e fixed math), 0 otherwise</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-0:CAPS"></a><h3>CLUTTER_VERSION_1_0</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_0     (G_ENCODE_VERSION (1, 0))
</pre>
<p>A macro that evaluates to the 1.0 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-2:CAPS"></a><h3>CLUTTER_VERSION_1_2</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_2     (G_ENCODE_VERSION (1, 2))
</pre>
<p>A macro that evaluates to the 1.2 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-4:CAPS"></a><h3>CLUTTER_VERSION_1_4</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_4     (G_ENCODE_VERSION (1, 4))
</pre>
<p>A macro that evaluates to the 1.4 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-6:CAPS"></a><h3>CLUTTER_VERSION_1_6</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_6     (G_ENCODE_VERSION (1, 6))
</pre>
<p>A macro that evaluates to the 1.6 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-8:CAPS"></a><h3>CLUTTER_VERSION_1_8</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_8     (G_ENCODE_VERSION (1, 8))
</pre>
<p>A macro that evaluates to the 1.8 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-10:CAPS"></a><h3>CLUTTER_VERSION_1_10</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_10    (G_ENCODE_VERSION (1, 10))
</pre>
<p>A macro that evaluates to the 1.10 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-12:CAPS"></a><h3>CLUTTER_VERSION_1_12</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_12    (G_ENCODE_VERSION (1, 12))
</pre>
<p>A macro that evaluates to the 1.12 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.12</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-14:CAPS"></a><h3>CLUTTER_VERSION_1_14</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_14    (G_ENCODE_VERSION (1, 14))
</pre>
<p>A macro that evaluates to the 1.14 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.14</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-16:CAPS"></a><h3>CLUTTER_VERSION_1_16</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_16    (G_ENCODE_VERSION (1, 16))
</pre>
<p>A macro that evaluates to the 1.16 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.16</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-18:CAPS"></a><h3>CLUTTER_VERSION_1_18</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_18    (G_ENCODE_VERSION (1, 18))
</pre>
<p>A macro that evaluates to the 1.18 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.18</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-1-20:CAPS"></a><h3>CLUTTER_VERSION_1_20</h3>
<pre class="programlisting">#define CLUTTER_VERSION_1_20    (G_ENCODE_VERSION (1, 20))
</pre>
<p>A macro that evaluates to the 1.18 version of Clutter, in a format
that can be used by the C pre-processor.</p>
<p class="since">Since 1.20</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-MIN-REQUIRED:CAPS"></a><h3>CLUTTER_VERSION_MIN_REQUIRED</h3>
<pre class="programlisting"># define CLUTTER_VERSION_MIN_REQUIRED   (CLUTTER_VERSION_CUR_STABLE)
</pre>
<p>A macro that should be defined by the user prior to including the
clutter.h header.</p>
<p>The definition should be one of the predefined Clutter version macros,
such as: <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-0:CAPS" title="CLUTTER_VERSION_1_0"><code class="literal">CLUTTER_VERSION_1_0</code></a>, <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-2:CAPS" title="CLUTTER_VERSION_1_2"><code class="literal">CLUTTER_VERSION_1_2</code></a>, ...</p>
<p>This macro defines the lower bound for the Clutter API to be used.</p>
<p>If a function has been deprecated in a newer version of Clutter, it
is possible to use this symbol to avoid the compiler warnings without
disabling warnings for every deprecated function.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-check-version"></a><h3>clutter_check_version ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_check_version (<em class="parameter"><code><span class="type">guint</span> major</code></em>,
                       <em class="parameter"><code><span class="type">guint</span> minor</code></em>,
                       <em class="parameter"><code><span class="type">guint</span> micro</code></em>);</pre>
<p>Run-time version check, to check the version the Clutter library
that an application is currently linked against</p>
<p>This is the run-time equivalent of the compile-time <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-CHECK-VERSION:CAPS" title="CLUTTER_CHECK_VERSION()"><code class="literal">CLUTTER_CHECK_VERSION</code></a>
pre-processor macro</p>
<div class="refsect3">
<a name="id-1.7.2.16.6.20.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>major</p></td>
<td class="parameter_description"><p>major version, like 1 in 1.2.3</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>minor version, like 2 in 1.2.3</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>micro version, like 3 in 1.2.3</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.7.2.16.6.20.7"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the version of the Clutter library is
greater than (<em class="parameter"><code>major</code></em>
, <em class="parameter"><code>minor</code></em>
, <em class="parameter"><code>micro</code></em>
), and <code class="literal">FALSE</code> otherwise</p>
<p></p>
</div>
<p class="since">Since 1.2</p>
</div>
</div>
<div class="refsect1">
<a name="clutter-Versioning-Macros.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CLUTTER-VERSION:CAPS"></a><h3>CLUTTER_VERSION</h3>
<pre class="programlisting">#define CLUTTER_VERSION         1.20.0
</pre>
<p>The full version of the Clutter library, like 1.2.3</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-S:CAPS"></a><h3>CLUTTER_VERSION_S</h3>
<pre class="programlisting">#define CLUTTER_VERSION_S       "1.20.0"
</pre>
<p>The full version of the Clutter library, in string form (suited for
string concatenation)</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-FLAVOUR:CAPS"></a><h3>CLUTTER_FLAVOUR</h3>
<pre class="programlisting">#define CLUTTER_FLAVOUR         "deprecated"
</pre>
<div class="warning">
<p><code class="literal">CLUTTER_FLAVOUR</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>The macro evaluates to "deprecated" as Clutter can be
  compiled with multiple windowing system backends. Use the various
  CLUTTER_WINDOWING_* macros to detect the windowing system that Clutter
  is being compiled against, and the type check macros for the
  <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> for a run-time check.</p>
</div>
<p>GL Windowing system used</p>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-COGL:CAPS"></a><h3>CLUTTER_COGL</h3>
<pre class="programlisting">#define CLUTTER_COGL            "deprecated"
</pre>
<div class="warning">
<p><code class="literal">CLUTTER_COGL</code> has been deprecated since version 1.10 and should not be used in newly-written code.</p>
<p>The macro evaluates to "deprecated" as Cogl can be
  compiled against multiple GL implementations.</p>
</div>
<p>Cogl (internal GL abstraction utility library) backend. Can be "gl" or
"gles" currently</p>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="CLUTTER-VERSION-MAX-ALLOWED:CAPS"></a><h3>CLUTTER_VERSION_MAX_ALLOWED</h3>
<pre class="programlisting">#  define CLUTTER_VERSION_MAX_ALLOWED   CLUTTER_VERSION_MIN_REQUIRED
</pre>
<p>A macro that should be define by the user prior to including the
clutter.h header.</p>
<p>The definition should be one of the predefined Clutter version macros,
such as: <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-0:CAPS" title="CLUTTER_VERSION_1_0"><code class="literal">CLUTTER_VERSION_1_0</code></a>, <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-2:CAPS" title="CLUTTER_VERSION_1_2"><code class="literal">CLUTTER_VERSION_1_2</code></a>, ...</p>
<p>This macro defines the upper bound for the Clutter API to be used.</p>
<p>If a function has been introduced in a newer version of Clutter, it
is possible to use this symbol to get compiler warnings when trying
to use that function.</p>
<p class="since">Since 1.10</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-major-version"></a><h3>clutter_major_version</h3>
<pre class="programlisting">extern const guint clutter_major_version;
</pre>
<p>The major component of the Clutter library version, e.g. 1 if the version
is 1.2.3</p>
<p>This value can be used for run-time version checks</p>
<p>For a compile-time check, use <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-MAJOR-VERSION:CAPS" title="CLUTTER_MAJOR_VERSION"><code class="literal">CLUTTER_MAJOR_VERSION</code></a></p>
<p class="since">Since 1.2</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-minor-version"></a><h3>clutter_minor_version</h3>
<pre class="programlisting">extern const guint clutter_minor_version;
</pre>
<p>The minor component of the Clutter library version, e.g. 2 if the version
is 1.2.3</p>
<p>This value can be used for run-time version checks</p>
<p>For a compile-time check, use <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-MINOR-VERSION:CAPS" title="CLUTTER_MINOR_VERSION"><code class="literal">CLUTTER_MINOR_VERSION</code></a></p>
<p class="since">Since 1.2</p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-micro-version"></a><h3>clutter_micro_version</h3>
<pre class="programlisting">extern const guint clutter_micro_version;
</pre>
<p>The micro component of the Clutter library version, e.g. 3 if the version
is 1.2.3</p>
<p>This value can be used for run-time version checks</p>
<p>For a compile-time check, use <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-MICRO-VERSION:CAPS" title="CLUTTER_MICRO_VERSION"><code class="literal">CLUTTER_MICRO_VERSION</code></a></p>
<p class="since">Since 1.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.