Blob Blame History Raw
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterKeyframeTransition: 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="ch09.html" title="Base classes">
<link rel="prev" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition">
<link rel="next" href="ClutterTransitionGroup.html" title="ClutterTransitionGroup">
<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="#ClutterKeyframeTransition.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#ClutterKeyframeTransition.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#ClutterKeyframeTransition.implemented-interfaces" class="shortcut">Implemented Interfaces</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="ch09.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterPropertyTransition.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterTransitionGroup.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterKeyframeTransition"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterKeyframeTransition.top_of_page"></a>ClutterKeyframeTransition</span></h2>
<p>ClutterKeyframeTransition — Keyframe property transition</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterKeyframeTransition.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="ClutterTransition.html" title="ClutterTransition"><span class="returnvalue">ClutterTransition</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterKeyframeTransition.html#clutter-keyframe-transition-new" title="clutter_keyframe_transition_new ()">clutter_keyframe_transition_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="ClutterKeyframeTransition.html#clutter-keyframe-transition-set" title="clutter_keyframe_transition_set ()">clutter_keyframe_transition_set</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="ClutterKeyframeTransition.html#clutter-keyframe-transition-set-key-frames" title="clutter_keyframe_transition_set_key_frames ()">clutter_keyframe_transition_set_key_frames</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="ClutterKeyframeTransition.html#clutter-keyframe-transition-set-modes" title="clutter_keyframe_transition_set_modes ()">clutter_keyframe_transition_set_modes</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="ClutterKeyframeTransition.html#clutter-keyframe-transition-set-values" title="clutter_keyframe_transition_set_values ()">clutter_keyframe_transition_set_values</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterKeyframeTransition.html#clutter-keyframe-transition-get-n-key-frames" title="clutter_keyframe_transition_get_n_key_frames ()">clutter_keyframe_transition_get_n_key_frames</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="ClutterKeyframeTransition.html#clutter-keyframe-transition-set-key-frame" title="clutter_keyframe_transition_set_key_frame ()">clutter_keyframe_transition_set_key_frame</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="ClutterKeyframeTransition.html#clutter-keyframe-transition-get-key-frame" title="clutter_keyframe_transition_get_key_frame ()">clutter_keyframe_transition_get_key_frame</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="ClutterKeyframeTransition.html#clutter-keyframe-transition-clear" title="clutter_keyframe_transition_clear ()">clutter_keyframe_transition_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterKeyframeTransition.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="ClutterKeyframeTransition.html#ClutterKeyframeTransition-struct" title="ClutterKeyframeTransition">ClutterKeyframeTransition</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterKeyframeTransition.html#ClutterKeyframeTransitionClass" title="struct ClutterKeyframeTransitionClass">ClutterKeyframeTransitionClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterKeyframeTransition.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="ClutterTimeline.html" title="ClutterTimeline">ClutterTimeline</a>
        <span class="lineart">╰──</span> <a class="link" href="ClutterTransition.html" title="ClutterTransition">ClutterTransition</a>
            <span class="lineart">╰──</span> <a class="link" href="ClutterPropertyTransition.html" title="ClutterPropertyTransition">ClutterPropertyTransition</a>
                <span class="lineart">╰──</span> ClutterKeyframeTransition
</pre>
</div>
<div class="refsect1">
<a name="ClutterKeyframeTransition.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterKeyframeTransition implements
 <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>.</p>
</div>
<div class="refsect1">
<a name="ClutterKeyframeTransition.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> allows animating a property by defining
"key frames": values at a normalized position on the transition
duration.</p>
<p>The <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> interpolates the value of the property
to which it's bound across these key values.</p>
<p>Setting up a <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> means providing the times,
values, and easing modes between these key frames, for instance:</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="usertype">ClutterTransition</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">keyframe</span><span class="symbol">;</span>

