RubyGems - clutter - Versions diffs - 2.0.0-x86-mingw32 - Mend

clutter 2.0.0-x86-mingw32

Files changed (656) hide show

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

@@ -0,0 +1,525 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Versioning Macros</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.77.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.18.1 (XML mode)">
+<link rel="stylesheet" href="style.css" type="text/css">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
+<tr valign="middle">
+<td><a accesskey="p" href="clutter-Utilities.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="ch10.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">Clutter Reference Manual</th>
+<td><a accesskey="n" href="ch11.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#clutter-Versioning-Macros.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#clutter-Versioning-Macros.description" class="shortcut">Description</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 valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="clutter-Versioning-Macros.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-MAJOR-VERSION:CAPS" title="CLUTTER_MAJOR_VERSION">CLUTTER_MAJOR_VERSION</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-MINOR-VERSION:CAPS" title="CLUTTER_MINOR_VERSION">CLUTTER_MINOR_VERSION</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-MICRO-VERSION:CAPS" title="CLUTTER_MICRO_VERSION">CLUTTER_MICRO_VERSION</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION:CAPS" title="CLUTTER_VERSION">CLUTTER_VERSION</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-S:CAPS" title="CLUTTER_VERSION_S">CLUTTER_VERSION_S</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-HEX:CAPS" title="CLUTTER_VERSION_HEX">CLUTTER_VERSION_HEX</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-CHECK-VERSION:CAPS" title="CLUTTER_CHECK_VERSION()">CLUTTER_CHECK_VERSION</a>               (major,
+                                                         minor,
+                                                         micro)
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-FLAVOUR:CAPS" title="CLUTTER_FLAVOUR">CLUTTER_FLAVOUR</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-COGL:CAPS" title="CLUTTER_COGL">CLUTTER_COGL</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-NO-FPU:CAPS" title="CLUTTER_NO_FPU">CLUTTER_NO_FPU</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-0:CAPS" title="CLUTTER_VERSION_1_0">CLUTTER_VERSION_1_0</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-2:CAPS" title="CLUTTER_VERSION_1_2">CLUTTER_VERSION_1_2</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-4:CAPS" title="CLUTTER_VERSION_1_4">CLUTTER_VERSION_1_4</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-6:CAPS" title="CLUTTER_VERSION_1_6">CLUTTER_VERSION_1_6</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-8:CAPS" title="CLUTTER_VERSION_1_8">CLUTTER_VERSION_1_8</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-10:CAPS" title="CLUTTER_VERSION_1_10">CLUTTER_VERSION_1_10</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-12:CAPS" title="CLUTTER_VERSION_1_12">CLUTTER_VERSION_1_12</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-14:CAPS" title="CLUTTER_VERSION_1_14">CLUTTER_VERSION_1_14</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-MAX-ALLOWED:CAPS" title="CLUTTER_VERSION_MAX_ALLOWED">CLUTTER_VERSION_MAX_ALLOWED</a>
+#define             <a class="link" href="clutter-Versioning-Macros.html#CLUTTER-VERSION-MIN-REQUIRED:CAPS" title="CLUTTER_VERSION_MIN_REQUIRED">CLUTTER_VERSION_MIN_REQUIRED</a>
+extern const guint  <a class="link" href="clutter-Versioning-Macros.html#clutter-major-version" title="clutter_major_version">clutter_major_version</a>;
+extern const guint  <a class="link" href="clutter-Versioning-Macros.html#clutter-minor-version" title="clutter_minor_version">clutter_minor_version</a>;
+extern const guint  <a class="link" href="clutter-Versioning-Macros.html#clutter-micro-version" title="clutter_micro_version">clutter_micro_version</a>;
+<span class="returnvalue">gboolean</span>            <a class="link" href="clutter-Versioning-Macros.html#clutter-check-version" title="clutter_check_version ()">clutter_check_version</a>               (<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>
+</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>
+<p>
+</p>
+<div class="informalexample">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="normal"><a href="clutter-Versioning-Macros.html#CLUTTER-VERSION-MIN-REQUIRED:CAPS">CLUTTER_VERSION_MIN_REQUIRED</a> </span><span class="symbol">=</span><span class="normal"> <a href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-6:CAPS">CLUTTER_VERSION_1_6</a></span>
+<span class="normal"><a href="clutter-Versioning-Macros.html#CLUTTER-VERSION-MAX-ALLOWED:CAPS">CLUTTER_VERSION_MAX_ALLOWED</a>  </span><span class="symbol">=</span><span class="normal"> <a href="clutter-Versioning-Macros.html#CLUTTER-VERSION-1-8:CAPS">CLUTTER_VERSION_1_8</a></span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p>
+</p>
+<p>
+and we have the following functions annotated in the Clutter headers:
+</p>
+<p>
+</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="type">void</span><span class="normal"> </span><span class="function">clutter_function_A</span><span class="normal"> </span><span class="symbol">(</span><span class="type">void</span><span class="symbol">)</span><span class="normal"> CLUTTER_DEPRECATED_IN_1_4</span><span class="symbol">;</span>
+<span class="type">void</span><span class="normal"> </span><span class="function">clutter_function_B</span><span class="normal"> </span><span class="symbol">(</span><span class="type">void</span><span class="symbol">)</span><span class="normal"> CLUTTER_DEPRECATED_IN_1_6</span><span class="symbol">;</span>
+<span class="type">void</span><span class="normal"> </span><span class="function">clutter_function_C</span><span class="normal"> </span><span class="symbol">(</span><span class="type">void</span><span class="symbol">)</span><span class="normal"> CLUTTER_AVAILABLE_IN_1_8</span><span class="symbol">;</span>
+<span class="type">void</span><span class="normal"> </span><span class="function">clutter_function_D</span><span class="normal"> </span><span class="symbol">(</span><span class="type">void</span><span class="symbol">)</span><span class="normal"> CLUTTER_AVAILABLE_IN_1_10</span><span class="symbol">;</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+<p>
+</p>
+<p>
+then any application code using the functions above will get the output:
+</p>
+<p>
+</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="normal">clutter_function_A</span><span class="symbol">:</span><span class="normal"> deprecation warning</span>
+<span class="normal">clutter_function_B</span><span class="symbol">:</span><span class="normal"> no warning</span>
+<span class="normal">clutter_function_C</span><span class="symbol">:</span><span class="normal"> no warning</span>
+<span class="normal">clutter_function_D</span><span class="symbol">:</span><span class="normal"> symbol not available warning</span></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.details"></a><h2>Details</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   (14)
+</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:CAPS"></a><h3>CLUTTER_VERSION</h3>
+<pre class="programlisting">#define CLUTTER_VERSION         1.14.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.14.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-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="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
+<td>major version, like 1 in 1.2.3</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
+<td>minor version, like 2 in 1.2.3</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
+<td>micro version, like 3 in 1.2.3</td>
+</tr>
+</tbody>
+</table></div>
+</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" style="margin-left: 0.5in; margin-right: 0.5in;">
+<h3 class="title">Warning</h3>
+<p><code class="literal">CLUTTER_FLAVOUR</code> has been deprecated since version 1.10 and should not be used in newly-written code. 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" style="margin-left: 0.5in; margin-right: 0.5in;">
+<h3 class="title">Warning</h3>
+<p><code class="literal">CLUTTER_COGL</code> has been deprecated since version 1.10 and should not be used in newly-written code. 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-NO-FPU:CAPS"></a><h3>CLUTTER_NO_FPU</h3>
+<pre class="programlisting">#define CLUTTER_NO_FPU          (0)
+</pre>
+<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
+<h3 class="title">Warning</h3>
+<p><code class="literal">CLUTTER_NO_FPU</code> has been deprecated since version 0.6 and should not be used in newly-written code. 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-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-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-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>
+<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="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
+<td>major version, like 1 in 1.2.3</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
+<td>minor version, like 2 in 1.2.3</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
+<td>micro version, like 3 in 1.2.3</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>
+<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</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.2</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.18.1</div>
+</body>
+</html>