1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterDeformEffect: 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="ch06.html" title="Effects">
<link rel="prev" href="ClutterShaderEffect.html" title="ClutterShaderEffect">
<link rel="next" href="ClutterBlurEffect.html" title="ClutterBlurEffect">
<meta name="generator" content="GTK-Doc V1.29 (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="#ClutterDeformEffect.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterDeformEffect.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterDeformEffect.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterShaderEffect.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterBlurEffect.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterDeformEffect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterDeformEffect.top_of_page"></a>ClutterDeformEffect</span></h2>
<p>ClutterDeformEffect — A base class for effects deforming the geometry
of an actor</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterDeformEffect.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CoglHandle</span>
</td>
<td class="function_name">
<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> <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="ClutterDeformEffect.html#clutter-deform-effect-set-n-tiles" title="clutter_deform_effect_set_n_tiles ()">clutter_deform_effect_set_n_tiles</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="ClutterDeformEffect.html#clutter-deform-effect-get-n-tiles" title="clutter_deform_effect_get_n_tiles ()">clutter_deform_effect_get_n_tiles</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="ClutterDeformEffect.html#clutter-deform-effect-invalidate" title="clutter_deform_effect_invalidate ()">clutter_deform_effect_invalidate</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterDeformEffect.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">CoglHandle</span> *</td>
<td class="property_name"><a class="link" href="ClutterDeformEffect.html#ClutterDeformEffect--back-material" title="The “back-material” property">back-material</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="ClutterDeformEffect.html#ClutterDeformEffect--x-tiles" title="The “x-tiles” property">x-tiles</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="ClutterDeformEffect.html#ClutterDeformEffect--y-tiles" title="The “y-tiles” property">y-tiles</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterDeformEffect.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterDeformEffect.html#ClutterDeformEffect-struct" title="struct ClutterDeformEffect">ClutterDeformEffect</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterDeformEffect.html#ClutterDeformEffectClass" title="struct ClutterDeformEffectClass">ClutterDeformEffectClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterDeformEffect.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="ClutterActorMeta.html" title="ClutterActorMeta">ClutterActorMeta</a>
<span class="lineart">╰──</span> <a class="link" href="ClutterEffect.html" title="ClutterEffect">ClutterEffect</a>
<span class="lineart">╰──</span> <a class="link" href="ClutterOffscreenEffect.html" title="ClutterOffscreenEffect">ClutterOffscreenEffect</a>
<span class="lineart">╰──</span> ClutterDeformEffect
<span class="lineart">╰──</span> <a class="link" href="ClutterPageTurnEffect.html" title="ClutterPageTurnEffect">ClutterPageTurnEffect</a>
</pre>
</div>
<div class="refsect1">
<a name="ClutterDeformEffect.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> is an abstract class providing all the plumbing
for creating effects that result in the deformation of an actor's
geometry.</p>
<p><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> uses offscreen buffers to render the contents of
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
geometry to the GPU.</p>
<p><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> is available since Clutter 1.4</p>
<div class="refsect3">
<a name="id-1.5.7.4.7.5"></a><h4>Implementing ClutterDeformEffect</h4>
<p>Sub-classes of <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> should override the
<a class="link" href="ClutterDeformEffect.html#ClutterDeformEffectClass.deform-vertex"><code class="function">ClutterDeformEffectClass.deform_vertex()</code></a> virtual function; this function
is called on every vertex that needs to be deformed by the effect.
Each passed vertex is an in-out parameter that initially contains the
position of the vertex and should be modified according to a specific
deformation algorithm.</p>
</div>
</div>
<div class="refsect1">
<a name="ClutterDeformEffect.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-deform-effect-set-back-material"></a><h3>clutter_deform_effect_set_back_material ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_deform_effect_set_back_material
(<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>,
<em class="parameter"><code><span class="type">CoglHandle</span> material</code></em>);</pre>
<p>Sets the material that should be used when drawing the back face
of the actor during a deformation</p>
<p>The <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> will take a reference on the material's
handle</p>
<div class="refsect3">
<a name="clutter-deform-effect-set-back-material.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>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>material</p></td>
<td class="parameter_description"><p>a handle to a Cogl material. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-deform-effect-get-back-material"></a><h3>clutter_deform_effect_get_back_material ()</h3>
<pre class="programlisting"><span class="returnvalue">CoglHandle</span>
clutter_deform_effect_get_back_material
(<em class="parameter"><code><a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> *effect</code></em>);</pre>
<p>Retrieves the handle to the back face material used by <em class="parameter"><code>effect</code></em>
</p>
<div class="refsect3">
<a name="clutter-deform-effect-get-back-material.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>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-deform-effect-get-back-material.returns"></a><h4>Returns</h4>
<p>a handle for the material, or <code class="literal">NULL</code>.
The returned material is owned by the <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> and it
should not be freed directly. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-deform-effect-set-n-tiles"></a><h3>clutter_deform_effect_set_n_tiles ()</h3>
<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>,
<em class="parameter"><code><span class="type">guint</span> x_tiles</code></em>,
<em class="parameter"><code><span class="type">guint</span> y_tiles</code></em>);</pre>
<p>Sets the number of horizontal and vertical tiles to be used
when applying the effect</p>
<p>More tiles allow a finer grained deformation at the expenses
of computation</p>
<div class="refsect3">
<a name="clutter-deform-effect-set-n-tiles.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>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_tiles</p></td>
<td class="parameter_description"><p>number of horizontal tiles</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y_tiles</p></td>
<td class="parameter_description"><p>number of vertical tiles</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-deform-effect-get-n-tiles"></a><h3>clutter_deform_effect_get_n_tiles ()</h3>
<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>,
<em class="parameter"><code><span class="type">guint</span> *x_tiles</code></em>,
<em class="parameter"><code><span class="type">guint</span> *y_tiles</code></em>);</pre>
<p>Retrieves the number of horizontal and vertical tiles used to sub-divide
the actor's geometry during the effect</p>
<div class="refsect3">
<a name="clutter-deform-effect-get-n-tiles.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>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x_tiles</p></td>
<td class="parameter_description"><p>return location for the number of horizontal tiles,
or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>y_tiles</p></td>
<td class="parameter_description"><p>return location for the number of vertical tiles,
or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-deform-effect-invalidate"></a><h3>clutter_deform_effect_invalidate ()</h3>
<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>
<p>Invalidates the <em class="parameter"><code>effect</code></em>
's vertices and, if it is associated
to an actor, it will queue a redraw</p>
<div class="refsect3">
<a name="clutter-deform-effect-invalidate.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>effect</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterDeformEffect.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterDeformEffect-struct"></a><h3>struct ClutterDeformEffect</h3>
<pre class="programlisting">struct ClutterDeformEffect;</pre>
<p>The <a class="link" href="ClutterDeformEffect.html" title="ClutterDeformEffect"><span class="type">ClutterDeformEffect</span></a> structure contains
only private data and should be accessed using the provided API</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterDeformEffectClass"></a><h3>struct ClutterDeformEffectClass</h3>
<pre class="programlisting">struct ClutterDeformEffectClass {
void (* deform_vertex) (ClutterDeformEffect *effect,
gfloat width,
gfloat height,
CoglTextureVertex *vertex);
};
</pre>
<p>The <a class="link" href="ClutterDeformEffect.html#ClutterDeformEffectClass" title="struct ClutterDeformEffectClass"><span class="type">ClutterDeformEffectClass</span></a> structure contains
only private data</p>
<div class="refsect3">
<a name="ClutterDeformEffectClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterDeformEffectClass.deform-vertex"></a>deform_vertex</code></em> ()</p></td>
<td class="struct_member_description"><p>virtual function; sub-classes should override this
function to compute the deformation of each vertex</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterDeformEffect.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterDeformEffect--back-material"></a><h3>The <code class="literal">“back-material”</code> property</h3>
<pre class="programlisting"> “back-material” <span class="type">CoglHandle</span> *</pre>
<p>A material to be used when painting the back of the actor
to which this effect has been applied</p>
<p>By default, no material will be used</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterDeformEffect--x-tiles"></a><h3>The <code class="literal">“x-tiles”</code> property</h3>
<pre class="programlisting"> “x-tiles” <span class="type">guint</span></pre>
<p>The number of horizontal tiles. The bigger the number, the
smaller the tiles</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 1</p>
<p>Default value: 32</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterDeformEffect--y-tiles"></a><h3>The <code class="literal">“y-tiles”</code> property</h3>
<pre class="programlisting"> “y-tiles” <span class="type">guint</span></pre>
<p>The number of vertical tiles. The bigger the number, the
smaller the tiles</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= 1</p>
<p>Default value: 32</p>
<p class="since">Since: <a class="link" href="ix09.html#api-index-1.4">1.4</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>
|