<span class="normal">keyframe </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterKeyframeTransition.html#clutter-keyframe-transition-new">clutter_keyframe_transition_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"opacity"</span><span class="symbol">);</span>
<span class="function"><a href="ClutterTransition.html#clutter-transition-set-from">clutter_transition_set_from</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">keyframe</span><span class="symbol">,</span><span class="normal"> G_TYPE_UINT</span><span class="symbol">,</span><span class="normal"> </span><span class="number">255</span><span class="symbol">);</span>
<span class="function"><a href="ClutterTransition.html#clutter-transition-set-to">clutter_transition_set_to</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">keyframe</span><span class="symbol">,</span><span class="normal"> G_TYPE_UINT</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">);</span>
<span class="function"><a href="ClutterKeyframeTransition.html#clutter-keyframe-transition-set">clutter_keyframe_transition_set</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_KEYFRAME_TRANSITION</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">keyframe</span><span class="symbol">),</span>
<span class="normal">                                 G_TYPE_UINT</span><span class="symbol">,</span>
<span class="normal">                                 </span><span class="number">1</span><span class="symbol">,</span><span class="normal"> </span><span class="comment">/* number of key frames */</span>
<span class="normal">                                 </span><span class="number">0.5</span><span class="symbol">,</span><span class="normal"> </span><span class="number">128</span><span class="symbol">,</span><span class="normal"> <a href="ClutterTimeline.html#CLUTTER-EASE-IN-OUT-CUBIC:CAPS">CLUTTER_EASE_IN_OUT_CUBIC</a></span><span class="symbol">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

<p></p>
<p>The example above sets up a keyframe transition for the <a class="link" href="ClutterActor.html#ClutterActor--opacity" title="The “opacity” property"><span class="type">“opacity”</span></a>
property of a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a>; the transition starts and sets the value of the
property to fully transparent; between the start of the transition and its mid
point, it will animate the property to half opacity, using an easy in/easy out
progress. Once the transition reaches the mid point, it will linearly fade the
actor out until it reaches the end of the transition.</p>
<p>The <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> will add an implicit key frame between the last
and the 1.0 value, to interpolate to the final value of the transition's
interval.</p>
<p><a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> is available since Clutter 1.12.</p>
</div>
<div class="refsect1">
<a name="ClutterKeyframeTransition.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-keyframe-transition-new"></a><h3>clutter_keyframe_transition_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterTransition.html" title="ClutterTransition"><span class="returnvalue">ClutterTransition</span></a> *
clutter_keyframe_transition_new (<em class="parameter"><code>const <span class="type">char</span> *property_name</code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> for <em class="parameter"><code>property_name</code></em>
.</p>
<div class="refsect3">
<a name="clutter-keyframe-transition-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>property_name</p></td>
<td class="parameter_description"><p>the property to animate</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-keyframe-transition-new.returns"></a><h4>Returns</h4>
<p> the newly allocated
<a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> instance. Use <code class="function">g_object_unref()</code> when
done to free its resources. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-keyframe-transition-set"></a><h3>clutter_keyframe_transition_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_keyframe_transition_set (<em class="parameter"><code><a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> *transition</code></em>,
                                 <em class="parameter"><code><span class="type">GType</span> gtype</code></em>,
                                 <em class="parameter"><code><span class="type">guint</span> n_key_frames</code></em>,
                                 <em class="parameter"><code>...</code></em>);</pre>
