<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterBehaviourOpacity: 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="deprecated.html" title="Part X. Deprecated Classes">
<link rel="prev" href="ClutterBehaviourEllipse.html" title="ClutterBehaviourEllipse">
<link rel="next" href="ClutterBehaviourPath.html" title="ClutterBehaviourPath">
<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="#ClutterBehaviourOpacity.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterBehaviourOpacity.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#ClutterBehaviourOpacity.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterBehaviourOpacity.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="deprecated.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterBehaviourEllipse.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterBehaviourPath.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterBehaviourOpacity"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterBehaviourOpacity.top_of_page"></a>ClutterBehaviourOpacity</span></h2>
<p>ClutterBehaviourOpacity — A behaviour controlling opacity</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterBehaviourOpacity.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="ClutterBehaviour.html" title="ClutterBehaviour"><span class="returnvalue">ClutterBehaviour</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterBehaviourOpacity.html#clutter-behaviour-opacity-new" title="clutter_behaviour_opacity_new ()">clutter_behaviour_opacity_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="ClutterBehaviourOpacity.html#clutter-behaviour-opacity-set-bounds" title="clutter_behaviour_opacity_set_bounds ()">clutter_behaviour_opacity_set_bounds</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="ClutterBehaviourOpacity.html#clutter-behaviour-opacity-get-bounds" title="clutter_behaviour_opacity_get_bounds ()">clutter_behaviour_opacity_get_bounds</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourOpacity.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">guint</span></td>
<td class="property_name"><a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacity--opacity-end" title="The “opacity-end” property">opacity-end</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacity--opacity-start" title="The “opacity-start” property">opacity-start</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourOpacity.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">struct</td>
<td class="function_name"><a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacity-struct" title="struct ClutterBehaviourOpacity">ClutterBehaviourOpacity</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacityClass" title="struct ClutterBehaviourOpacityClass">ClutterBehaviourOpacityClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourOpacity.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour">ClutterBehaviour</a>
<span class="lineart">╰──</span> ClutterBehaviourOpacity
</pre>
</div>
<div class="refsect1">
<a name="ClutterBehaviourOpacity.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterBehaviourOpacity implements
<a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
</div>
<div class="refsect1">
<a name="ClutterBehaviourOpacity.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> controls the opacity of a set of actors.</p>
</div>
<div class="refsect1">
<a name="ClutterBehaviourOpacity.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-behaviour-opacity-new"></a><h3>clutter_behaviour_opacity_new ()</h3>
<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>,
<em class="parameter"><code><span class="type">guint8</span> opacity_start</code></em>,
<em class="parameter"><code><span class="type">guint8</span> opacity_end</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_behaviour_opacity_new</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>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>
which controls the opacity property of every actor, making it
change in the interval between <em class="parameter"><code>opacity_start</code></em>
and <em class="parameter"><code>opacity_end</code></em>
.</p>
<p>If <em class="parameter"><code>alpha</code></em>
is not <code class="literal">NULL</code>, the <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> will take ownership
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 <code class="literal">NULL</code>,
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>.</p>
<div class="refsect3">
<a name="clutter-behaviour-opacity-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>alpha</p></td>
<td class="parameter_description"><p> a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>opacity_start</p></td>
<td class="parameter_description"><p>minimum level of opacity</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity_end</p></td>
<td class="parameter_description"><p>maximum level of opacity</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-behaviour-opacity-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-behaviour-opacity-set-bounds"></a><h3>clutter_behaviour_opacity_set_bounds ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_behaviour_opacity_set_bounds (<em class="parameter"><code><a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> *behaviour</code></em>,
<em class="parameter"><code><span class="type">guint8</span> opacity_start</code></em>,
<em class="parameter"><code><span class="type">guint8</span> opacity_end</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_behaviour_opacity_set_bounds</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Sets the initial and final levels of the opacity applied by <em class="parameter"><code>behaviour</code></em>
on each actor it controls.</p>
<div class="refsect3">
<a name="clutter-behaviour-opacity-set-bounds.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>behaviour</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity_start</p></td>
<td class="parameter_description"><p>minimum level of opacity</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity_end</p></td>
<td class="parameter_description"><p>maximum level of opacity</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-behaviour-opacity-get-bounds"></a><h3>clutter_behaviour_opacity_get_bounds ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_behaviour_opacity_get_bounds (<em class="parameter"><code><a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> *behaviour</code></em>,
<em class="parameter"><code><span class="type">guint8</span> *opacity_start</code></em>,
<em class="parameter"><code><span class="type">guint8</span> *opacity_end</code></em>);</pre>
<div class="warning"><p><code class="literal">clutter_behaviour_opacity_get_bounds</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Gets the initial and final levels of the opacity applied by <em class="parameter"><code>behaviour</code></em>
on each actor it controls.</p>
<div class="refsect3">
<a name="clutter-behaviour-opacity-get-bounds.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>behaviour</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>opacity_start</p></td>
<td class="parameter_description"><p> return location for the minimum level of opacity, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>opacity_end</p></td>
<td class="parameter_description"><p> return location for the maximum level of opacity, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourOpacity.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterBehaviourOpacity-struct"></a><h3>struct ClutterBehaviourOpacity</h3>
<pre class="programlisting">struct ClutterBehaviourOpacity;</pre>
<div class="warning">
<p><code class="literal">ClutterBehaviourOpacity</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p>
<p>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>
instead.</p>
</div>
<p>The <a class="link" href="ClutterBehaviourOpacity.html" title="ClutterBehaviourOpacity"><span class="type">ClutterBehaviourOpacity</span></a> structure contains only private data and
should be accessed using the provided API</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBehaviourOpacityClass"></a><h3>struct ClutterBehaviourOpacityClass</h3>
<pre class="programlisting">struct ClutterBehaviourOpacityClass {
};
</pre>
<div class="warning"><p><code class="literal">ClutterBehaviourOpacityClass</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>The <a class="link" href="ClutterBehaviourOpacity.html#ClutterBehaviourOpacityClass" title="struct ClutterBehaviourOpacityClass"><span class="type">ClutterBehaviourOpacityClass</span></a> structure contains only private data</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterBehaviourOpacity.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterBehaviourOpacity--opacity-end"></a><h3>The <code class="literal">“opacity-end”</code> property</h3>
<pre class="programlisting"> “opacity-end” <span class="type">guint</span></pre>
<p>Final opacity level of the behaviour.</p>
<div class="warning"><p><code class="literal">ClutterBehaviourOpacity:opacity-end</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Flags: Read / Write</p>
<p>Allowed values: <= 255</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterBehaviourOpacity--opacity-start"></a><h3>The <code class="literal">“opacity-start”</code> property</h3>
<pre class="programlisting"> “opacity-start” <span class="type">guint</span></pre>
<p>Initial opacity level of the behaviour.</p>
<div class="warning"><p><code class="literal">ClutterBehaviourOpacity:opacity-start</code> has been deprecated since version 1.6 and should not be used in newly-written code.</p></div>
<p>Flags: Read / Write</p>
<p>Allowed values: <= 255</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix03.html#api-index-0.2">0.2</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>