5
5
<title>ClutterBehaviourOpacity</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Clutter Reference Manual">
8
<link rel="up" href="ch05.html" title="Behaviours">
8
<link rel="up" href="ch06.html" title="Behaviours">
9
9
<link rel="prev" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse">
10
10
<link rel="next" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="clutter-overview.html" title="Part I. Overview">
14
<link rel="part" href="building-clutter.html" title="Part II. Building Clutter">
15
<link rel="part" href="running-clutter.html" title="Part III. Running Clutter">
16
<link rel="part" href="clutterbase.html" title="Part IV. Clutter Core Reference">
17
<link rel="chapter" href="ch01.html" title="Abstract classes and interfaces">
18
<link rel="chapter" href="ch02.html" title="Base actors">
19
<link rel="chapter" href="ch03.html" title="Container actors">
20
<link rel="part" href="clutteranimation.html" title="Part V. Clutter Animation Framework">
21
<link rel="chapter" href="ch04.html" title="Base classes">
22
<link rel="chapter" href="ch05.html" title="Behaviours">
23
<link rel="chapter" href="ch06.html" title="High Level API">
24
<link rel="part" href="cluttertools.html" title="Part VI. Clutter Tools">
25
<link rel="chapter" href="ch07.html" title="General purpose API">
26
<link rel="chapter" href="ch08.html" title="User interface definition">
27
<link rel="chapter" href="ch09.html" title="Generic list model">
28
<link rel="part" href="clutterbackends.html" title="Part VII. Clutter Backends">
29
<link rel="part" href="additionaldocs.html" title="Part VIII. Additional Documentation">
30
<link rel="chapter" href="clutter-subclassing-ClutterActor.html" title="Implementing a new actor">
31
<link rel="chapter" href="clutter-animations.html" title="Creating Animations with Clutter">
32
<link rel="chapter" href="creating-your-own-behaviours.html" title="Creating You Own Behaviours">
33
<link rel="part" href="migration.html" title="Part IX. Migrating from previous version of Clutter">
34
<link rel="part" href="pt10.html" title="Part I. ">
35
<link rel="chapter" href="migrating-ClutterEffect.html" title="Migrating from ClutterEffect">
36
<link rel="chapter" href="migrating-ClutterPath.html" title="Migrating to ClutterPath">
37
<link rel="part" href="clutterobjects.html" title="Part X. Clutter Actors and Objects">
38
<link rel="chapter" href="clutterobjecthierarchy.html" title="Object Hierarchy">
39
<link rel="chapter" href="clutterobjectindex.html" title="Object Index">
40
<link rel="part" href="clutterglossary.html" title="Part XI. Glossaries">
41
<link rel="glossary" href="go01.html" title="Glossary">
42
<link rel="glossary" href="annotation-glossary.html" title="Annotation Glossary">
43
<link rel="index" href="ix01.html" title="Index of all symbols">
44
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
45
<link rel="index" href="ix03.html" title="Index of new symbols in 0.2">
46
<link rel="index" href="ix04.html" title="Index of new symbols in 0.4">
47
<link rel="index" href="ix05.html" title="Index of new symbols in 0.6">
48
<link rel="index" href="ix06.html" title="Index of new symbols in 0.8">
49
<link rel="index" href="ix07.html" title="Index of new symbols in 1.0">
50
<link rel="appendix" href="license.html" title="Appendix A. License">
52
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
53
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
54
16
<tr valign="middle">
55
17
<td><a accesskey="p" href="ClutterBehaviourEllipse.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
56
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
18
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
57
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
58
20
<th width="100%" align="center">Clutter Reference Manual</th>
59
21
<td><a accesskey="n" href="ClutterBehaviourPath.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
61
23
<tr><td colspan="5" class="shortcuts">
62
24
<a href="#ClutterBehaviourOpacity.synopsis" class="shortcut">Top</a>
64
<a href="#ClutterBehaviourOpacity.description" class="shortcut">Description</a>
66
<a href="#ClutterBehaviourOpacity.object-hierarchy" class="shortcut">Object Hierarchy</a>
68
<a href="#ClutterBehaviourOpacity.properties" class="shortcut">Properties</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>
71
35
<div class="refentry" title="ClutterBehaviourOpacity">
79
43
</tr></table></div>
80
44
<div class="refsynopsisdiv" title="Synopsis">
81
45
<a name="ClutterBehaviourOpacity.synopsis"></a><h2>Synopsis</h2>
82
<pre class="synopsis">
83
<a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacity-struct" title="ClutterBehaviourOpacity">ClutterBehaviourOpacity</a>;
46
<pre class="synopsis"> <a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacity-struct" title="ClutterBehaviourOpacity">ClutterBehaviourOpacity</a>;
84
47
<a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacityClass" title="ClutterBehaviourOpacityClass">ClutterBehaviourOpacityClass</a>;
85
<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a> * <a class="link" href="ClutterBehaviourOpacity.html#clutter-behaviour-opacity-new" title="clutter_behaviour_opacity_new ()">clutter_behaviour_opacity_new</a> (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a> *alpha,
87
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
88
>guint8</a> opacity_start,
90
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
91
>guint8</a> opacity_end);
92
void <a class="link" href="ClutterBehaviourOpacity.html#clutter-behaviour-opacity-set-bounds" title="clutter_behaviour_opacity_set_bounds ()">clutter_behaviour_opacity_set_bounds</a>
93
(<a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity">ClutterBehaviourOpacity</a> *behaviour,
95
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
96
>guint8</a> opacity_start,
98
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
99
>guint8</a> opacity_end);
100
void <a class="link" href="ClutterBehaviourOpacity.html#clutter-behaviour-opacity-get-bounds" title="clutter_behaviour_opacity_get_bounds ()">clutter_behaviour_opacity_get_bounds</a>
101
(<a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity">ClutterBehaviourOpacity</a> *behaviour,
103
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
104
>guint8</a> *opacity_start,
106
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
107
>guint8</a> *opacity_end);
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>);
110
61
<div class="refsect1" title="Object Hierarchy">
111
62
<a name="ClutterBehaviourOpacity.object-hierarchy"></a><h2>Object Hierarchy</h2>
112
63
<pre class="synopsis">
114
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
116
65
+----<a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
117
66
+----ClutterBehaviourOpacity
69
<div class="refsect1" title="Implemented Interfaces">
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>
120
75
<div class="refsect1" title="Properties">
121
76
<a name="ClutterBehaviourOpacity.properties"></a><h2>Properties</h2>
122
77
<pre class="synopsis">
123
"<a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacity--opacity-end" title='The "opacity-end" property'>opacity-end</a>" <a
124
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
125
>guint</a> : Read / Write
126
"<a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacity--opacity-start" title='The "opacity-start" property'>opacity-start</a>" <a
127
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
128
>guint</a> : Read / Write
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
131
82
<div class="refsect1" title="Description">
132
83
<a name="ClutterBehaviourOpacity.description"></a><h2>Description</h2>
134
<a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> controls the opacity of a set of actors.</p>
85
<a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> controls the opacity of a set of actors.
138
88
<div class="refsect1" title="Details">
154
103
} ClutterBehaviourOpacityClass;
157
The <span class="type">ClutterBehaviourOpacityClas</span> structure contains only private data</p>
106
The <span class="type">ClutterBehaviourOpacityClas</span> structure contains only private data
160
108
<p class="since">Since 0.2</p>
163
111
<div class="refsect2" title="clutter_behaviour_opacity_new ()">
164
112
<a name="clutter-behaviour-opacity-new"></a><h3>clutter_behaviour_opacity_new ()</h3>
165
<pre class="programlisting"><a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a> * clutter_behaviour_opacity_new (<a class="link" href="ClutterAlpha.html" title="ClutterAlpha">ClutterAlpha</a> *alpha,
167
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
168
>guint8</a> opacity_start,
170
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
171
>guint8</a> opacity_end);</pre>
113
<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>,
114
<em class="parameter"><code><span class="type">guint8</span> opacity_start</code></em>,
115
<em class="parameter"><code><span class="type">guint8</span> opacity_end</code></em>);</pre>
173
117
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>
174
118
which controls the opacity property of every actor, making it
175
change in the interval between <em class="parameter"><code>opacity_start</code></em> and <em class="parameter"><code>opacity_end</code></em>.</p>
119
change in the interval between <em class="parameter"><code>opacity_start</code></em> and <em class="parameter"><code>opacity_end</code></em>.
178
121
<div class="variablelist"><table border="0">
179
122
<col align="left" valign="top">
182
125
<td><p><span class="term"><em class="parameter"><code>alpha</code></em> :</span></p></td>
183
<td> a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <a
184
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
185
><code class="literal">NULL</code></a>
126
<td>a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <code class="literal">NULL</code>
189
130
<td><p><span class="term"><em class="parameter"><code>opacity_start</code></em> :</span></p></td>
190
<td> minimum level of opacity
131
<td>minimum level of opacity
194
135
<td><p><span class="term"><em class="parameter"><code>opacity_end</code></em> :</span></p></td>
195
<td> maximum level of opacity
136
<td>maximum level of opacity
209
150
<div class="refsect2" title="clutter_behaviour_opacity_set_bounds ()">
210
151
<a name="clutter-behaviour-opacity-set-bounds"></a><h3>clutter_behaviour_opacity_set_bounds ()</h3>
211
<pre class="programlisting">void clutter_behaviour_opacity_set_bounds
212
(<a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity">ClutterBehaviourOpacity</a> *behaviour,
214
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
215
>guint8</a> opacity_start,
217
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
218
>guint8</a> opacity_end);</pre>
152
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_opacity_set_bounds
153
(<em class="parameter"><code><a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> *behaviour</code></em>,
154
<em class="parameter"><code><span class="type">guint8</span> opacity_start</code></em>,
155
<em class="parameter"><code><span class="type">guint8</span> opacity_end</code></em>);</pre>
220
157
Sets the initial and final levels of the opacity applied by <em class="parameter"><code>behaviour</code></em>
221
on each actor it controls.</p>
158
on each actor it controls.
224
160
<div class="variablelist"><table border="0">
225
161
<col align="left" valign="top">
228
164
<td><p><span class="term"><em class="parameter"><code>behaviour</code></em> :</span></p></td>
229
<td> a <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a>
165
<td>a <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a>
233
169
<td><p><span class="term"><em class="parameter"><code>opacity_start</code></em> :</span></p></td>
234
<td> minimum level of opacity
170
<td>minimum level of opacity
238
174
<td><p><span class="term"><em class="parameter"><code>opacity_end</code></em> :</span></p></td>
239
<td> maximum level of opacity
175
<td>maximum level of opacity
247
183
<div class="refsect2" title="clutter_behaviour_opacity_get_bounds ()">
248
184
<a name="clutter-behaviour-opacity-get-bounds"></a><h3>clutter_behaviour_opacity_get_bounds ()</h3>
249
<pre class="programlisting">void clutter_behaviour_opacity_get_bounds
250
(<a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity">ClutterBehaviourOpacity</a> *behaviour,
252
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
253
>guint8</a> *opacity_start,
255
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint8"
256
>guint8</a> *opacity_end);</pre>
185
<pre class="programlisting"><span class="returnvalue">void</span> clutter_behaviour_opacity_get_bounds
186
(<em class="parameter"><code><a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> *behaviour</code></em>,
187
<em class="parameter"><code><span class="type">guint8</span> *opacity_start</code></em>,
188
<em class="parameter"><code><span class="type">guint8</span> *opacity_end</code></em>);</pre>
258
190
Gets the initial and final levels of the opacity applied by <em class="parameter"><code>behaviour</code></em>
259
on each actor it controls.</p>
191
on each actor it controls.
262
193
<div class="variablelist"><table border="0">
263
194
<col align="left" valign="top">
266
197
<td><p><span class="term"><em class="parameter"><code>behaviour</code></em> :</span></p></td>
267
<td> a <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a>
198
<td>a <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a>
271
202
<td><p><span class="term"><em class="parameter"><code>opacity_start</code></em> :</span></p></td>
272
<td> return location for the minimum level of opacity, or <a
273
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
274
><code class="literal">NULL</code></a>
203
<td>return location for the minimum level of opacity, or <code class="literal">NULL</code>
278
207
<td><p><span class="term"><em class="parameter"><code>opacity_end</code></em> :</span></p></td>
279
<td> return location for the maximum level of opacity, or <a
280
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
281
><code class="literal">NULL</code></a>
208
<td>return location for the maximum level of opacity, or <code class="literal">NULL</code>
290
217
<a name="ClutterBehaviourOpacity.property-details"></a><h2>Property Details</h2>
291
218
<div class="refsect2" title='The "opacity-end" property'>
292
219
<a name="ClutterBehaviourOpacity--opacity-end"></a><h3>The <code class="literal">"opacity-end"</code> property</h3>
293
<pre class="programlisting"> "opacity-end" <a
294
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
295
>guint</a> : Read / Write</pre>
297
Final opacity level of the behaviour.</p>
220
<pre class="programlisting"> "opacity-end" <span class="type">guint</span> : Read / Write</pre>
222
Final opacity level of the behaviour.
300
224
<p>Allowed values: <= 255</p>
301
225
<p>Default value: 0</p>
226
<p class="since">Since 0.2</p>
305
229
<div class="refsect2" title='The "opacity-start" property'>
306
230
<a name="ClutterBehaviourOpacity--opacity-start"></a><h3>The <code class="literal">"opacity-start"</code> property</h3>
307
<pre class="programlisting"> "opacity-start" <a
308
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
309
>guint</a> : Read / Write</pre>
311
Initial opacity level of the behaviour.</p>
231
<pre class="programlisting"> "opacity-start" <span class="type">guint</span> : Read / Write</pre>
233
Initial opacity level of the behaviour.
314
235
<p>Allowed values: <= 255</p>
315
236
<p>Default value: 0</p>
237
<p class="since">Since 0.2</p>
320
241
<div class="footer">
322
Generated by GTK-Doc V1.11</div>
243
Generated by GTK-Doc V1.15.1</div>
b'\\ No newline at end of file'