<p>Sets the key frames of the <em class="parameter"><code>transition</code></em>
.</p>
<p>This variadic arguments function is a convenience for C developers;
language bindings should use <a class="link" href="ClutterKeyframeTransition.html#clutter-keyframe-transition-set-key-frames" title="clutter_keyframe_transition_set_key_frames ()"><code class="function">clutter_keyframe_transition_set_key_frames()</code></a>,
<a class="link" href="ClutterKeyframeTransition.html#clutter-keyframe-transition-set-modes" title="clutter_keyframe_transition_set_modes ()"><code class="function">clutter_keyframe_transition_set_modes()</code></a>, and
<a class="link" href="ClutterKeyframeTransition.html#clutter-keyframe-transition-set-values" title="clutter_keyframe_transition_set_values ()"><code class="function">clutter_keyframe_transition_set_values()</code></a> instead.</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-keyframe-transition-set.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>transition</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>gtype</p></td>
<td class="parameter_description"><p>the type of the values to use for the key frames</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_key_frames</p></td>
<td class="parameter_description"><p>the number of key frames between the initial
and final values</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>a list of tuples, containing the key frame index, the value
at the key frame, and the animation mode</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-keyframe-transition-set-key-frames"></a><h3>clutter_keyframe_transition_set_key_frames ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_keyframe_transition_set_key_frames
                               (<em class="parameter"><code><a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> *transition</code></em>,
                                <em class="parameter"><code><span class="type">guint</span> n_key_frames</code></em>,
                                <em class="parameter"><code>const <span class="type">double</span> *key_frames</code></em>);</pre>
<p>Sets the keys for each key frame inside <em class="parameter"><code>transition</code></em>
.</p>
<p>If <em class="parameter"><code>transition</code></em>
 does not hold any key frame, <em class="parameter"><code>n_key_frames</code></em>
 key frames
will be created; if <em class="parameter"><code>transition</code></em>
 already has key frames, <em class="parameter"><code>key_frames</code></em>
 must
have at least as many elements as the number of key frames.</p>
<div class="refsect3">
<a name="clutter-keyframe-transition-set-key-frames.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>transition</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_key_frames</p></td>
<td class="parameter_description"><p>the number of values</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key_frames</p></td>
<td class="parameter_description"><p> an array of keys between 0.0
and 1.0, one for each key frame. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_key_frames]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-keyframe-transition-set-modes"></a><h3>clutter_keyframe_transition_set_modes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_keyframe_transition_set_modes (<em class="parameter"><code><a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> *transition</code></em>,
                                       <em class="parameter"><code><span class="type">guint</span> n_modes</code></em>,
                                       <em class="parameter"><code>const <a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> *modes</code></em>);</pre>
<p>Sets the easing modes for each key frame inside <em class="parameter"><code>transition</code></em>
.</p>
<p>If <em class="parameter"><code>transition</code></em>
 does not hold any key frame, <em class="parameter"><code>n_modes</code></em>
 key frames will
be created; if <em class="parameter"><code>transition</code></em>
 already has key frames, <em class="parameter"><code>modes</code></em>
 must have
at least as many elements as the number of key frames.</p>
<div class="refsect3">
<a name="clutter-keyframe-transition-set-modes.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>transition</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_modes</p></td>
<td class="parameter_description"><p>the number of easing modes</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>modes</p></td>
<td class="parameter_description"><p> an array of easing modes, one for
each key frame. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_modes]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-keyframe-transition-set-values"></a><h3>clutter_keyframe_transition_set_values ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_keyframe_transition_set_values
                               (<em class="parameter"><code><a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> *transition</code></em>,
                                <em class="parameter"><code><span class="type">guint</span> n_values</code></em>,
                                <em class="parameter"><code>const <span class="type">GValue</span> *values</code></em>);</pre>
<p>Sets the values for each key frame inside <em class="parameter"><code>transition</code></em>
.</p>
<p>If <em class="parameter"><code>transition</code></em>
 does not hold any key frame, <em class="parameter"><code>n_values</code></em>
 key frames will
be created; if <em class="parameter"><code>transition</code></em>
 already has key frames, <em class="parameter"><code>values</code></em>
 must have
at least as many elements as the number of key frames.</p>
<div class="refsect3">
<a name="clutter-keyframe-transition-set-values.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>transition</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_values</p></td>
<td class="parameter_description"><p>the number of values</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>values</p></td>
<td class="parameter_description"><p> an array of values, one for each
key frame. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_values]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-keyframe-transition-get-n-key-frames"></a><h3>clutter_keyframe_transition_get_n_key_frames ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_keyframe_transition_get_n_key_frames
                               (<em class="parameter"><code><a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> *transition</code></em>);</pre>
