/usr/share/doc/libmx-doc/html/mx/MxDeformTexture.html is in libmx-doc 1.4.7-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MxDeformTexture</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Mx Toolkit Reference Manual">
<link rel="up" href="ch06.html" title="Abstract Types and Utilities">
<link rel="prev" href="MxClipboard.html" title="MxClipboard">
<link rel="next" href="MxFocusManager.html" title="MxFocusManager">
<meta name="generator" content="GTK-Doc V1.19 (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="MxClipboard.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">Mx Toolkit Reference Manual</th>
<td><a accesskey="n" href="MxFocusManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#MxDeformTexture.synopsis" class="shortcut">Top</a>
|
<a href="#MxDeformTexture.description" class="shortcut">Description</a>
|
<a href="#MxDeformTexture.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#MxDeformTexture.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#MxDeformTexture.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="MxDeformTexture"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="MxDeformTexture.top_of_page"></a>MxDeformTexture</span></h2>
<p>MxDeformTexture — Deformable texture abstract-widget</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="MxDeformTexture.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="MxDeformTexture.html#MxDeformTexture-struct" title="struct MxDeformTexture">MxDeformTexture</a>;
struct <a class="link" href="MxDeformTexture.html#MxDeformTextureClass" title="struct MxDeformTextureClass">MxDeformTextureClass</a>;
<span class="returnvalue">void</span> <a class="link" href="MxDeformTexture.html#mx-deform-texture-get-resolution" title="mx_deform_texture_get_resolution ()">mx_deform_texture_get_resolution</a> (<em class="parameter"><code><a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gint</span> *tiles_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *tiles_y</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MxDeformTexture.html#mx-deform-texture-set-resolution" title="mx_deform_texture_set_resolution ()">mx_deform_texture_set_resolution</a> (<em class="parameter"><code><a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gint</span> tiles_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> tiles_y</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MxDeformTexture.html#mx-deform-texture-set-textures" title="mx_deform_texture_set_textures ()">mx_deform_texture_set_textures</a> (<em class="parameter"><code><a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">ClutterTexture</span> *front</code></em>,
<em class="parameter"><code><span class="type">ClutterTexture</span> *back</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MxDeformTexture.html#mx-deform-texture-get-textures" title="mx_deform_texture_get_textures ()">mx_deform_texture_get_textures</a> (<em class="parameter"><code><a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">ClutterTexture</span> **front</code></em>,
<em class="parameter"><code><span class="type">ClutterTexture</span> **back</code></em>);
<span class="returnvalue">void</span> <a class="link" href="MxDeformTexture.html#mx-deform-texture-invalidate" title="mx_deform_texture_invalidate ()">mx_deform_texture_invalidate</a> (<em class="parameter"><code><a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a> *texture</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="MxDeformTexture.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----ClutterActor
+----<a class="link" href="MxWidget.html" title="MxWidget">MxWidget</a>
+----MxDeformTexture
+----<a class="link" href="MxDeformBowTie.html" title="MxDeformBowTie">MxDeformBowTie</a>
+----<a class="link" href="MxDeformPageTurn.html" title="MxDeformPageTurn">MxDeformPageTurn</a>
+----<a class="link" href="MxDeformWaves.html" title="MxDeformWaves">MxDeformWaves</a>
</pre>
</div>
<div class="refsect1">
<a name="MxDeformTexture.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
MxDeformTexture implements
ClutterContainer, ClutterScriptable, ClutterAnimatable, AtkImplementorIface and <a class="link" href="MxStylable.html" title="MxStylable">MxStylable</a>.</p>
</div>
<div class="refsect1">
<a name="MxDeformTexture.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="MxDeformTexture.html#MxDeformTexture--back" title='The "back" property'>back</a>" <span class="type">ClutterTexture</span>* : Read / Write
"<a class="link" href="MxDeformTexture.html#MxDeformTexture--front" title='The "front" property'>front</a>" <span class="type">ClutterTexture</span>* : Read / Write
"<a class="link" href="MxDeformTexture.html#MxDeformTexture--tiles-x" title='The "tiles-x" property'>tiles-x</a>" <span class="type">gint</span> : Read / Write
"<a class="link" href="MxDeformTexture.html#MxDeformTexture--tiles-y" title='The "tiles-y" property'>tiles-y</a>" <span class="type">gint</span> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="MxDeformTexture.description"></a><h2>Description</h2>
<p>
An abstract widget that provides the interface for producing mesh
deformation effects with a texture.
</p>
</div>
<div class="refsect1">
<a name="MxDeformTexture.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="MxDeformTexture-struct"></a><h3>struct MxDeformTexture</h3>
<pre class="programlisting">struct MxDeformTexture;</pre>
<p>
The contents of this structure is private and should only be accessed using
the provided API.
</p>
</div>
<hr>
<div class="refsect2">
<a name="MxDeformTextureClass"></a><h3>struct MxDeformTextureClass</h3>
<pre class="programlisting">struct MxDeformTextureClass {
MxWidgetClass parent_class;
/* vfuncs */
void (*deform) (MxDeformTexture *texture,
CoglTextureVertex *vertex,
gfloat width,
gfloat height);
/* padding for future expansion */
void (*_padding_0) (void);
void (*_padding_1) (void);
void (*_padding_2) (void);
void (*_padding_3) (void);
void (*_padding_4) (void);
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="mx-deform-texture-get-resolution"></a><h3>mx_deform_texture_get_resolution ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_deform_texture_get_resolution (<em class="parameter"><code><a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gint</span> *tiles_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *tiles_y</code></em>);</pre>
<p>
Retrieve the mesh resolution of the texture.
See <a class="link" href="MxDeformTexture.html#mx-deform-texture-set-resolution" title="mx_deform_texture_set_resolution ()"><code class="function">mx_deform_texture_set_resolution()</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>texture</code></em> :</span></p></td>
<td>A <a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tiles_x</code></em> :</span></p></td>
<td>The horizontal resolution. <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><p><span class="term"><em class="parameter"><code>tiles_y</code></em> :</span></p></td>
<td>The vertical resolution. <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>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-deform-texture-set-resolution"></a><h3>mx_deform_texture_set_resolution ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_deform_texture_set_resolution (<em class="parameter"><code><a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">gint</span> tiles_x</code></em>,
<em class="parameter"><code><span class="type">gint</span> tiles_y</code></em>);</pre>
<p>
Sets the amount of sub-divisions used on each axis when generating
the mesh, where a value of 1 for each axis will produce a single quad.
</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>texture</code></em> :</span></p></td>
<td>A <a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tiles_x</code></em> :</span></p></td>
<td>The horizontal resolution</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tiles_y</code></em> :</span></p></td>
<td>The vertical resolution</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="mx-deform-texture-set-textures"></a><h3>mx_deform_texture_set_textures ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_deform_texture_set_textures (<em class="parameter"><code><a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">ClutterTexture</span> *front</code></em>,
<em class="parameter"><code><span class="type">ClutterTexture</span> *back</code></em>);</pre>
<p>
Set textures to use as the sources of a deformation effect. Textures
must not be parented.
</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>texture</code></em> :</span></p></td>
<td>an <a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>front</code></em> :</span></p></td>
<td>
<span class="type">ClutterTexture</span> to use for the front-face. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>back</code></em> :</span></p></td>
<td>
<span class="type">ClutterTexture</span> to use for the back-face. <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>
<hr>
<div class="refsect2">
<a name="mx-deform-texture-get-textures"></a><h3>mx_deform_texture_get_textures ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_deform_texture_get_textures (<em class="parameter"><code><a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a> *texture</code></em>,
<em class="parameter"><code><span class="type">ClutterTexture</span> **front</code></em>,
<em class="parameter"><code><span class="type">ClutterTexture</span> **back</code></em>);</pre>
<p>
Retrieves the textures used by <em class="parameter"><code>texture</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>texture</code></em> :</span></p></td>
<td>A <a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>front</code></em> :</span></p></td>
<td>The front-facing texture. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</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><p><span class="term"><em class="parameter"><code>back</code></em> :</span></p></td>
<td>The back-facing texture. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<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>
<hr>
<div class="refsect2">
<a name="mx-deform-texture-invalidate"></a><h3>mx_deform_texture_invalidate ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> mx_deform_texture_invalidate (<em class="parameter"><code><a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a> *texture</code></em>);</pre>
<p>
Make <em class="parameter"><code>texture</code></em> re-calculate its vertices and redraw itself.
</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>texture</code></em> :</span></p></td>
<td>A <a class="link" href="MxDeformTexture.html" title="MxDeformTexture"><span class="type">MxDeformTexture</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="MxDeformTexture.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="MxDeformTexture--back"></a><h3>The <code class="literal">"back"</code> property</h3>
<pre class="programlisting"> "back" <span class="type">ClutterTexture</span>* : Read / Write</pre>
<p>ClutterTexture to use for the back-face.</p>
</div>
<hr>
<div class="refsect2">
<a name="MxDeformTexture--front"></a><h3>The <code class="literal">"front"</code> property</h3>
<pre class="programlisting"> "front" <span class="type">ClutterTexture</span>* : Read / Write</pre>
<p>ClutterTexture to use for the front-face.</p>
</div>
<hr>
<div class="refsect2">
<a name="MxDeformTexture--tiles-x"></a><h3>The <code class="literal">"tiles-x"</code> property</h3>
<pre class="programlisting"> "tiles-x" <span class="type">gint</span> : Read / Write</pre>
<p>Amount of horizontal tiles to split the texture into.</p>
<p>Allowed values: >= 1</p>
<p>Default value: 32</p>
</div>
<hr>
<div class="refsect2">
<a name="MxDeformTexture--tiles-y"></a><h3>The <code class="literal">"tiles-y"</code> property</h3>
<pre class="programlisting"> "tiles-y" <span class="type">gint</span> : Read / Write</pre>
<p>Amount of vertical tiles to split the texture into.</p>
<p>Allowed values: >= 1</p>
<p>Default value: 32</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|