1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
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">
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">
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>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterBehaviourOpacity.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterBehaviourOpacity.description" class="shortcut">Description</a>
28 <a href="#ClutterBehaviourOpacity.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterBehaviourOpacity.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#ClutterBehaviourOpacity.properties" class="shortcut">Properties</a>
35 <div class="refentry">
36 <a name="ClutterBehaviourOpacity"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
39 <h2><span class="refentrytitle"><a name="ClutterBehaviourOpacity.top_of_page"></a>ClutterBehaviourOpacity</span></h2>
40 <p>ClutterBehaviourOpacity — A behaviour controlling opacity</p>
42 <td valign="top" align="right"></td>
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>);
61 <div class="refsect1">
62 <a name="ClutterBehaviourOpacity.object-hierarchy"></a><h2>Object Hierarchy</h2>
63 <pre class="synopsis">
65 +----<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
66 +----ClutterBehaviourOpacity
69 <div class="refsect1">
70 <a name="ClutterBehaviourOpacity.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
72 ClutterBehaviourOpacity implements
73 <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
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
82 <div class="refsect1">
83 <a name="ClutterBehaviourOpacity.description"></a><h2>Description</h2>
85 <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> controls the opacity of a set of actors.
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>
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
102 <p class="since">Since 0.2</p>
105 <div class="refsect2">
106 <a name="ClutterBehaviourOpacityClass"></a><h3>struct ClutterBehaviourOpacityClass</h3>
107 <pre class="programlisting">struct ClutterBehaviourOpacityClass {
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>
115 The <a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacityClass" title="struct ClutterBehaviourOpacityClass"><span class="type">ClutterBehaviourOpacityClass</span></a> structure contains only private data
117 <p class="since">Since 0.2</p>
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>
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>.
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>.
139 <div class="variablelist"><table border="0">
140 <col align="left" valign="top">
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>
148 <td><p><span class="term"><em class="parameter"><code>opacity_start</code></em> :</span></p></td>
149 <td>minimum level of opacity</td>
152 <td><p><span class="term"><em class="parameter"><code>opacity_end</code></em> :</span></p></td>
153 <td>maximum level of opacity</td>
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>
162 <p class="since">Since 0.2</p>
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>
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.
179 <div class="variablelist"><table border="0">
180 <col align="left" valign="top">
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>
188 <td><p><span class="term"><em class="parameter"><code>opacity_start</code></em> :</span></p></td>
189 <td>minimum level of opacity</td>
192 <td><p><span class="term"><em class="parameter"><code>opacity_end</code></em> :</span></p></td>
193 <td>maximum level of opacity</td>
197 <p class="since">Since 0.6</p>
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>
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.
214 <div class="variablelist"><table border="0">
215 <col align="left" valign="top">
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>
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>
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>
234 <p class="since">Since 0.6</p>
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>
247 Final opacity level of the behaviour.
249 <p>Allowed values: <= 255</p>
250 <p>Default value: 0</p>
251 <p class="since">Since 0.2</p>
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>
262 Initial opacity level of the behaviour.
264 <p>Allowed values: <= 255</p>
265 <p>Default value: 0</p>
266 <p class="since">Since 0.2</p>
272 Generated by GTK-Doc V1.18.1</div>