1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Features</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch11.html" title="General purpose API">
9 <link rel="prev" href="clutter-Events.html" title="Events">
10 <link rel="next" href="ClutterInputDevice.html" title="ClutterInputDevice">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="clutter-Events.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch11.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="ClutterInputDevice.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#clutter-Features.synopsis" class="shortcut">Top</a>
26 <a href="#clutter-Features.description" class="shortcut">Description</a>
29 <div class="refentry">
30 <a name="clutter-Features"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
33 <h2><span class="refentrytitle"><a name="clutter-Features.top_of_page"></a>Features</span></h2>
34 <p>Features — Run-time detection of Clutter features</p>
36 <td valign="top" align="right"></td>
38 <div class="refsynopsisdiv">
39 <a name="clutter-Features.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">enum <a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags">ClutterFeatureFlags</a>;
41 <span class="returnvalue">gboolean</span> <a class="link" href="clutter-Features.html#clutter-feature-available" title="clutter_feature_available ()">clutter_feature_available</a> (<em class="parameter"><code><a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="type">ClutterFeatureFlags</span></a> feature</code></em>);
42 <a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="returnvalue">ClutterFeatureFlags</span></a> <a class="link" href="clutter-Features.html#clutter-feature-get-all" title="clutter_feature_get_all ()">clutter_feature_get_all</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
45 <div class="refsect1">
46 <a name="clutter-Features.description"></a><h2>Description</h2>
48 Parts of Clutter depend on the underlying platform, including the
49 capabilities of the backend used and the OpenGL features exposed through the
53 It is possible to ask whether Clutter has support for specific features at
57 See also <code class="function">cogl_get_features()</code> and <span class="type">CoglFeatureFlags</span>
60 <div class="refsect1">
61 <a name="clutter-Features.details"></a><h2>Details</h2>
62 <div class="refsect2">
63 <a name="ClutterFeatureFlags"></a><h3>enum ClutterFeatureFlags</h3>
64 <pre class="programlisting">typedef enum {
65 CLUTTER_FEATURE_TEXTURE_NPOT = (1 << 2),
66 CLUTTER_FEATURE_SYNC_TO_VBLANK = (1 << 3),
67 CLUTTER_FEATURE_TEXTURE_YUV = (1 << 4),
68 CLUTTER_FEATURE_TEXTURE_READ_PIXELS = (1 << 5),
69 CLUTTER_FEATURE_STAGE_STATIC = (1 << 6),
70 CLUTTER_FEATURE_STAGE_USER_RESIZE = (1 << 7),
71 CLUTTER_FEATURE_STAGE_CURSOR = (1 << 8),
72 CLUTTER_FEATURE_SHADERS_GLSL = (1 << 9),
73 CLUTTER_FEATURE_OFFSCREEN = (1 << 10),
74 CLUTTER_FEATURE_STAGE_MULTIPLE = (1 << 11),
75 CLUTTER_FEATURE_SWAP_EVENTS = (1 << 12)
76 } ClutterFeatureFlags;
79 Runtime flags indicating specific features available via Clutter window
80 sysytem and graphics backend.
82 <div class="variablelist"><table border="0">
83 <col align="left" valign="top">
86 <td><p><a name="CLUTTER-FEATURE-TEXTURE-NPOT:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_TEXTURE_NPOT</code></span></p></td>
87 <td>Set if NPOTS textures supported.
91 <td><p><a name="CLUTTER-FEATURE-SYNC-TO-VBLANK:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_SYNC_TO_VBLANK</code></span></p></td>
92 <td>Set if vblank syncing supported.
96 <td><p><a name="CLUTTER-FEATURE-TEXTURE-YUV:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_TEXTURE_YUV</code></span></p></td>
97 <td>Set if YUV based textures supported.
101 <td><p><a name="CLUTTER-FEATURE-TEXTURE-READ-PIXELS:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_TEXTURE_READ_PIXELS</code></span></p></td>
102 <td>Set if texture pixels can be read.
106 <td><p><a name="CLUTTER-FEATURE-STAGE-STATIC:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_STAGE_STATIC</code></span></p></td>
107 <td>Set if stage size if fixed (i.e framebuffer)
111 <td><p><a name="CLUTTER-FEATURE-STAGE-USER-RESIZE:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_STAGE_USER_RESIZE</code></span></p></td>
112 <td>Set if stage is able to be user resized.
116 <td><p><a name="CLUTTER-FEATURE-STAGE-CURSOR:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_STAGE_CURSOR</code></span></p></td>
117 <td>Set if stage has a graphical cursor.
121 <td><p><a name="CLUTTER-FEATURE-SHADERS-GLSL:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_SHADERS_GLSL</code></span></p></td>
122 <td>Set if the backend supports GLSL shaders.
126 <td><p><a name="CLUTTER-FEATURE-OFFSCREEN:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_OFFSCREEN</code></span></p></td>
127 <td>Set if the backend supports offscreen rendering.
131 <td><p><a name="CLUTTER-FEATURE-STAGE-MULTIPLE:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_STAGE_MULTIPLE</code></span></p></td>
132 <td>Set if multiple stages are supported.
136 <td><p><a name="CLUTTER-FEATURE-SWAP-EVENTS:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_SWAP_EVENTS</code></span></p></td>
137 <td>Set if the GLX_INTEL_swap_event is supported.
142 <p class="since">Since 0.4</p>
145 <div class="refsect2">
146 <a name="clutter-feature-available"></a><h3>clutter_feature_available ()</h3>
147 <pre class="programlisting"><span class="returnvalue">gboolean</span> clutter_feature_available (<em class="parameter"><code><a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="type">ClutterFeatureFlags</span></a> feature</code></em>);</pre>
149 Checks whether <em class="parameter"><code>feature</code></em> is available. <em class="parameter"><code>feature</code></em> can be a logical
150 OR of <a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="type">ClutterFeatureFlags</span></a>.
152 <div class="variablelist"><table border="0">
153 <col align="left" valign="top">
156 <td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
157 <td>a <a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="type">ClutterFeatureFlags</span></a>
161 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
163 <code class="literal">TRUE</code> if a feature is available</td>
167 <p class="since">Since 0.1.1</p>
170 <div class="refsect2">
171 <a name="clutter-feature-get-all"></a><h3>clutter_feature_get_all ()</h3>
172 <pre class="programlisting"><a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="returnvalue">ClutterFeatureFlags</span></a> clutter_feature_get_all (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
174 Returns all the supported features.
176 <div class="variablelist"><table border="0">
177 <col align="left" valign="top">
179 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
180 <td>a logical OR of all the supported features.</td>
183 <p class="since">Since 0.1.1</p>
189 Generated by GTK-Doc V1.18.1</div>