RubyGems - clutter - Versions diffs - 2.0.0-x86-mingw32 - Mend

clutter 2.0.0-x86-mingw32

Files changed (656) hide show

data/vendor/local/share/gtk-doc/html/clutter/ClutterOffscreenEffect.html ADDED Viewed

@@ -0,0 +1,350 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>ClutterOffscreenEffect</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<link rel="home" href="index.html" title="Clutter Reference Manual">
+<link rel="up" href="ch06.html" title="Effects">
+<link rel="prev" href="ch06.html" title="Effects">
+<link rel="next" href="ClutterShaderEffect.html" title="ClutterShaderEffect">
+<meta name="generator" content="GTK-Doc V1.18.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="2">
+<tr valign="middle">
+<td><a accesskey="p" href="ch06.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">Clutter Reference Manual</th>
+<td><a accesskey="n" href="ClutterShaderEffect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#ClutterOffscreenEffect.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#ClutterOffscreenEffect.description" class="shortcut">Description</a>
+                   |
+                  <a href="#ClutterOffscreenEffect.object-hierarchy" class="shortcut">Object Hierarchy</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="ClutterOffscreenEffect"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterOffscreenEffect.top_of_page"></a>ClutterOffscreenEffect</span></h2>
+<p>ClutterOffscreenEffect — Base class for effects using offscreen buffers</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="ClutterOffscreenEffect.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">struct              <a class="link" href="ClutterOffscreenEffect.html#ClutterOffscreenEffect-struct" title="struct ClutterOffscreenEffect">ClutterOffscreenEffect</a>;
+struct              <a class="link" href="ClutterOffscreenEffect.html#ClutterOffscreenEffectClass" title="struct ClutterOffscreenEffectClass">ClutterOffscreenEffectClass</a>;
+<span class="returnvalue">CoglMaterial</span> *      <a class="link" href="ClutterOffscreenEffect.html#clutter-offscreen-effect-get-target" title="clutter_offscreen_effect_get_target ()">clutter_offscreen_effect_get_target</a> (<em class="parameter"><code><a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> *effect</code></em>);
+<span class="returnvalue">CoglHandle</span>          <a class="link" href="ClutterOffscreenEffect.html#clutter-offscreen-effect-get-texture" title="clutter_offscreen_effect_get_texture ()">clutter_offscreen_effect_get_texture</a>
+                                                        (<em class="parameter"><code><a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> *effect</code></em>);
+<span class="returnvalue">CoglHandle</span>          <a class="link" href="ClutterOffscreenEffect.html#clutter-offscreen-effect-create-texture" title="clutter_offscreen_effect_create_texture ()">clutter_offscreen_effect_create_texture</a>
+                                                        (<em class="parameter"><code><a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> width</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> height</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterOffscreenEffect.html#clutter-offscreen-effect-paint-target" title="clutter_offscreen_effect_paint_target ()">clutter_offscreen_effect_paint_target</a>
+                                                        (<em class="parameter"><code><a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> *effect</code></em>);
+<span class="returnvalue">gboolean</span>            <a class="link" href="ClutterOffscreenEffect.html#clutter-offscreen-effect-get-target-size" title="clutter_offscreen_effect_get_target_size ()">clutter_offscreen_effect_get_target_size</a>
+                                                        (<em class="parameter"><code><a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *width</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *height</code></em>);
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterOffscreenEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="synopsis">
+  GObject
+   +----GInitiallyUnowned
+         +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
+               +----<a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
+                     +----ClutterOffscreenEffect
+                           +----<a class="link" href="ClutterBlurEffect.html" title="ClutterBlurEffect">ClutterBlurEffect</a>
+                           +----<a class="link" href="ClutterBrightnessContrastEffect.html" title="ClutterBrightnessContrastEffect">ClutterBrightnessContrastEffect</a>
+                           +----<a class="link" href="ClutterColorizeEffect.html" title="ClutterColorizeEffect">ClutterColorizeEffect</a>
+                           +----<a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect">ClutterDeformEffect</a>
+                           +----<a class="link" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect">ClutterDesaturateEffect</a>
+                           +----<a class="link" href="ClutterShaderEffect.html" title="ClutterShaderEffect">ClutterShaderEffect</a>
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterOffscreenEffect.description"></a><h2>Description</h2>
+<p>
+<a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> is an abstract class that can be used by
+<a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a> sub-classes requiring access to an offscreen buffer.
+</p>
+<p>
+Some effects, like the fragment shader based effects, can only use GL
+textures, and in order to apply those effects to any kind of actor they
+require that all drawing operations are applied to an offscreen framebuffer
+that gets redirected to a texture.
+</p>
+<p>
+<a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> provides all the heavy-lifting for creating the
+offscreen framebuffer, the redirection and the final paint of the texture on
+the desired stage.
+</p>
+<p>
+</p>
+<div class="refsect2">
+<a name="ClutterOffscreenEffect-implementing"></a><h3>Implementing a ClutterOffscreenEffect</h3>
+<p>Creating a sub-class of <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> requires, in case
+  of overriding the <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a> virtual functions, to chain up to the
+  <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a>'s implementation.</p>
+<p>On top of the <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a>'s virtual functions,
+  <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> also provides a <a class="link" href="ClutterOffscreenEffect.html#ClutterOffscreenEffectClass.paint-target"><code class="function">ClutterOffscreenEffectClass.paint_target()</code></a>
+  function, which encapsulates the effective painting of the texture that
+  contains the result of the offscreen redirection.</p>
+<p>The size of the target material is defined to be as big as the
+  transformed size of the <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> using the offscreen effect.
+  Sub-classes of <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> can change the texture creation
+  code to provide bigger textures by overriding the
+  <a class="link" href="ClutterOffscreenEffect.html#ClutterOffscreenEffectClass.create-texture"><code class="function">ClutterOffscreenEffectClass.create_texture()</code></a> virtual function; no chain up
+  to the <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> implementation is required in this
+  case.</p>
+</div>
+<p>
+</p>
+<p>
+<a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> is available since Clutter 1.4
+</p>
+</div>
+<div class="refsect1">
+<a name="ClutterOffscreenEffect.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="ClutterOffscreenEffect-struct"></a><h3>struct ClutterOffscreenEffect</h3>
+<pre class="programlisting">struct ClutterOffscreenEffect;</pre>
+<p>
+The <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> structure contains only private data
+and should be accessed using the provided API
+</p>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterOffscreenEffectClass"></a><h3>struct ClutterOffscreenEffectClass</h3>
+<pre class="programlisting">struct ClutterOffscreenEffectClass {
+  CoglHandle (* create_texture) (ClutterOffscreenEffect *effect,
+                                 gfloat                  width,
+                                 gfloat                  height);
+  void       (* paint_target)   (ClutterOffscreenEffect *effect);
+};
+</pre>
+<p>
+The <a class="link" href="ClutterOffscreenEffect.html#ClutterOffscreenEffectClass" title="struct ClutterOffscreenEffectClass"><span class="type">ClutterOffscreenEffectClass</span></a> structure contains only private data
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="structfield"><code><a name="ClutterOffscreenEffectClass.create-texture"></a>create_texture</code></em> ()</span></p></td>
+<td>virtual function</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="structfield"><code><a name="ClutterOffscreenEffectClass.paint-target"></a>paint_target</code></em> ()</span></p></td>
+<td>virtual function</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-offscreen-effect-get-target"></a><h3>clutter_offscreen_effect_get_target ()</h3>
+<pre class="programlisting"><span class="returnvalue">CoglMaterial</span> *      clutter_offscreen_effect_get_target (<em class="parameter"><code><a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> *effect</code></em>);</pre>
+<p>
+Retrieves the material used as a render target for the offscreen
+buffer created by <em class="parameter"><code>effect</code></em>
+</p>
+<p>
+You should only use the returned <span class="type">CoglMaterial</span> when painting. The
+returned material might change between different frames.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>a <span class="type">CoglMaterial</span> or <code class="literal">NULL</code>. The
+returned material is owned by Clutter and it should not be
+modified or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-offscreen-effect-get-texture"></a><h3>clutter_offscreen_effect_get_texture ()</h3>
+<pre class="programlisting"><span class="returnvalue">CoglHandle</span>          clutter_offscreen_effect_get_texture
+                                                        (<em class="parameter"><code><a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> *effect</code></em>);</pre>
+<p>
+Retrieves the texture used as a render target for the offscreen
+buffer created by <em class="parameter"><code>effect</code></em>
+</p>
+<p>
+You should only use the returned texture when painting. The texture
+may change after ClutterEffect::pre_paint is called so the effect
+implementation should update any references to the texture after
+chaining-up to the parent's pre_paint implementation. This can be
+used instead of <a class="link" href="ClutterOffscreenEffect.html#clutter-offscreen-effect-get-target" title="clutter_offscreen_effect_get_target ()"><code class="function">clutter_offscreen_effect_get_target()</code></a> when the
+effect subclass wants to paint using its own material.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>a <span class="type">CoglHandle</span> or <code class="literal">COGL_INVALID_HANDLE</code>. The
+returned texture is owned by Clutter and it should not be
+modified or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.10</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-offscreen-effect-create-texture"></a><h3>clutter_offscreen_effect_create_texture ()</h3>
+<pre class="programlisting"><span class="returnvalue">CoglHandle</span>          clutter_offscreen_effect_create_texture
+                                                        (<em class="parameter"><code><a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> width</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> height</code></em>);</pre>
+<p>
+Calls the <code class="function">create_texture()</code> virtual function of the <em class="parameter"><code>effect</code></em>
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
+<td>the minimum width of the target texture</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
+<td>the minimum height of the target texture</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>a handle to a Cogl texture, or
+<code class="literal">COGL_INVALID_HANDLE</code>. The returned handle has its reference
+count increased. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-offscreen-effect-paint-target"></a><h3>clutter_offscreen_effect_paint_target ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_offscreen_effect_paint_target
+                                                        (<em class="parameter"><code><a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> *effect</code></em>);</pre>
+<p>
+Calls the <code class="function">paint_target()</code> virtual function of the <em class="parameter"><code>effect</code></em>
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody><tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a>
+</td>
+</tr></tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-offscreen-effect-get-target-size"></a><h3>clutter_offscreen_effect_get_target_size ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_offscreen_effect_get_target_size
+                                                        (<em class="parameter"><code><a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *width</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> *height</code></em>);</pre>
+<p>
+Retrieves the size of the offscreen buffer used by <em class="parameter"><code>effect</code></em> to
+paint the actor to which it has been applied.
+</p>
+<p>
+This function should only be called by <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a>
+implementations, from within the <code class="function"><code class="function">paint_target()</code></code>
+virtual function.
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect"><span class="type">ClutterOffscreenEffect</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
+<td>return location for the target width, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
+<td>return location for the target height, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>
+<code class="literal">TRUE</code> if the offscreen buffer has a valid size,
+and <code class="literal">FALSE</code> otherwise</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.8</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterOffscreenEffect.see-also"></a><h2>See Also</h2>
+<a class="link" href="ClutterBlurEffect.html" title="ClutterBlurEffect"><span class="type">ClutterBlurEffect</span></a>, <a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="type">ClutterEffect</span></a>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.18.1</div>
+</body>
+</html>

data/vendor/local/share/gtk-doc/html/clutter/ClutterPageTurnEffect.html ADDED Viewed

@@ -0,0 +1,333 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>ClutterPageTurnEffect</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
+<link rel="home" href="index.html" title="Clutter Reference Manual">
+<link rel="up" href="ch06.html" title="Effects">
+<link rel="prev" href="ClutterDesaturateEffect.html" title="ClutterDesaturateEffect">
+<link rel="next" href="ch07.html" title="Content">
+<meta name="generator" content="GTK-Doc V1.18.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="2">
+<tr valign="middle">
+<td><a accesskey="p" href="ClutterDesaturateEffect.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
+<th width="100%" align="center">Clutter Reference Manual</th>
+<td><a accesskey="n" href="ch07.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#ClutterPageTurnEffect.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#ClutterPageTurnEffect.description" class="shortcut">Description</a>
+                   |
+                  <a href="#ClutterPageTurnEffect.object-hierarchy" class="shortcut">Object Hierarchy</a>
+                   |
+                  <a href="#ClutterPageTurnEffect.properties" class="shortcut">Properties</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="ClutterPageTurnEffect"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="ClutterPageTurnEffect.top_of_page"></a>ClutterPageTurnEffect</span></h2>
+<p>ClutterPageTurnEffect — A page turning effect</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="ClutterPageTurnEffect.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">                    <a class="link" href="ClutterPageTurnEffect.html#ClutterPageTurnEffect-struct" title="ClutterPageTurnEffect">ClutterPageTurnEffect</a>;
+<a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> *     <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-new" title="clutter_page_turn_effect_new ()">clutter_page_turn_effect_new</a>        (<em class="parameter"><code><span class="type">gdouble</span> period</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> angle</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> radius</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-set-period" title="clutter_page_turn_effect_set_period ()">clutter_page_turn_effect_set_period</a> (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> period</code></em>);
+<span class="returnvalue">gdouble</span>             <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-get-period" title="clutter_page_turn_effect_get_period ()">clutter_page_turn_effect_get_period</a> (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-set-angle" title="clutter_page_turn_effect_set_angle ()">clutter_page_turn_effect_set_angle</a>  (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> angle</code></em>);
+<span class="returnvalue">gdouble</span>             <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-get-angle" title="clutter_page_turn_effect_get_angle ()">clutter_page_turn_effect_get_angle</a>  (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-set-radius" title="clutter_page_turn_effect_set_radius ()">clutter_page_turn_effect_set_radius</a> (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> radius</code></em>);
+<span class="returnvalue">gfloat</span>              <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-get-radius" title="clutter_page_turn_effect_get_radius ()">clutter_page_turn_effect_get_radius</a> (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterPageTurnEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="synopsis">
+  GObject
+   +----GInitiallyUnowned
+         +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
+               +----<a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
+                     +----<a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect">ClutterOffscreenEffect</a>
+                           +----<a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect">ClutterDeformEffect</a>
+                                 +----ClutterPageTurnEffect
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterPageTurnEffect.properties"></a><h2>Properties</h2>
+<pre class="synopsis">
+  "<a class="link" href="ClutterPageTurnEffect.html#ClutterPageTurnEffect--angle" title='The "angle" property'>angle</a>"                    <span class="type">gdouble</span>               : Read / Write
+  "<a class="link" href="ClutterPageTurnEffect.html#ClutterPageTurnEffect--period" title='The "period" property'>period</a>"                   <span class="type">gdouble</span>               : Read / Write
+  "<a class="link" href="ClutterPageTurnEffect.html#ClutterPageTurnEffect--radius" title='The "radius" property'>radius</a>"                   <span class="type">gfloat</span>                : Read / Write
+</pre>
+</div>
+<div class="refsect1">
+<a name="ClutterPageTurnEffect.description"></a><h2>Description</h2>
+<p>
+A simple page turning effect
+</p>
+<p>
+<a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> is available since Clutter 1.4
+</p>
+</div>
+<div class="refsect1">
+<a name="ClutterPageTurnEffect.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="ClutterPageTurnEffect-struct"></a><h3>ClutterPageTurnEffect</h3>
+<pre class="programlisting">typedef struct _ClutterPageTurnEffect ClutterPageTurnEffect;</pre>
+<p>
+<span class="structname">ClutterPageTurnEffect</span> is an opaque structure
+whose members can only be accessed using the provided API
+</p>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-page-turn-effect-new"></a><h3>clutter_page_turn_effect_new ()</h3>
+<pre class="programlisting"><a class="link" href="ClutterEffect.html" title="ClutterEffect"><span class="returnvalue">ClutterEffect</span></a> *     clutter_page_turn_effect_new        (<em class="parameter"><code><span class="type">gdouble</span> period</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> angle</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> radius</code></em>);</pre>
+<p>
+Creates a new <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> instance with the given parameters
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>period</code></em> :</span></p></td>
+<td>the period of the page curl, between 0.0 and 1.0</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
+<td>the angle of the page curl, between 0.0 and 360.0</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>radius</code></em> :</span></p></td>
+<td>the radius of the page curl, in pixels</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>the newly created <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-page-turn-effect-set-period"></a><h3>clutter_page_turn_effect_set_period ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_page_turn_effect_set_period (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> period</code></em>);</pre>
+<p>
+Sets the period of the page curling, between 0.0 (no curling)
+and 1.0 (fully curled)
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>period</code></em> :</span></p></td>
+<td>the period of the page curl, between 0.0 and 1.0</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-page-turn-effect-get-period"></a><h3>clutter_page_turn_effect_get_period ()</h3>
+<pre class="programlisting"><span class="returnvalue">gdouble</span>             clutter_page_turn_effect_get_period (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);</pre>
+<p>
+Retrieves the value set using <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-get-period" title="clutter_page_turn_effect_get_period ()"><code class="function">clutter_page_turn_effect_get_period()</code></a>
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>the period of the page curling</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-page-turn-effect-set-angle"></a><h3>clutter_page_turn_effect_set_angle ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_page_turn_effect_set_angle  (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><span class="type">gdouble</span> angle</code></em>);</pre>
+<p>
+Sets the angle of the page curling, in degrees
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a></td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
+<td>the angle of the page curl, in degrees</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-page-turn-effect-get-angle"></a><h3>clutter_page_turn_effect_get_angle ()</h3>
+<pre class="programlisting"><span class="returnvalue">gdouble</span>             clutter_page_turn_effect_get_angle  (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);</pre>
+<p>
+Retrieves the value set using <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-get-angle" title="clutter_page_turn_effect_get_angle ()"><code class="function">clutter_page_turn_effect_get_angle()</code></a>
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>:</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>the angle of the page curling</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-page-turn-effect-set-radius"></a><h3>clutter_page_turn_effect_set_radius ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                clutter_page_turn_effect_set_radius (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>,
+                                                         <em class="parameter"><code><span class="type">gfloat</span> radius</code></em>);</pre>
+<p>
+Sets the radius of the page curling
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>:</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>radius</code></em> :</span></p></td>
+<td>the radius of the page curling, in pixels</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="clutter-page-turn-effect-get-radius"></a><h3>clutter_page_turn_effect_get_radius ()</h3>
+<pre class="programlisting"><span class="returnvalue">gfloat</span>              clutter_page_turn_effect_get_radius (<em class="parameter"><code><a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a> *effect</code></em>);</pre>
+<p>
+Retrieves the value set using <a class="link" href="ClutterPageTurnEffect.html#clutter-page-turn-effect-set-radius" title="clutter_page_turn_effect_set_radius ()"><code class="function">clutter_page_turn_effect_set_radius()</code></a>
+</p>
+<div class="variablelist"><table border="0" class="variablelist">
+<colgroup>
+<col align="left" valign="top">
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
+<td>a <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect"><span class="type">ClutterPageTurnEffect</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td>the radius of the page curling</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 1.4</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="ClutterPageTurnEffect.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="ClutterPageTurnEffect--angle"></a><h3>The <code class="literal">"angle"</code> property</h3>
+<pre class="programlisting">  "angle"                    <span class="type">gdouble</span>               : Read / Write</pre>
+<p>
+The angle of the page rotation, in degrees, between 0.0 and 360.0
+</p>
+<p>Allowed values: [0,360]</p>
+<p>Default value: 0</p>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterPageTurnEffect--period"></a><h3>The <code class="literal">"period"</code> property</h3>
+<pre class="programlisting">  "period"                   <span class="type">gdouble</span>               : Read / Write</pre>
+<p>
+The period of the page turn, between 0.0 (no curling) and
+1.0 (fully curled)
+</p>
+<p>Allowed values: [0,1]</p>
+<p>Default value: 0</p>
+<p class="since">Since 1.4</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="ClutterPageTurnEffect--radius"></a><h3>The <code class="literal">"radius"</code> property</h3>
+<pre class="programlisting">  "radius"                   <span class="type">gfloat</span>                : Read / Write</pre>
+<p>
+The radius of the page curl, in pixels
+</p>
+<p>Default value: 24</p>
+<p class="since">Since 1.4</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.18.1</div>
+</body>
+</html>