doc/reference/clutter/html/ClutterBehaviourOpacity.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>ClutterBehaviourOpacity</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="deprecated.html" title="Part X. Deprecated Classes">
   9 <link rel="prev" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse">
  10 <link rel="next" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">
  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="ClutterBehaviourEllipse.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="deprecated.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="ClutterBehaviourPath.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="#ClutterBehaviourOpacity.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#ClutterBehaviourOpacity.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#ClutterBehaviourOpacity.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#ClutterBehaviourOpacity.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#ClutterBehaviourOpacity.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="ClutterBehaviourOpacity"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="ClutterBehaviourOpacity.top_of_page"></a>ClutterBehaviourOpacity</span></h2>
  40 <p>ClutterBehaviourOpacity — A behaviour controlling opacity</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="ClutterBehaviourOpacity.synopsis"></a><h2>Synopsis</h2>
  46 <pre class="synopsis">struct              <a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacity-struct" title="struct ClutterBehaviourOpacity">ClutterBehaviourOpacity</a>;
  47 struct              <a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacityClass" title="struct ClutterBehaviourOpacityClass">ClutterBehaviourOpacityClass</a>;
  48 <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *  <a class="link" href="ClutterBehaviourOpacity.html#clutter-behaviour-opacity-new" title="clutter_behaviour_opacity_new ()">clutter_behaviour_opacity_new</a>       (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
  49                                                          <em class="parameter"><code><span class="type">guint8</span> opacity_start</code></em>,
  50                                                          <em class="parameter"><code><span class="type">guint8</span> opacity_end</code></em>);
  51 <span class="returnvalue">void</span>                <a class="link" href="ClutterBehaviourOpacity.html#clutter-behaviour-opacity-set-bounds" title="clutter_behaviour_opacity_set_bounds ()">clutter_behaviour_opacity_set_bounds</a>
  52                                                         (<em class="parameter"><code><a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> *behaviour</code></em>,
  53                                                          <em class="parameter"><code><span class="type">guint8</span> opacity_start</code></em>,
  54                                                          <em class="parameter"><code><span class="type">guint8</span> opacity_end</code></em>);
  55 <span class="returnvalue">void</span>                <a class="link" href="ClutterBehaviourOpacity.html#clutter-behaviour-opacity-get-bounds" title="clutter_behaviour_opacity_get_bounds ()">clutter_behaviour_opacity_get_bounds</a>
  56                                                         (<em class="parameter"><code><a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> *behaviour</code></em>,
  57                                                          <em class="parameter"><code><span class="type">guint8</span> *opacity_start</code></em>,
  58                                                          <em class="parameter"><code><span class="type">guint8</span> *opacity_end</code></em>);
  59 </pre>
  60 </div>
  61 <div class="refsect1">
  62 <a name="ClutterBehaviourOpacity.object-hierarchy"></a><h2>Object Hierarchy</h2>
  63 <pre class="synopsis">
  64   GObject
  65    +----<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
  66          +----ClutterBehaviourOpacity
  67 </pre>
  68 </div>
  69 <div class="refsect1">
  70 <a name="ClutterBehaviourOpacity.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  71 <p>
  72 ClutterBehaviourOpacity implements
  73  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
  74 </div>
  75 <div class="refsect1">
  76 <a name="ClutterBehaviourOpacity.properties"></a><h2>Properties</h2>
  77 <pre class="synopsis">
  78   "<a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacity--opacity-end" title='The "opacity-end" property'>opacity-end</a>"              <span class="type">guint</span>                 : Read / Write
  79   "<a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacity--opacity-start" title='The "opacity-start" property'>opacity-start</a>"            <span class="type">guint</span>                 : Read / Write
  80 </pre>
  81 </div>
  82 <div class="refsect1">
  83 <a name="ClutterBehaviourOpacity.description"></a><h2>Description</h2>
  84 <p>
  85 <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> controls the opacity of a set of actors.
  86 </p>
  87 </div>
  88 <div class="refsect1">
  89 <a name="ClutterBehaviourOpacity.details"></a><h2>Details</h2>
  90 <div class="refsect2">
  91 <a name="ClutterBehaviourOpacity-struct"></a><h3>struct ClutterBehaviourOpacity</h3>
  92 <pre class="programlisting">struct ClutterBehaviourOpacity;</pre>
  93 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
  94 <h3 class="title">Warning</h3>
  95 <p><code class="literal">ClutterBehaviourOpacity</code> has been deprecated since version 1.6 and should not be used in newly-written code. Use <a class="link" href="clutter-Implicit-Animations.html#clutter-actor-animate" title="clutter_actor_animate ()"><code class="function">clutter_actor_animate()</code></a> and <a class="link" href="ClutterActor.html#ClutterActor--opacity" title='The "opacity" property'><span class="type">"opacity"</span></a>
  96   instead.</p>
  97 </div>
  98 <p>
  99 The <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> structure contains only private data and
 100 should be accessed using the provided API
 101 </p>
 102 <p class="since">Since 0.2</p>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="ClutterBehaviourOpacityClass"></a><h3>struct ClutterBehaviourOpacityClass</h3>
 107 <pre class="programlisting">struct ClutterBehaviourOpacityClass {
 108 };
 109 </pre>
 110 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 111 <h3 class="title">Warning</h3>
 112 <p><code class="literal">ClutterBehaviourOpacityClass</code> is deprecated and should not be used in newly-written code. 1.6</p>
 113 </div>
 114 <p>
 115 The <a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacityClass" title="struct ClutterBehaviourOpacityClass"><span class="type">ClutterBehaviourOpacityClass</span></a> structure contains only private data
 116 </p>
 117 <p class="since">Since 0.2</p>
 118 </div>
 119 <hr>
 120 <div class="refsect2">
 121 <a name="clutter-behaviour-opacity-new"></a><h3>clutter_behaviour_opacity_new ()</h3>
 122 <pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *  clutter_behaviour_opacity_new       (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>,
 123                                                          <em class="parameter"><code><span class="type">guint8</span> opacity_start</code></em>,
 124                                                          <em class="parameter"><code><span class="type">guint8</span> opacity_end</code></em>);</pre>
 125 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 126 <h3 class="title">Warning</h3>
 127 <p><code class="literal">clutter_behaviour_opacity_new</code> is deprecated and should not be used in newly-written code. 1.6</p>
 128 </div>
 129 <p>
 130 Creates a new <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> object, driven by <em class="parameter"><code>alpha</code></em>
 131 which controls the opacity property of every actor, making it
 132 change in the interval between <em class="parameter"><code>opacity_start</code></em> and <em class="parameter"><code>opacity_end</code></em>.
 133 </p>
 134 <p>
 135 If <em class="parameter"><code>alpha</code></em> is not <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> will take ownership
 136 of the <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance. In the case when <em class="parameter"><code>alpha</code></em> is <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>,
 137 it can be set later with <a class="link" href="ClutterBehaviour.html#clutter-behaviour-set-alpha" title="clutter_behaviour_set_alpha ()"><code class="function">clutter_behaviour_set_alpha()</code></a>.
 138 </p>
 139 <div class="variablelist"><table border="0">
 140 <col align="left" valign="top">
 141 <tbody>
 142 <tr>
 143 <td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
 144 <td>a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 145 </td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term"><em class="parameter"><code>opacity_start</code></em> :</span></p></td>
 149 <td>minimum level of opacity</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"><em class="parameter"><code>opacity_end</code></em> :</span></p></td>
 153 <td>maximum level of opacity</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 157 <td>the newly created <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a>
 158 </td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 <p class="since">Since 0.2</p>
 163 </div>
 164 <hr>
 165 <div class="refsect2">
 166 <a name="clutter-behaviour-opacity-set-bounds"></a><h3>clutter_behaviour_opacity_set_bounds ()</h3>
 167 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_behaviour_opacity_set_bounds
 168                                                         (<em class="parameter"><code><a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> *behaviour</code></em>,
 169                                                          <em class="parameter"><code><span class="type">guint8</span> opacity_start</code></em>,
 170                                                          <em class="parameter"><code><span class="type">guint8</span> opacity_end</code></em>);</pre>
 171 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 172 <h3 class="title">Warning</h3>
 173 <p><code class="literal">clutter_behaviour_opacity_set_bounds</code> is deprecated and should not be used in newly-written code. 1.6</p>
 174 </div>
 175 <p>
 176 Sets the initial and final levels of the opacity applied by <em class="parameter"><code>behaviour</code></em>
 177 on each actor it controls.
 178 </p>
 179 <div class="variablelist"><table border="0">
 180 <col align="left" valign="top">
 181 <tbody>
 182 <tr>
 183 <td><p><span class="term"><em class="parameter"><code>behaviour</code></em> :</span></p></td>
 184 <td>a <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a>
 185 </td>
 186 </tr>
 187 <tr>
 188 <td><p><span class="term"><em class="parameter"><code>opacity_start</code></em> :</span></p></td>
 189 <td>minimum level of opacity</td>
 190 </tr>
 191 <tr>
 192 <td><p><span class="term"><em class="parameter"><code>opacity_end</code></em> :</span></p></td>
 193 <td>maximum level of opacity</td>
 194 </tr>
 195 </tbody>
 196 </table></div>
 197 <p class="since">Since 0.6</p>
 198 </div>
 199 <hr>
 200 <div class="refsect2">
 201 <a name="clutter-behaviour-opacity-get-bounds"></a><h3>clutter_behaviour_opacity_get_bounds ()</h3>
 202 <pre class="programlisting"><span class="returnvalue">void</span>                clutter_behaviour_opacity_get_bounds
 203                                                         (<em class="parameter"><code><a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> *behaviour</code></em>,
 204                                                          <em class="parameter"><code><span class="type">guint8</span> *opacity_start</code></em>,
 205                                                          <em class="parameter"><code><span class="type">guint8</span> *opacity_end</code></em>);</pre>
 206 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 207 <h3 class="title">Warning</h3>
 208 <p><code class="literal">clutter_behaviour_opacity_get_bounds</code> is deprecated and should not be used in newly-written code. 1.6</p>
 209 </div>
 210 <p>
 211 Gets the initial and final levels of the opacity applied by <em class="parameter"><code>behaviour</code></em>
 212 on each actor it controls.
 213 </p>
 214 <div class="variablelist"><table border="0">
 215 <col align="left" valign="top">
 216 <tbody>
 217 <tr>
 218 <td><p><span class="term"><em class="parameter"><code>behaviour</code></em> :</span></p></td>
 219 <td>a <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a>
 220 </td>
 221 </tr>
 222 <tr>
 223 <td><p><span class="term"><em class="parameter"><code>opacity_start</code></em> :</span></p></td>
 224 <td>return location for the minimum level of opacity, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 225 </td>
 226 </tr>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>opacity_end</code></em> :</span></p></td>
 229 <td>return location for the maximum level of opacity, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 230 </td>
 231 </tr>
 232 </tbody>
 233 </table></div>
 234 <p class="since">Since 0.6</p>
 235 </div>
 236 </div>
 237 <div class="refsect1">
 238 <a name="ClutterBehaviourOpacity.property-details"></a><h2>Property Details</h2>
 239 <div class="refsect2">
 240 <a name="ClutterBehaviourOpacity--opacity-end"></a><h3>The <code class="literal">"opacity-end"</code> property</h3>
 241 <pre class="programlisting">  "opacity-end"              <span class="type">guint</span>                 : Read / Write</pre>
 242 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 243 <h3 class="title">Warning</h3>
 244 <p><code class="literal">ClutterBehaviourOpacity:opacity-end</code> is deprecated and should not be used in newly-written code. 1.6</p>
 245 </div>
 246 <p>
 247 Final opacity level of the behaviour.
 248 </p>
 249 <p>Allowed values: &lt;= 255</p>
 250 <p>Default value: 0</p>
 251 <p class="since">Since 0.2</p>
 252 </div>
 253 <hr>
 254 <div class="refsect2">
 255 <a name="ClutterBehaviourOpacity--opacity-start"></a><h3>The <code class="literal">"opacity-start"</code> property</h3>
 256 <pre class="programlisting">  "opacity-start"            <span class="type">guint</span>                 : Read / Write</pre>
 257 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 258 <h3 class="title">Warning</h3>
 259 <p><code class="literal">ClutterBehaviourOpacity:opacity-start</code> is deprecated and should not be used in newly-written code. 1.6</p>
 260 </div>
 261 <p>
 262 Initial opacity level of the behaviour.
 263 </p>
 264 <p>Allowed values: &lt;= 255</p>
 265 <p>Default value: 0</p>
 266 <p class="since">Since 0.2</p>
 267 </div>
 268 </div>
 269 </div>
 270 <div class="footer">
 271 <hr>
 272           Generated by GTK-Doc V1.18.1</div>
 273 </body>
 274 </html>