1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>ClutterDeformEffect</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="Clutter Reference Manual">
8 <link rel="up" href="ch06.html" title="Effects">
9 <link rel="prev" href="ClutterShaderEffect.html" title="ClutterShaderEffect">
10 <link rel="next" href="ClutterBlurEffect.html" title="ClutterBlurEffect">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="ClutterShaderEffect.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Clutter Reference Manual</th>
21 <td><a accesskey="n" href="ClutterBlurEffect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#ClutterDeformEffect.synopsis" class="shortcut">Top</a>
26 <a href="#ClutterDeformEffect.description" class="shortcut">Description</a>
28 <a href="#ClutterDeformEffect.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#ClutterDeformEffect.properties" class="shortcut">Properties</a>
33 <div class="refentry">
34 <a name="ClutterDeformEffect"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
37 <h2><span class="refentrytitle"><a name="ClutterDeformEffect.top_of_page"></a>ClutterDeformEffect</span></h2>
38 <p>ClutterDeformEffect — A base class for effects deforming the geometry
41 <td valign="top" align="right"></td>
43 <div class="refsynopsisdiv">
44 <a name="ClutterDeformEffect.synopsis"></a><h2>Synopsis</h2>
45 <pre class="synopsis">struct <a class="link" href="ClutterDeformEffect.html#ClutterDeformEffect-struct" title="struct ClutterDeformEffect">ClutterDeformEffect</a>;
46 struct <a class="link" href="ClutterDeformEffect.html#ClutterDeformEffectClass" title="struct ClutterDeformEffectClass">ClutterDeformEffectClass</a>;
47 <span class="returnvalue">void</span> <a class="link" href="ClutterDeformEffect.html#clutter-deform-effect-set-back-material" title="clutter_deform_effect_set_back_material ()">clutter_deform_effect_set_back_material</a>
48 (<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>,
49 <em class="parameter"><code><span class="type">CoglHandle</span> material</code></em>);
50 <span class="returnvalue">CoglHandle</span> <a class="link" href="ClutterDeformEffect.html#clutter-deform-effect-get-back-material" title="clutter_deform_effect_get_back_material ()">clutter_deform_effect_get_back_material</a>
51 (<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>);
52 <span class="returnvalue">void</span> <a class="link" href="ClutterDeformEffect.html#clutter-deform-effect-set-n-tiles" title="clutter_deform_effect_set_n_tiles ()">clutter_deform_effect_set_n_tiles</a> (<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>,
53 <em class="parameter"><code><span class="type">guint</span> x_tiles</code></em>,
54 <em class="parameter"><code><span class="type">guint</span> y_tiles</code></em>);
55 <span class="returnvalue">void</span> <a class="link" href="ClutterDeformEffect.html#clutter-deform-effect-get-n-tiles" title="clutter_deform_effect_get_n_tiles ()">clutter_deform_effect_get_n_tiles</a> (<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>,
56 <em class="parameter"><code><span class="type">guint</span> *x_tiles</code></em>,
57 <em class="parameter"><code><span class="type">guint</span> *y_tiles</code></em>);
59 <span class="returnvalue">void</span> <a class="link" href="ClutterDeformEffect.html#clutter-deform-effect-invalidate" title="clutter_deform_effect_invalidate ()">clutter_deform_effect_invalidate</a> (<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>);
62 <div class="refsect1">
63 <a name="ClutterDeformEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
64 <pre class="synopsis">
66 +----GInitiallyUnowned
67 +----<a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
68 +----<a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
69 +----<a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect">ClutterOffscreenEffect</a>
70 +----ClutterDeformEffect
71 +----<a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect">ClutterPageTurnEffect</a>
74 <div class="refsect1">
75 <a name="ClutterDeformEffect.properties"></a><h2>Properties</h2>
76 <pre class="synopsis">
77 "<a class="link" href="ClutterDeformEffect.html#ClutterDeformEffect--back-material" title='The "back-material" property'>back-material</a>" <span class="type">CoglHandle</span>* : Read / Write
78 "<a class="link" href="ClutterDeformEffect.html#ClutterDeformEffect--x-tiles" title='The "x-tiles" property'>x-tiles</a>" <span class="type">guint</span> : Read / Write
79 "<a class="link" href="ClutterDeformEffect.html#ClutterDeformEffect--y-tiles" title='The "y-tiles" property'>y-tiles</a>" <span class="type">guint</span> : Read / Write
82 <div class="refsect1">
83 <a name="ClutterDeformEffect.description"></a><h2>Description</h2>
85 <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> is an abstract class providing all the plumbing
86 for creating effects that result in the deformation of an actor's
90 <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> uses offscreen buffers to render the contents of
91 a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> and then the Cogl vertex buffers API to submit the
96 <div class="refsect2">
97 <a name="id640764"></a><h3>Implementing ClutterDeformEffect</h3>
98 <p>Sub-classes of <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> should override the
99 <code class="function"><code class="function">deform_vertex()</code></code> virtual function; this function
100 is called on every vertex that needs to be deformed by the effect.
101 Each passed vertex is an in-out parameter that initially contains the
102 position of the vertex and should be modified according to a specific
103 deformation algorithm.</p>
108 <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> is available since Clutter 1.4
111 <div class="refsect1">
112 <a name="ClutterDeformEffect.details"></a><h2>Details</h2>
113 <div class="refsect2">
114 <a name="ClutterDeformEffect-struct"></a><h3>struct ClutterDeformEffect</h3>
115 <pre class="programlisting">struct ClutterDeformEffect;</pre>
117 The <span class="structname">ClutterDeformEffect</span> structure contains
118 only private data and should be accessed using the provided API
120 <p class="since">Since 1.4</p>
123 <div class="refsect2">
124 <a name="ClutterDeformEffectClass"></a><h3>struct ClutterDeformEffectClass</h3>
125 <pre class="programlisting">struct ClutterDeformEffectClass {
126 void (* deform_vertex) (ClutterDeformEffect *effect,
129 CoglTextureVertex *vertex);
133 The <span class="structname">ClutterDeformEffectClass</span> structure contains
136 <div class="variablelist"><table border="0">
137 <col align="left" valign="top">
139 <td><p><span class="term"><em class="structfield"><code><a name="ClutterDeformEffectClass.deform-vertex"></a>deform_vertex</code></em> ()</span></p></td>
140 <td>virtual function; sub-classes should override this
141 function to compute the deformation of each vertex</td>
144 <p class="since">Since 1.4</p>
147 <div class="refsect2">
148 <a name="clutter-deform-effect-set-back-material"></a><h3>clutter_deform_effect_set_back_material ()</h3>
149 <pre class="programlisting"><span class="returnvalue">void</span> clutter_deform_effect_set_back_material
150 (<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>,
151 <em class="parameter"><code><span class="type">CoglHandle</span> material</code></em>);</pre>
153 Sets the material that should be used when drawing the back face
154 of the actor during a deformation
157 The <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> will take a reference on the material's
160 <div class="variablelist"><table border="0">
161 <col align="left" valign="top">
164 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
165 <td>a <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a>
169 <td><p><span class="term"><em class="parameter"><code>material</code></em> :</span></p></td>
170 <td>a handle to a Cogl material. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
175 <p class="since">Since 1.4</p>
178 <div class="refsect2">
179 <a name="clutter-deform-effect-get-back-material"></a><h3>clutter_deform_effect_get_back_material ()</h3>
180 <pre class="programlisting"><span class="returnvalue">CoglHandle</span> clutter_deform_effect_get_back_material
181 (<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>);</pre>
183 Retrieves the handle to the back face material used by <em class="parameter"><code>effect</code></em>
185 <div class="variablelist"><table border="0">
186 <col align="left" valign="top">
189 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
190 <td>a <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a>
194 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
195 <td>a handle for the material, or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
196 The returned material is owned by the <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> and it
197 should not be freed directly. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
202 <p class="since">Since 1.4</p>
205 <div class="refsect2">
206 <a name="clutter-deform-effect-set-n-tiles"></a><h3>clutter_deform_effect_set_n_tiles ()</h3>
207 <pre class="programlisting"><span class="returnvalue">void</span> clutter_deform_effect_set_n_tiles (<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>,
208 <em class="parameter"><code><span class="type">guint</span> x_tiles</code></em>,
209 <em class="parameter"><code><span class="type">guint</span> y_tiles</code></em>);</pre>
211 Sets the number of horizontal and vertical tiles to be used
212 when applying the effect
215 More tiles allow a finer grained deformation at the expenses
218 <div class="variablelist"><table border="0">
219 <col align="left" valign="top">
222 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
223 <td>a <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a>
227 <td><p><span class="term"><em class="parameter"><code>x_tiles</code></em> :</span></p></td>
228 <td>number of horizontal tiles</td>
231 <td><p><span class="term"><em class="parameter"><code>y_tiles</code></em> :</span></p></td>
232 <td>number of vertical tiles</td>
236 <p class="since">Since 1.4</p>
239 <div class="refsect2">
240 <a name="clutter-deform-effect-get-n-tiles"></a><h3>clutter_deform_effect_get_n_tiles ()</h3>
241 <pre class="programlisting"><span class="returnvalue">void</span> clutter_deform_effect_get_n_tiles (<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>,
242 <em class="parameter"><code><span class="type">guint</span> *x_tiles</code></em>,
243 <em class="parameter"><code><span class="type">guint</span> *y_tiles</code></em>);</pre>
245 Retrieves the number of horizontal and vertical tiles used to sub-divide
246 the actor's geometry during the effect
248 <div class="variablelist"><table border="0">
249 <col align="left" valign="top">
252 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
253 <td>a <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a>
257 <td><p><span class="term"><em class="parameter"><code>x_tiles</code></em> :</span></p></td>
258 <td>return location for the number of horizontal tiles,
259 or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
263 <td><p><span class="term"><em class="parameter"><code>y_tiles</code></em> :</span></p></td>
264 <td>return location for the number of vertical tiles,
265 or <a href="/home/ebassi/gnome3/install/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
270 <p class="since">Since 1.4</p>
273 <div class="refsect2">
274 <a name="clutter-deform-effect-invalidate"></a><h3>clutter_deform_effect_invalidate ()</h3>
275 <pre class="programlisting"><span class="returnvalue">void</span> clutter_deform_effect_invalidate (<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>);</pre>
277 Invalidates the <em class="parameter"><code>effect</code></em>'s vertices and, if it is associated
278 to an actor, it will queue a redraw
280 <div class="variablelist"><table border="0">
281 <col align="left" valign="top">
283 <td><p><span class="term"><em class="parameter"><code>effect</code></em> :</span></p></td>
284 <td>a <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a>
288 <p class="since">Since 1.4</p>
291 <div class="refsect1">
292 <a name="ClutterDeformEffect.property-details"></a><h2>Property Details</h2>
293 <div class="refsect2">
294 <a name="ClutterDeformEffect--back-material"></a><h3>The <code class="literal">"back-material"</code> property</h3>
295 <pre class="programlisting"> "back-material" <span class="type">CoglHandle</span>* : Read / Write</pre>
297 A material to be used when painting the back of the actor
298 to which this effect has been applied
301 By default, no material will be used
303 <p class="since">Since 1.4</p>
306 <div class="refsect2">
307 <a name="ClutterDeformEffect--x-tiles"></a><h3>The <code class="literal">"x-tiles"</code> property</h3>
308 <pre class="programlisting"> "x-tiles" <span class="type">guint</span> : Read / Write</pre>
310 The number of horizontal tiles. The bigger the number, the
313 <p>Allowed values: >= 1</p>
314 <p>Default value: 32</p>
315 <p class="since">Since 1.4</p>
318 <div class="refsect2">
319 <a name="ClutterDeformEffect--y-tiles"></a><h3>The <code class="literal">"y-tiles"</code> property</h3>
320 <pre class="programlisting"> "y-tiles" <span class="type">guint</span> : Read / Write</pre>
322 The number of vertical tiles. The bigger the number, the
325 <p>Allowed values: >= 1</p>
326 <p>Default value: 32</p>
327 <p class="since">Since 1.4</p>
333 Generated by GTK-Doc V1.18.1</div>