<p>Retrieves the number of key frames inside <em class="parameter"><code>transition</code></em>
.</p>
<div class="refsect3">
<a name="clutter-keyframe-transition-get-n-key-frames.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>transition</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-keyframe-transition-get-n-key-frames.returns"></a><h4>Returns</h4>
<p> the number of key frames</p>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-keyframe-transition-set-key-frame"></a><h3>clutter_keyframe_transition_set_key_frame ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_keyframe_transition_set_key_frame
                               (<em class="parameter"><code><a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> *transition</code></em>,
                                <em class="parameter"><code><span class="type">guint</span> index_</code></em>,
                                <em class="parameter"><code><span class="type">double</span> key</code></em>,
                                <em class="parameter"><code><a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> mode</code></em>,
                                <em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
<p>Sets the details of the key frame at <em class="parameter"><code>index_</code></em>
 inside <em class="parameter"><code>transition</code></em>
.</p>
<p>The <em class="parameter"><code>transition</code></em>
 must already have a key frame at <em class="parameter"><code>index_</code></em>
, and <em class="parameter"><code>index_</code></em>

must be smaller than the number of key frames inside <em class="parameter"><code>transition</code></em>
.</p>
<div class="refsect3">
<a name="clutter-keyframe-transition-set-key-frame.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>transition</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index_</p></td>
<td class="parameter_description"><p>the index of the key frame</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>the key of the key frame</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>the easing mode of the key frame</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>a <span class="type">GValue</span> containing the value of the key frame</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-keyframe-transition-get-key-frame"></a><h3>clutter_keyframe_transition_get_key_frame ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_keyframe_transition_get_key_frame
                               (<em class="parameter"><code><a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> *transition</code></em>,
                                <em class="parameter"><code><span class="type">guint</span> index_</code></em>,
                                <em class="parameter"><code><span class="type">double</span> *key</code></em>,
                                <em class="parameter"><code><a class="link" href="ClutterTimeline.html#ClutterAnimationMode" title="enum ClutterAnimationMode"><span class="type">ClutterAnimationMode</span></a> *mode</code></em>,
                                <em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
<p>Retrieves the details of the key frame at <em class="parameter"><code>index_</code></em>
 inside <em class="parameter"><code>transition</code></em>
.</p>
<p>The <em class="parameter"><code>transition</code></em>
 must already have key frames set, and <em class="parameter"><code>index_</code></em>
 must be
smaller than the number of key frames.</p>
<div class="refsect3">
<a name="clutter-keyframe-transition-get-key-frame.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>transition</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index_</p></td>
<td class="parameter_description"><p>the index of the key frame</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p> return location for the key, 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>][<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>mode</p></td>
<td class="parameter_description"><p> return location for the easing mode, 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>][<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>value</p></td>
<td class="parameter_description"><p> a <span class="type">GValue</span> initialized with the type of
the values. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-keyframe-transition-clear"></a><h3>clutter_keyframe_transition_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_keyframe_transition_clear (<em class="parameter"><code><a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a> *transition</code></em>);</pre>
<p>Removes all key frames from <em class="parameter"><code>transition</code></em>
.</p>
<div class="refsect3">
<a name="clutter-keyframe-transition-clear.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>transition</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterKeyframeTransition.html" title="ClutterKeyframeTransition"><span class="type">ClutterKeyframeTransition</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterKeyframeTransition.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterKeyframeTransition-struct"></a><h3>ClutterKeyframeTransition</h3>
<pre class="programlisting">typedef struct _ClutterKeyframeTransition ClutterKeyframeTransition;</pre>
<p>The <code class="literal">ClutterKeyframeTransition</code> structure contains only private
data and should be accessed using the provided API.</p>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterKeyframeTransitionClass"></a><h3>struct ClutterKeyframeTransitionClass</h3>
<pre class="programlisting">struct ClutterKeyframeTransitionClass {
};
</pre>
<p>The <code class="literal">ClutterKeyframeTransitionClass</code> structure contains only
private data.</p>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>