<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterAlpha: 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="deprecated.html" title="Part X. Deprecated Classes">
<link rel="next" href="clutter-Implicit-Animations.html" title="Implicit Animations">
<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="#ClutterAlpha.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterAlpha.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#ClutterAlpha.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterAlpha.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="deprecated.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="clutter-Implicit-Animations.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterAlpha"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterAlpha.top_of_page"></a>ClutterAlpha</span></h2>
<p>ClutterAlpha — A class for calculating a value as a function of time</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterAlpha.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">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="ClutterAlpha.html#ClutterAlphaFunc" title="ClutterAlphaFunc ()">*ClutterAlphaFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterAlpha.html#clutter-alpha-new" title="clutter_alpha_new ()">clutter_alpha_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterAlpha.html#clutter-alpha-new-full" title="clutter_alpha_new_full ()">clutter_alpha_new_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterAlpha.html#clutter-alpha-new-with-func" title="clutter_alpha_new_with_func ()">clutter_alpha_new_with_func</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="ClutterAlpha.html#clutter-alpha-set-timeline" title="clutter_alpha_set_timeline ()">clutter_alpha_set_timeline</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterAlpha.html#clutter-alpha-get-timeline" title="clutter_alpha_get_timeline ()">clutter_alpha_get_timeline</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="ClutterAlpha.html#clutter-alpha-set-mode" title="clutter_alpha_set_mode ()">clutter_alpha_set_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gulong</span>
</td>
<td class="function_name">
<a class="link" href="ClutterAlpha.html#clutter-alpha-get-mode" title="clutter_alpha_get_mode ()">clutter_alpha_get_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gdouble</span>
</td>
<td class="function_name">
<a class="link" href="ClutterAlpha.html#clutter-alpha-get-alpha" title="clutter_alpha_get_alpha ()">clutter_alpha_get_alpha</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="ClutterAlpha.html#clutter-alpha-set-func" title="clutter_alpha_set_func ()">clutter_alpha_set_func</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="ClutterAlpha.html#clutter-alpha-set-closure" title="clutter_alpha_set_closure ()">clutter_alpha_set_closure</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gulong</span>
</td>
<td class="function_name">
<a class="link" href="ClutterAlpha.html#clutter-alpha-register-closure" title="clutter_alpha_register_closure ()">clutter_alpha_register_closure</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gulong</span>
</td>
<td class="function_name">
<a class="link" href="ClutterAlpha.html#clutter-alpha-register-func" title="clutter_alpha_register_func ()">clutter_alpha_register_func</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterAlpha.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">gdouble</span></td>
<td class="property_name"><a class="link" href="ClutterAlpha.html#ClutterAlpha--alpha" title="The “alpha” property">alpha</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gulong</span></td>
<td class="property_name"><a class="link" href="ClutterAlpha.html#ClutterAlpha--mode" title="The “mode” property">mode</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterAlpha.html#ClutterAlpha--timeline" title="The “timeline” property">timeline</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterAlpha.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"> </td>
<td class="function_name"><a class="link" href="ClutterAlpha.html#ClutterAlpha-struct" title="ClutterAlpha">ClutterAlpha</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterAlpha.html#ClutterAlphaClass" title="struct ClutterAlphaClass">ClutterAlphaClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterAlpha.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> ClutterAlpha
</pre>
</div>
<div class="refsect1">
<a name="ClutterAlpha.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterAlpha implements
<a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
</div>
<div class="refsect1">
<a name="ClutterAlpha.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> is a class for calculating an floating point value
dependent only on the position of a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>.</p>
<p>For newly written code, it is recommended to use the
<a class="link" href="ClutterTimeline.html#ClutterTimeline--progress-mode" title="The “progress-mode” property"><span class="type">“progress-mode”</span></a> property of <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>, or the
<a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-func" title="clutter_timeline_set_progress_func ()"><code class="function">clutter_timeline_set_progress_func()</code></a> function instead of <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>.
The <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> class will be deprecated in the future, and will not
be available any more in the next major version of Clutter.</p>
<p>A <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> binds a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> to a progress function which
translates the time T into an adimensional factor alpha. The factor can
then be used to drive a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a>, which will translate the
alpha value into something meaningful for a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>.</p>
<p>You should provide a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> and bind it to the <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>
instance using <a class="link" href="ClutterAlpha.html#clutter-alpha-set-timeline" title="clutter_alpha_set_timeline ()"><code class="function">clutter_alpha_set_timeline()</code></a>. You should also set an
"animation mode", either by using the <a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> values that
Clutter itself provides or by registering custom functions using
<a class="link" href="ClutterAlpha.html#clutter-alpha-register-func" title="clutter_alpha_register_func ()"><code class="function">clutter_alpha_register_func()</code></a>.</p>
<p>Instead of a <a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> you may provide a function returning
the alpha value depending on the progress of the timeline, using
<a class="link" href="ClutterAlpha.html#clutter-alpha-set-func" title="clutter_alpha_set_func ()"><code class="function">clutter_alpha_set_func()</code></a> or <a class="link" href="ClutterAlpha.html#clutter-alpha-set-closure" title="clutter_alpha_set_closure ()"><code class="function">clutter_alpha_set_closure()</code></a>. The alpha
function will be executed each time a new frame in the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
is reached.</p>
<p>Since the alpha function is controlled by the timeline instance, you can
pause, stop or resume the <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> from calling the alpha function by
using the appropriate functions of the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> object.</p>
<p><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> is used to "drive" a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> instance, and it
is internally used by the <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> API.</p>
<p><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> is available since Clutter 0.2.</p>
<p><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> is deprecated since Clutter 1.12. <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> and
the <a class="link" href="ClutterTimeline.html#ClutterTimeline--progress-mode" title="The “progress-mode” property"><span class="type">“progress-mode”</span></a> property replace this whole class.</p>
<div class="refsect3">
<a name="id-1.11.2.8.11"></a><h4>ClutterAlpha custom properties for <a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a>
</h4>
<p><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> defines a custom <code class="literal">function</code> property for
<a class="link" href="ClutterScript.html" title="ClutterScript"><span class="type">ClutterScript</span></a> which allows to reference a custom alpha function
available in the source code. Setting the <code class="literal">function</code> property
is equivalent to calling <a class="link" href="ClutterAlpha.html#clutter-alpha-set-func" title="clutter_alpha_set_func ()"><code class="function">clutter_alpha_set_func()</code></a> with the
specified function name. No user data or <span class="type">GDestroyNotify</span> is
available to be passed.</p>
<p>The following JSON fragment defines a <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>
using a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> with id "sine-timeline" and an alpha
function called <code class="literal">my_sine_alpha</code>. The defined <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a>
instance can be reused in multiple <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a>
definitions or for <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a> definitions.</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="cbracket">{</span>
<span class="normal"> </span><span class="string">"id"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"sine-alpha"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"timeline"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="string">"id"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"sine-timeline"</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"duration"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="number">500</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"loop"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> true</span>
<span class="normal"> </span><span class="cbracket">}</span><span class="symbol">,</span>
<span class="normal"> </span><span class="string">"function"</span><span class="normal"> </span><span class="symbol">:</span><span class="normal"> </span><span class="string">"my_sine_alpha"</span>
<span class="cbracket">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterAlpha.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ClutterAlphaFunc"></a><h3>ClutterAlphaFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
<span class="c_punctuation">(</span>*ClutterAlphaFunc<span class="c_punctuation">)</span> (<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">gpointer</span> user_data</code></em>);</pre>
<div class="warning">
<p><code class="literal">ClutterAlphaFunc</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html#ClutterTimelineProgressFunc" title="ClutterTimelineProgressFunc ()"><span class="type">ClutterTimelineProgressFunc</span></a> instead.</p>
</div>
<p>A function returning a value depending on the position of
the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> bound to <em class="parameter"><code>alpha</code></em>
.</p>
<div class="refsect3">
<a name="ClutterAlphaFunc.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></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data passed to the function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ClutterAlphaFunc.returns"></a><h4>Returns</h4>
<p> a floating point value</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-alpha-new"></a><h3>clutter_alpha_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *
clutter_alpha_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_new</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instead</p>
</div>
<p>Creates a new <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance. You must set a function
to compute the alpha value using <a class="link" href="ClutterAlpha.html#clutter-alpha-set-func" title="clutter_alpha_set_func ()"><code class="function">clutter_alpha_set_func()</code></a> and
bind a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> object to the <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance
using <a class="link" href="ClutterAlpha.html#clutter-alpha-set-timeline" title="clutter_alpha_set_timeline ()"><code class="function">clutter_alpha_set_timeline()</code></a>.</p>
<p>You should use the newly created <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance inside
a <a class="link" href="ClutterBehaviour.html" title="ClutterBehaviour"><span class="type">ClutterBehaviour</span></a> object.</p>
<div class="refsect3">
<a name="clutter-alpha-new.returns"></a><h4>Returns</h4>
<p> the newly created empty <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance.</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-alpha-new-full"></a><h3>clutter_alpha_new_full ()</h3>
<pre class="programlisting"><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *
clutter_alpha_new_full (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
<em class="parameter"><code><span class="type">gulong</span> mode</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_new_full</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instead</p>
</div>
<p>Creates a new <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instance and sets the timeline
and animation mode.</p>
<p>See also <a class="link" href="ClutterAlpha.html#clutter-alpha-set-timeline" title="clutter_alpha_set_timeline ()"><code class="function">clutter_alpha_set_timeline()</code></a> and <a class="link" href="ClutterAlpha.html#clutter-alpha-set-mode" title="clutter_alpha_set_mode ()"><code class="function">clutter_alpha_set_mode()</code></a>.</p>
<div class="refsect3">
<a name="clutter-alpha-new-full.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>timeline</p></td>
<td class="parameter_description"><p><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> timeline</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>animation mode</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-alpha-new-full.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-alpha-new-with-func"></a><h3>clutter_alpha_new_with_func ()</h3>
<pre class="programlisting"><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="returnvalue">ClutterAlpha</span></a> *
clutter_alpha_new_with_func (<em class="parameter"><code><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>,
<em class="parameter"><code><a class="link" href="ClutterAlpha.html#ClutterAlphaFunc" title="ClutterAlphaFunc ()"><span class="type">ClutterAlphaFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_new_with_func</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instead</p>
</div>
<p>Creates a new <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> instances and sets the timeline
and the alpha function.</p>
<p>This function will not register <em class="parameter"><code>func</code></em>
as a global alpha function.</p>
<p>See also <a class="link" href="ClutterAlpha.html#clutter-alpha-set-timeline" title="clutter_alpha_set_timeline ()"><code class="function">clutter_alpha_set_timeline()</code></a> and <a class="link" href="ClutterAlpha.html#clutter-alpha-set-func" title="clutter_alpha_set_func ()"><code class="function">clutter_alpha_set_func()</code></a>.</p>
<div class="refsect3">
<a name="clutter-alpha-new-with-func.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>timeline</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterAlpha.html#ClutterAlphaFunc" title="ClutterAlphaFunc ()"><span class="type">ClutterAlphaFunc</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>data to pass to the function, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>function to call when removing the alpha function, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-alpha-new-with-func.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-alpha-set-timeline"></a><h3>clutter_alpha_set_timeline ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_alpha_set_timeline (<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><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *timeline</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_set_timeline</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> directly</p>
</div>
<p>Binds <em class="parameter"><code>alpha</code></em>
to <em class="parameter"><code>timeline</code></em>
.</p>
<div class="refsect3">
<a name="clutter-alpha-set-timeline.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></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeline</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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-alpha-get-timeline"></a><h3>clutter_alpha_get_timeline ()</h3>
<pre class="programlisting"><a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="returnvalue">ClutterTimeline</span></a> *
clutter_alpha_get_timeline (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_get_timeline</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> directlry</p>
</div>
<p>Gets the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> bound to <em class="parameter"><code>alpha</code></em>
.</p>
<div class="refsect3">
<a name="clutter-alpha-get-timeline.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></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-alpha-get-timeline.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instance. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></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-alpha-set-mode"></a><h3>clutter_alpha_set_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_alpha_set_mode (<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">gulong</span> mode</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_set_mode</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> and
<a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-mode" title="clutter_timeline_set_progress_mode ()"><code class="function">clutter_timeline_set_progress_mode()</code></a> instead</p>
</div>
<p>Sets the progress function of <em class="parameter"><code>alpha</code></em>
using the symbolic value
of <em class="parameter"><code>mode</code></em>
, as taken by the <a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> enumeration or
using the value returned by <a class="link" href="ClutterAlpha.html#clutter-alpha-register-func" title="clutter_alpha_register_func ()"><code class="function">clutter_alpha_register_func()</code></a>.</p>
<div class="refsect3">
<a name="clutter-alpha-set-mode.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></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-alpha-get-mode"></a><h3>clutter_alpha_get_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">gulong</span>
clutter_alpha_get_mode (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_get_mode</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instead</p>
</div>
<p>Retrieves the <a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> used by <em class="parameter"><code>alpha</code></em>
.</p>
<div class="refsect3">
<a name="clutter-alpha-get-mode.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></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-alpha-get-mode.returns"></a><h4>Returns</h4>
<p> the animation mode</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-alpha-get-alpha"></a><h3>clutter_alpha_get_alpha ()</h3>
<pre class="programlisting"><span class="returnvalue">gdouble</span>
clutter_alpha_get_alpha (<em class="parameter"><code><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> *alpha</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_get_alpha</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html#clutter-timeline-get-progress" title="clutter_timeline_get_progress ()"><code class="function">clutter_timeline_get_progress()</code></a></p>
</div>
<p>Query the current alpha value.</p>
<div class="refsect3">
<a name="clutter-alpha-get-alpha.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></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-alpha-get-alpha.returns"></a><h4>Returns</h4>
<p> The current alpha value for the alpha</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-alpha-set-func"></a><h3>clutter_alpha_set_func ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_alpha_set_func (<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><a class="link" href="ClutterAlpha.html#ClutterAlphaFunc" title="ClutterAlphaFunc ()"><span class="type">ClutterAlphaFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_set_func</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-func" title="clutter_timeline_set_progress_func ()"><code class="function">clutter_timeline_set_progress_func()</code></a></p>
</div>
<p>Sets the <a class="link" href="ClutterAlpha.html#ClutterAlphaFunc" title="ClutterAlphaFunc ()"><span class="type">ClutterAlphaFunc</span></a> function used to compute
the alpha value at each frame of the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a>
bound to <em class="parameter"><code>alpha</code></em>
.</p>
<p>This function will not register <em class="parameter"><code>func</code></em>
as a global alpha function.</p>
<div class="refsect3">
<a name="clutter-alpha-set-func.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></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>A <a class="link" href="ClutterAlpha.html#ClutterAlphaFunc" title="ClutterAlphaFunc ()"><span class="type">ClutterAlphaFunc</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>user data to be passed to the alpha function, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy</p></td>
<td class="parameter_description"><p>notify function used when disposing the alpha function</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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-alpha-set-closure"></a><h3>clutter_alpha_set_closure ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_alpha_set_closure (<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">GClosure</span> *closure</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_set_closure</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-func" title="clutter_timeline_set_progress_func ()"><code class="function">clutter_timeline_set_progress_func()</code></a></p>
</div>
<p>Sets the <span class="type">GClosure</span> used to compute the alpha value at each
frame of the <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> bound to <em class="parameter"><code>alpha</code></em>
.</p>
<div class="refsect3">
<a name="clutter-alpha-set-closure.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></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>closure</p></td>
<td class="parameter_description"><p>A <span class="type">GClosure</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix06.html#api-index-0.8">0.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-alpha-register-closure"></a><h3>clutter_alpha_register_closure ()</h3>
<pre class="programlisting"><span class="returnvalue">gulong</span>
clutter_alpha_register_closure (<em class="parameter"><code><span class="type">GClosure</span> *closure</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_register_closure</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this
function. Use <a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-func" title="clutter_timeline_set_progress_func ()"><code class="function">clutter_timeline_set_progress_func()</code></a> on each
specific <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instance</p>
</div>
<p><span class="type">GClosure</span> variant of <a class="link" href="ClutterAlpha.html#clutter-alpha-register-func" title="clutter_alpha_register_func ()"><code class="function">clutter_alpha_register_func()</code></a>.</p>
<p>Registers a global alpha function and returns its logical id
to be used by <a class="link" href="ClutterAlpha.html#clutter-alpha-set-mode" title="clutter_alpha_set_mode ()"><code class="function">clutter_alpha_set_mode()</code></a> or by <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a>.</p>
<p>The logical id is always greater than <a class="link" href="ClutterTimeline.html#CLUTTER-ANIMATION-LAST:CAPS"><code class="literal">CLUTTER_ANIMATION_LAST</code></a>.</p>
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> clutter_alpha_register_func]</span></p>
<div class="refsect3">
<a name="clutter-alpha-register-closure.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>closure</p></td>
<td class="parameter_description"><p>a <span class="type">GClosure</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-alpha-register-closure.returns"></a><h4>Returns</h4>
<p> the logical id of the alpha function</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-alpha-register-func"></a><h3>clutter_alpha_register_func ()</h3>
<pre class="programlisting"><span class="returnvalue">gulong</span>
clutter_alpha_register_func (<em class="parameter"><code><a class="link" href="ClutterAlpha.html#ClutterAlphaFunc" title="ClutterAlphaFunc ()"><span class="type">ClutterAlphaFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<div class="warning">
<p><code class="literal">clutter_alpha_register_func</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>There is no direct replacement for this
function. Use <a class="link" href="ClutterTimeline.html#clutter-timeline-set-progress-func" title="clutter_timeline_set_progress_func ()"><code class="function">clutter_timeline_set_progress_func()</code></a> on each
specific <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instance</p>
</div>
<p>Registers a global alpha function and returns its logical id
to be used by <a class="link" href="ClutterAlpha.html#clutter-alpha-set-mode" title="clutter_alpha_set_mode ()"><code class="function">clutter_alpha_set_mode()</code></a> or by <a class="link" href="clutter-Implicit-Animations.html#ClutterAnimation"><span class="type">ClutterAnimation</span></a>.</p>
<p>The logical id is always greater than <a class="link" href="ClutterTimeline.html#CLUTTER-ANIMATION-LAST:CAPS"><code class="literal">CLUTTER_ANIMATION_LAST</code></a>.</p>
<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p>
<div class="refsect3">
<a name="clutter-alpha-register-func.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>func</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterAlpha.html#ClutterAlphaFunc" title="ClutterAlphaFunc ()"><span class="type">ClutterAlphaFunc</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>user data to pass to <em class="parameter"><code>func</code></em>
, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-alpha-register-func.returns"></a><h4>Returns</h4>
<p> the logical id of the alpha function</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterAlpha.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterAlpha-struct"></a><h3>ClutterAlpha</h3>
<pre class="programlisting">typedef struct _ClutterAlpha ClutterAlpha;</pre>
<div class="warning">
<p><code class="literal">ClutterAlpha</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instead</p>
</div>
<p><a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> combines a <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> and a function.
The contents of the <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a> structure are private and should
only 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="ClutterAlphaClass"></a><h3>struct ClutterAlphaClass</h3>
<pre class="programlisting">struct ClutterAlphaClass {
};
</pre>
<div class="warning">
<p><code class="literal">ClutterAlphaClass</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instead</p>
</div>
<p>Base class for <a class="link" href="ClutterAlpha.html" title="ClutterAlpha"><span class="type">ClutterAlpha</span></a></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="ClutterAlpha.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterAlpha--alpha"></a><h3>The <code class="literal">“alpha”</code> property</h3>
<pre class="programlisting"> “alpha” <span class="type">gdouble</span></pre>
<p>The alpha value as computed by the alpha function. The linear
interval is 0.0 to 1.0, but the Alpha allows overshooting by
one unit in each direction, so the valid interval is -1.0 to 2.0.</p>
<div class="warning">
<p><code class="literal">ClutterAlpha:alpha</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html#ClutterTimeline-new-frame" title="The “new-frame” signal"><span class="type">“new-frame”</span></a> and
<a class="link" href="ClutterTimeline.html#clutter-timeline-get-progress" title="clutter_timeline_get_progress ()"><code class="function">clutter_timeline_get_progress()</code></a> instead</p>
</div>
<p>Flags: Read</p>
<p>Allowed values: [-1,2]</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="ClutterAlpha--mode"></a><h3>The <code class="literal">“mode”</code> property</h3>
<pre class="programlisting"> “mode” <span class="type">gulong</span></pre>
<p>The progress function logical id - either a value from the
<a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> enumeration or a value returned by
<a class="link" href="ClutterAlpha.html#clutter-alpha-register-func" title="clutter_alpha_register_func ()"><code class="function">clutter_alpha_register_func()</code></a>.</p>
<p>If <a class="link" href="ClutterTimeline.html#CLUTTER-CUSTOM-MODE:CAPS"><code class="literal">CLUTTER_CUSTOM_MODE</code></a> is used then the function set using
<a class="link" href="ClutterAlpha.html#clutter-alpha-set-closure" title="clutter_alpha_set_closure ()"><code class="function">clutter_alpha_set_closure()</code></a> or <a class="link" href="ClutterAlpha.html#clutter-alpha-set-func" title="clutter_alpha_set_func ()"><code class="function">clutter_alpha_set_func()</code></a>
will be used.</p>
<div class="warning">
<p><code class="literal">ClutterAlpha:mode</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="ClutterTimeline.html#ClutterTimeline--progress-mode" title="The “progress-mode” property"><span class="type">“progress-mode”</span></a></p>
</div>
<p>Flags: Read / Write / Construct</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterAlpha--timeline"></a><h3>The <code class="literal">“timeline”</code> property</h3>
<pre class="programlisting"> “timeline” <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> *</pre>
<p>A <a class="link" href="ClutterTimeline.html" title="ClutterTimeline"><span class="type">ClutterTimeline</span></a> instance used to drive the alpha function.</p>
<div class="warning"><p><code class="literal">ClutterAlpha:timeline</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p></div>
<p>Flags: Read / Write</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>