Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Features: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<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-Events.html" title="Events">
<link rel="next" href="clutter-Base-geometric-types.html" title="Base geometric types">
<meta name="generator" content="GTK-Doc V1.25.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="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-Features.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-Events.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="clutter-Base-geometric-types.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="clutter-Features"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="clutter-Features.top_of_page"></a>Features</span></h2>
<p>Features — Run-time detection of Clutter features</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="clutter-Features.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="clutter-Features.html#clutter-feature-available" title="clutter_feature_available ()">clutter_feature_available</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="returnvalue">ClutterFeatureFlags</span></a>
</td>
<td class="function_name">
<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>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-Features.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags">ClutterFeatureFlags</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="clutter-Features.description"></a><h2>Description</h2>
<p>Parts of Clutter depend on the underlying platform, including the
capabilities of the backend used and the OpenGL features exposed through the
Clutter and COGL API.</p>
<p>It is possible to ask whether Clutter has support for specific features at
run-time.</p>
<p>See also <code class="function">cogl_get_features()</code> and <span class="type">CoglFeatureFlags</span></p>
</div>
<div class="refsect1">
<a name="clutter-Features.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-feature-available"></a><h3>clutter_feature_available ()</h3>
<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>
<p>Checks whether <em class="parameter"><code>feature</code></em>
 is available.  <em class="parameter"><code>feature</code></em>
 can be a logical
OR of <a class="link" href="clutter-Features.html#ClutterFeatureFlags" title="enum ClutterFeatureFlags"><span class="type">ClutterFeatureFlags</span></a>.</p>
<div class="refsect3">
<a name="clutter-feature-available.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>feature</p></td>
<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>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-feature-available.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if a feature is available</p>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-feature-get-all"></a><h3>clutter_feature_get_all ()</h3>
<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>
<p>Returns all the supported features.</p>
<div class="refsect3">
<a name="clutter-feature-get-all.returns"></a><h4>Returns</h4>
<p> a logical OR of all the supported features.</p>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="clutter-Features.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterFeatureFlags"></a><h3>enum ClutterFeatureFlags</h3>
<p>Runtime flags indicating specific features available via Clutter window
system and graphics backend.</p>
<div class="refsect3">
<a name="ClutterFeatureFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-TEXTURE-NPOT:CAPS"></a>CLUTTER_FEATURE_TEXTURE_NPOT</p></td>
<td class="enum_member_description">
<p>Set if NPOTS textures supported.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-SYNC-TO-VBLANK:CAPS"></a>CLUTTER_FEATURE_SYNC_TO_VBLANK</p></td>
<td class="enum_member_description">
<p>Set if vblank syncing supported.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-TEXTURE-YUV:CAPS"></a>CLUTTER_FEATURE_TEXTURE_YUV</p></td>
<td class="enum_member_description">
<p>Set if YUV based textures supported.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-TEXTURE-READ-PIXELS:CAPS"></a>CLUTTER_FEATURE_TEXTURE_READ_PIXELS</p></td>
<td class="enum_member_description">
<p>Set if texture pixels can be read.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-STAGE-STATIC:CAPS"></a>CLUTTER_FEATURE_STAGE_STATIC</p></td>
<td class="enum_member_description">
<p>Set if stage size if fixed (i.e framebuffer)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-STAGE-USER-RESIZE:CAPS"></a>CLUTTER_FEATURE_STAGE_USER_RESIZE</p></td>
<td class="enum_member_description">
<p>Set if stage is able to be user resized.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-STAGE-CURSOR:CAPS"></a>CLUTTER_FEATURE_STAGE_CURSOR</p></td>
<td class="enum_member_description">
<p>Set if stage has a graphical cursor.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-SHADERS-GLSL:CAPS"></a>CLUTTER_FEATURE_SHADERS_GLSL</p></td>
<td class="enum_member_description">
<p>Set if the backend supports GLSL shaders.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-OFFSCREEN:CAPS"></a>CLUTTER_FEATURE_OFFSCREEN</p></td>
<td class="enum_member_description">
<p>Set if the backend supports offscreen rendering.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-STAGE-MULTIPLE:CAPS"></a>CLUTTER_FEATURE_STAGE_MULTIPLE</p></td>
<td class="enum_member_description">
<p>Set if multiple stages are supported.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CLUTTER-FEATURE-SWAP-EVENTS:CAPS"></a>CLUTTER_FEATURE_SWAP_EVENTS</p></td>
<td class="enum_member_description">
<p>Set if the GLX_INTEL_swap_event is supported.</p>
</td>
<td class="enum_member_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>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>