<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterDesaturateEffect: 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="ch06.html" title="Effects">
<link rel="prev" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect">
<link rel="next" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect">
<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="#ClutterDesaturateEffect.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterDesaturateEffect.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterDesaturateEffect.properties" class="shortcut">Properties</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="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterColorizeEffect.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterPageTurnEffect.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterDesaturateEffect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterDesaturateEffect.top_of_page"></a>ClutterDesaturateEffect</span></h2>
<p>ClutterDesaturateEffect — A desaturation effect</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterDesaturateEffect.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">
<a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterDesaturateEffect.html#clutter-desaturate-effect-new" title="clutter_desaturate_effect_new ()">clutter_desaturate_effect_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterDesaturateEffect.html#clutter-desaturate-effect-set-factor" title="clutter_desaturate_effect_set_factor ()">clutter_desaturate_effect_set_factor</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="ClutterDesaturateEffect.html#clutter-desaturate-effect-get-factor" title="clutter_desaturate_effect_get_factor ()">clutter_desaturate_effect_get_factor</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterDesaturateEffect.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><span class="type">gdouble</span></td>
<td class="property_name"><a class="link" href="ClutterDesaturateEffect.html#ClutterDesaturateEffect--factor" title="The “factor” property">factor</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterDesaturateEffect.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"> </td>
<td class="function_name"><a class="link" href="ClutterDesaturateEffect.html#ClutterDesaturateEffect-struct" title="ClutterDesaturateEffect">ClutterDesaturateEffect</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterDesaturateEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
<span class="lineart">╰──</span> <a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
<span class="lineart">╰──</span> <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect">ClutterOffscreenEffect</a>
<span class="lineart">╰──</span> ClutterDesaturateEffect
</pre>
</div>
<div class="refsect1">
<a name="ClutterDesaturateEffect.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> is a sub-class of <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a> that
desaturates the color of an actor and its contents. The strenght
of the desaturation effect is controllable and animatable through
the <a class="link" href="ClutterDesaturateEffect.html#ClutterDesaturateEffect--factor" title="The “factor” property"><span class="type">“factor”</span></a> property.</p>
<p><a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> is available since Clutter 1.4</p>
</div>
<div class="refsect1">
<a name="ClutterDesaturateEffect.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-desaturate-effect-new"></a><h3>clutter_desaturate_effect_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> *
clutter_desaturate_effect_new (<em class="parameter"><code><span class="type">gdouble</span> factor</code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> to be used with
<a class="link" href="ClutterActor.html#clutter-actor-add-effect" title="clutter_actor_add_effect ()"><code class="function">clutter_actor_add_effect()</code></a></p>
<div class="refsect3">
<a name="clutter-desaturate-effect-new.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>factor</p></td>
<td class="parameter_description"><p>the desaturation factor, between 0.0 and 1.0</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-desaturate-effect-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> or <code class="literal">NULL</code></p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-desaturate-effect-set-factor"></a><h3>clutter_desaturate_effect_set_factor ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_desaturate_effect_set_factor (<em class="parameter"><code><a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> *effect</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> factor</code></em>);</pre>
<p>Sets the desaturation factor for <em class="parameter"><code>effect</code></em>
, with 0.0 being "do not desaturate"
and 1.0 being "fully desaturate"</p>
<div class="refsect3">
<a name="clutter-desaturate-effect-set-factor.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>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>factor</p></td>
<td class="parameter_description"><p>the desaturation factor, between 0.0 and 1.0</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-desaturate-effect-get-factor"></a><h3>clutter_desaturate_effect_get_factor ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
clutter_desaturate_effect_get_factor (<em class="parameter"><code><a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> *effect</code></em>);</pre>
<p>Retrieves the desaturation factor of <em class="parameter"><code>effect</code></em>
</p>
<div class="refsect3">
<a name="clutter-desaturate-effect-get-factor.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>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-desaturate-effect-get-factor.returns"></a><h4>Returns</h4>
<p> the desaturation factor</p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterDesaturateEffect.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterDesaturateEffect-struct"></a><h3>ClutterDesaturateEffect</h3>
<pre class="programlisting">typedef struct _ClutterDesaturateEffect ClutterDesaturateEffect;</pre>
<p><a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> is an opaque structure
whose members cannot be directly accessed</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterDesaturateEffect.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterDesaturateEffect--factor"></a><h3>The <code class="literal">“factor”</code> property</h3>
<pre class="programlisting"> “factor” <span class="type">gdouble</span></pre>
<p>The desaturation factor, between 0.0 (no desaturation) and 1.0 (full
desaturation).</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 1</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterDesaturateEffect.see-also"></a><h2>See Also</h2>
<p><a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a>, <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>