33
29
<h2><span class="refentrytitle"><a name="clutter-Features.top_of_page"></a>Features</span></h2>
34
30
<p>Features — Run-time detection of Clutter features</p>
36
<td valign="top" align="right"></td>
32
<td class="gallery_image" valign="top" align="right"></td>
37
33
</tr></table></div>
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>);
34
<div class="refsect1">
35
<a name="clutter-Features.functions"></a><h2>Functions</h2>
36
<div class="informaltable"><table width="100%" border="0">
38
<col width="150px" class="functions_return">
39
<col class="functions_name">
43
<td class="function_type">
44
<span class="returnvalue">gboolean</span>
46
<td class="function_name">
47
<a class="link" href="clutter-Features.html#clutter-feature-available" title="clutter_feature_available ()">clutter_feature_available</a> <span class="c_punctuation">()</span>
51
<td class="function_type">
52
<a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="returnvalue">ClutterFeatureFlags</span></a>
54
<td class="function_name">
55
<a class="link" href="clutter-Features.html#clutter-feature-get-all" title="clutter_feature_get_all ()">clutter_feature_get_all</a> <span class="c_punctuation">()</span>
61
<div class="refsect1">
62
<a name="clutter-Features.other"></a><h2>Types and Values</h2>
63
<div class="informaltable"><table width="100%" border="0">
65
<col width="150px" class="name">
66
<col class="description">
69
<td class="datatype_keyword">enum</td>
70
<td class="function_name"><a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags">ClutterFeatureFlags</a></td>
45
74
<div class="refsect1">
46
75
<a name="clutter-Features.description"></a><h2>Description</h2>
48
Parts of Clutter depend on the underlying platform, including the
76
<p>Parts of Clutter depend on the underlying platform, including the
49
77
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>
78
Clutter and COGL API.</p>
79
<p>It is possible to ask whether Clutter has support for specific features at
81
<p>See also <code class="function">cogl_get_features()</code> and <span class="type">CoglFeatureFlags</span></p>
83
<div class="refsect1">
84
<a name="clutter-Features.functions_details"></a><h2>Functions</h2>
85
<div class="refsect2">
86
<a name="clutter-feature-available"></a><h3>clutter_feature_available ()</h3>
87
<pre class="programlisting"><span class="returnvalue">gboolean</span>
88
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>
89
<p>Checks whether <em class="parameter"><code>feature</code></em>
90
is available. <em class="parameter"><code>feature</code></em>
92
OR of <a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="type">ClutterFeatureFlags</span></a>.</p>
93
<div class="refsect3">
94
<a name="id-1.7.2.6.6.2.5"></a><h4>Parameters</h4>
95
<div class="informaltable"><table width="100%" border="0">
97
<col width="150px" class="parameters_name">
98
<col class="parameters_description">
99
<col width="200px" class="parameters_annotations">
102
<td class="parameter_name"><p>feature</p></td>
103
<td class="parameter_description"><p>a <a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="type">ClutterFeatureFlags</span></a></p></td>
104
<td class="parameter_annotations"> </td>
108
<div class="refsect3">
109
<a name="id-1.7.2.6.6.2.6"></a><h4>Returns</h4>
110
<p> <code class="literal">TRUE</code> if a feature is available</p>
113
<p class="since">Since 0.1.1</p>
116
<div class="refsect2">
117
<a name="clutter-feature-get-all"></a><h3>clutter_feature_get_all ()</h3>
118
<pre class="programlisting"><a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="returnvalue">ClutterFeatureFlags</span></a>
119
clutter_feature_get_all (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
120
<p>Returns all the supported features.</p>
121
<div class="refsect3">
122
<a name="id-1.7.2.6.6.3.5"></a><h4>Returns</h4>
123
<p> a logical OR of all the supported features.</p>
126
<p class="since">Since 0.1.1</p>
129
<div class="refsect1">
130
<a name="clutter-Features.other_details"></a><h2>Types and Values</h2>
62
131
<div class="refsect2">
63
132
<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" class="variablelist">
133
<p>Runtime flags indicating specific features available via Clutter window
134
sysytem and graphics backend.</p>
135
<div class="refsect3">
136
<a name="id-1.7.2.6.7.2.4"></a><h4>Members</h4>
137
<div class="informaltable"><table width="100%" border="0">
84
<col align="left" valign="top">
139
<col width="300px" class="enum_members_name">
140
<col class="enum_members_description">
141
<col width="200px" class="enum_members_annotations">
89
<td><p><a name="CLUTTER-FEATURE-TEXTURE-NPOT:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_TEXTURE_NPOT</code></span></p></td>
90
<td>Set if NPOTS textures supported.
94
<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>
95
<td>Set if vblank syncing supported.
99
<td><p><a name="CLUTTER-FEATURE-TEXTURE-YUV:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_TEXTURE_YUV</code></span></p></td>
100
<td>Set if YUV based textures supported.
104
<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>
105
<td>Set if texture pixels can be read.
109
<td><p><a name="CLUTTER-FEATURE-STAGE-STATIC:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_STAGE_STATIC</code></span></p></td>
110
<td>Set if stage size if fixed (i.e framebuffer)
114
<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>
115
<td>Set if stage is able to be user resized.
119
<td><p><a name="CLUTTER-FEATURE-STAGE-CURSOR:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_STAGE_CURSOR</code></span></p></td>
120
<td>Set if stage has a graphical cursor.
124
<td><p><a name="CLUTTER-FEATURE-SHADERS-GLSL:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_SHADERS_GLSL</code></span></p></td>
125
<td>Set if the backend supports GLSL shaders.
129
<td><p><a name="CLUTTER-FEATURE-OFFSCREEN:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_OFFSCREEN</code></span></p></td>
130
<td>Set if the backend supports offscreen rendering.
134
<td><p><a name="CLUTTER-FEATURE-STAGE-MULTIPLE:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_STAGE_MULTIPLE</code></span></p></td>
135
<td>Set if multiple stages are supported.
139
<td><p><a name="CLUTTER-FEATURE-SWAP-EVENTS:CAPS"></a><span class="term"><code class="literal">CLUTTER_FEATURE_SWAP_EVENTS</code></span></p></td>
140
<td>Set if the GLX_INTEL_swap_event is supported.
145
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-TEXTURE-NPOT:CAPS"></a>CLUTTER_FEATURE_TEXTURE_NPOT</p></td>
146
<td class="enum_member_description">
147
<p>Set if NPOTS textures supported.</p>
149
<td class="enum_member_annotations"> </td>
152
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-SYNC-TO-VBLANK:CAPS"></a>CLUTTER_FEATURE_SYNC_TO_VBLANK</p></td>
153
<td class="enum_member_description">
154
<p>Set if vblank syncing supported.</p>
156
<td class="enum_member_annotations"> </td>
159
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-TEXTURE-YUV:CAPS"></a>CLUTTER_FEATURE_TEXTURE_YUV</p></td>
160
<td class="enum_member_description">
161
<p>Set if YUV based textures supported.</p>
163
<td class="enum_member_annotations"> </td>
166
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-TEXTURE-READ-PIXELS:CAPS"></a>CLUTTER_FEATURE_TEXTURE_READ_PIXELS</p></td>
167
<td class="enum_member_description">
168
<p>Set if texture pixels can be read.</p>
170
<td class="enum_member_annotations"> </td>
173
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-STAGE-STATIC:CAPS"></a>CLUTTER_FEATURE_STAGE_STATIC</p></td>
174
<td class="enum_member_description">
175
<p>Set if stage size if fixed (i.e framebuffer)</p>
177
<td class="enum_member_annotations"> </td>
180
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-STAGE-USER-RESIZE:CAPS"></a>CLUTTER_FEATURE_STAGE_USER_RESIZE</p></td>
181
<td class="enum_member_description">
182
<p>Set if stage is able to be user resized.</p>
184
<td class="enum_member_annotations"> </td>
187
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-STAGE-CURSOR:CAPS"></a>CLUTTER_FEATURE_STAGE_CURSOR</p></td>
188
<td class="enum_member_description">
189
<p>Set if stage has a graphical cursor.</p>
191
<td class="enum_member_annotations"> </td>
194
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-SHADERS-GLSL:CAPS"></a>CLUTTER_FEATURE_SHADERS_GLSL</p></td>
195
<td class="enum_member_description">
196
<p>Set if the backend supports GLSL shaders.</p>
198
<td class="enum_member_annotations"> </td>
201
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-OFFSCREEN:CAPS"></a>CLUTTER_FEATURE_OFFSCREEN</p></td>
202
<td class="enum_member_description">
203
<p>Set if the backend supports offscreen rendering.</p>
205
<td class="enum_member_annotations"> </td>
208
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-STAGE-MULTIPLE:CAPS"></a>CLUTTER_FEATURE_STAGE_MULTIPLE</p></td>
209
<td class="enum_member_description">
210
<p>Set if multiple stages are supported.</p>
212
<td class="enum_member_annotations"> </td>
215
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-SWAP-EVENTS:CAPS"></a>CLUTTER_FEATURE_SWAP_EVENTS</p></td>
216
<td class="enum_member_description">
217
<p>Set if the GLX_INTEL_swap_event is supported.</p>
219
<td class="enum_member_annotations"> </td>
145
224
<p class="since">Since 0.4</p>
148
<div class="refsect2">
149
<a name="clutter-feature-available"></a><h3>clutter_feature_available ()</h3>
150
<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>
152
Checks whether <em class="parameter"><code>feature</code></em> is available. <em class="parameter"><code>feature</code></em> can be a logical
153
OR of <a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="type">ClutterFeatureFlags</span></a>.
155
<div class="variablelist"><table border="0" class="variablelist">
157
<col align="left" valign="top">
162
<td><p><span class="term"><em class="parameter"><code>feature</code></em> :</span></p></td>
163
<td>a <a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="type">ClutterFeatureFlags</span></a>
167
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
169
<code class="literal">TRUE</code> if a feature is available</td>
173
<p class="since">Since 0.1.1</p>
176
<div class="refsect2">
177
<a name="clutter-feature-get-all"></a><h3>clutter_feature_get_all ()</h3>
178
<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>
180
Returns all the supported features.
182
<div class="variablelist"><table border="0" class="variablelist">
184
<col align="left" valign="top">
188
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
189
<td>a logical OR of all the supported features.</td>
192
<p class="since">Since 0.1.1</p>
196
228
<div class="footer">
198
Generated by GTK-Doc V1.18.1</div>
230
Generated by GTK-Doc V1.20.1</div>
b'\\ No newline at end of file'