doc/reference/clutter/html/ClutterDesaturateEffect.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>ClutterDesaturateEffect</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="ch06.html" title="Effects">
   9 <link rel="prev" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect">
  10 <link rel="next" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect">
  11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  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">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="ClutterColorizeEffect.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch06.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="ClutterPageTurnEffect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#ClutterDesaturateEffect.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterDesaturateEffect.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterDesaturateEffect.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterDesaturateEffect.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="ClutterDesaturateEffect"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="ClutterDesaturateEffect.top_of_page"></a>ClutterDesaturateEffect</span></h2>
  38 <p>ClutterDesaturateEffect — A desaturation effect</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="ClutterDesaturateEffect.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">                    <a class="link" href="ClutterDesaturateEffect.html#ClutterDesaturateEffect-struct" title="ClutterDesaturateEffect">ClutterDesaturateEffect</a>;
  45 <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> *     <a class="link" href="ClutterDesaturateEffect.html#clutter-desaturate-effect-new" title="clutter_desaturate_effect_new ()">clutter_desaturate_effect_new</a>       (<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> factor</code></em>);
  46 <span class="returnvalue">void</span>                <a class="link" href="ClutterDesaturateEffect.html#clutter-desaturate-effect-set-factor" title="clutter_desaturate_effect_set_factor ()">clutter_desaturate_effect_set_factor</a>
  47                                                         (<em class="parameter"><code><a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> *effect</code></em>,
  48                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> factor</code></em>);
  49 <a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="ClutterDesaturateEffect.html#clutter-desaturate-effect-get-factor" title="clutter_desaturate_effect_get_factor ()">clutter_desaturate_effect_get_factor</a>
  50                                                         (<em class="parameter"><code><a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> *effect</code></em>);
  51 </pre>
  52 </div>
  53 <div class="refsect1">
  54 <a name="ClutterDesaturateEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
  55 <pre class="synopsis">
  56   <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  57    +----<a href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
  58          +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
  59                +----<a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
  60                      +----<a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect">ClutterOffscreenEffect</a>
  61                            +----ClutterDesaturateEffect
  62 </pre>
  63 </div>
  64 <div class="refsect1">
  65 <a name="ClutterDesaturateEffect.properties"></a><h2>Properties</h2>
  66 <pre class="synopsis">
  67   "<a class="link" href="ClutterDesaturateEffect.html#ClutterDesaturateEffect--factor" title='The "factor" property'>factor</a>"                   <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  68 </pre>
  69 </div>
  70 <div class="refsect1">
  71 <a name="ClutterDesaturateEffect.description"></a><h2>Description</h2>
  72 <p>
  73 <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
  74 desaturates the color of an actor and its contents. The strenght
  75 of the desaturation effect is controllable and animatable through
  76 the <a class="link" href="ClutterDesaturateEffect.html#ClutterDesaturateEffect--factor" title='The "factor" property'><span class="type">"factor"</span></a> property.
  77 </p>
  78 <p>
  79 <a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> is available since Clutter 1.4
  80 </p>
  81 </div>
  82 <div class="refsect1">
  83 <a name="ClutterDesaturateEffect.details"></a><h2>Details</h2>
  84 <div class="refsect2">
  85 <a name="ClutterDesaturateEffect-struct"></a><h3>ClutterDesaturateEffect</h3>
  86 <pre class="programlisting">typedef struct _ClutterDesaturateEffect ClutterDesaturateEffect;</pre>
  87 <p>
  88 <span class="structname">ClutterDesaturateEffect</span> is an opaque structure
  89 whose members cannot be directly accessed
  90 </p>
  91 <p class="since">Since 1.4</p>
  92 </div>
  93 <hr>
  94 <div class="refsect2">
  95 <a name="clutter-desaturate-effect-new"></a><h3>clutter_desaturate_effect_new ()</h3>
  96 <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><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> factor</code></em>);</pre>
  97 <p>
  98 Creates a new <a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> to be used with
  99 <a class="link" href="ClutterActor.html#clutter-actor-add-effect" title="clutter_actor_add_effect ()"><code class="function">clutter_actor_add_effect()</code></a>
 100 </p>
 101 <div class="variablelist"><table border="0">
 102 <col align="left" valign="top">
 103 <tbody>
 104 <tr>
 105 <td><p><span class="term"><em class="parameter"><code>factor</code></em> :</span></p></td>
 106 <td>the desaturation factor, between 0.0 and 1.0</td>
 107 </tr>
 108 <tr>
 109 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 110 <td>the newly created <a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>
 111 </td>
 112 </tr>
 113 </tbody>
 114 </table></div>
 115 <p class="since">Since 1.4</p>
 116 </div>
 117 <hr>
 118 <div class="refsect2">
 119 <a name="clutter-desaturate-effect-set-factor"></a><h3>clutter_desaturate_effect_set_factor ()</h3>
 120 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_desaturate_effect_set_factor
 121                                                         (<em class="parameter"><code><a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> *effect</code></em>,
 122                                                          <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> factor</code></em>);</pre>
 123 <p>
 124 Sets the desaturation factor for <em class="parameter"><code>effect</code></em>, with 0.0 being "do not desaturate"
 125 and 1.0 being "fully desaturate"
 126 </p>
 127 <div class="variablelist"><table border="0">
 128 <col align="left" valign="top">
 129 <tbody>
 130 <tr>
 131 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
 132 <td>a <a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a>
 133 </td>
 134 </tr>
 135 <tr>
 136 <td><p><span class="term"><em class="parameter"><code>factor</code></em> :</span></p></td>
 137 <td>the desaturation factor, between 0.0 and 1.0</td>
 138 </tr>
 139 </tbody>
 140 </table></div>
 141 <p class="since">Since 1.4</p>
 142 </div>
 143 <hr>
 144 <div class="refsect2">
 145 <a name="clutter-desaturate-effect-get-factor"></a><h3>clutter_desaturate_effect_get_factor ()</h3>
 146 <pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             clutter_desaturate_effect_get_factor
 147                                                         (<em class="parameter"><code><a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a> *effect</code></em>);</pre>
 148 <p>
 149 Retrieves the desaturation factor of <em class="parameter"><code>effect</code></em>
 150 </p>
 151 <div class="variablelist"><table border="0">
 152 <col align="left" valign="top">
 153 <tbody>
 154 <tr>
 155 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
 156 <td>a <a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect"><span class="type">ClutterDesaturateEffect</span></a>
 157 </td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 161 <td>the desaturation factor</td>
 162 </tr>
 163 </tbody>
 164 </table></div>
 165 <p class="since">Since 1.4</p>
 166 </div>
 167 </div>
 168 <div class="refsect1">
 169 <a name="ClutterDesaturateEffect.property-details"></a><h2>Property Details</h2>
 170 <div class="refsect2">
 171 <a name="ClutterDesaturateEffect--factor"></a><h3>The <code class="literal">"factor"</code> property</h3>
 172 <pre class="programlisting">  "factor"                   <a href="../glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 173 <p>
 174 The desaturation factor, between 0.0 (no desaturation) and 1.0 (full
 175 desaturation).
 176 </p>
 177 <p>Allowed values: [0,1]</p>
 178 <p>Default value: 1</p>
 179 <p class="since">Since 1.4</p>
 180 </div>
 181 </div>
 182 <div class="refsect1">
 183 <a name="ClutterDesaturateEffect.see-also"></a><h2>See Also</h2>
 184 <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>
 185 </div>
 186 </div>
 187 <div class="footer">
 188 <hr>
 189           Generated by GTK-Doc V1.18.1</div>
 190 </body>
 191 </html>