/usr/share/gtk-doc/html/libg3d/libg3d-matrix.html is in libg3d-doc 0.0.8-17ubuntu1.
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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>matrix</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libg3d Reference Manual">
<link rel="up" href="ch02.html" title="Plugin interface">
<link rel="prev" href="libg3d-primitive.html" title="primitive">
<link rel="next" href="libg3d-vector.html" title="vector">
<meta name="generator" content="GTK-Doc V1.18 (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="libg3d-primitive.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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">libg3d Reference Manual</th>
<td><a accesskey="n" href="libg3d-vector.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libg3d-matrix.synopsis" class="shortcut">Top</a>
|
<a href="#libg3d-matrix.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libg3d-matrix"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libg3d-matrix.top_of_page"></a>matrix</span></h2>
<p>matrix — Matrix manipulation and calculation</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libg3d-matrix.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <g3d/matrix.h>
typedef <a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix">G3DMatrix</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-matrix.html#g3d-matrix-identity" title="g3d_matrix_identity ()">g3d_matrix_identity</a> (<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *matrix</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-matrix.html#g3d-matrix-multiply" title="g3d_matrix_multiply ()">g3d_matrix_multiply</a> (<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *m1</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *m2</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *rm</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-matrix.html#g3d-matrix-translate" title="g3d_matrix_translate ()">g3d_matrix_translate</a> (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> x</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> y</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> z</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *rm</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-matrix.html#g3d-matrix-rotate" title="g3d_matrix_rotate ()">g3d_matrix_rotate</a> (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> angle</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> ax</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> ay</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> az</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *rm</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-matrix.html#g3d-matrix-rotate-xyz" title="g3d_matrix_rotate_xyz ()">g3d_matrix_rotate_xyz</a> (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> rx</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> ry</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> rz</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *rm</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-matrix.html#g3d-matrix-scale" title="g3d_matrix_scale ()">g3d_matrix_scale</a> (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> x</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> y</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> z</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *rm</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-matrix.html#g3d-matrix-transpose" title="g3d_matrix_transpose ()">g3d_matrix_transpose</a> (<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *matrix</code></em>);
<a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="returnvalue">G3DFloat</span></a> <a class="link" href="libg3d-matrix.html#g3d-matrix-determinant" title="g3d_matrix_determinant ()">g3d_matrix_determinant</a> (<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *matrix</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libg3d-matrix.html#g3d-matrix-dump" title="g3d_matrix_dump ()">g3d_matrix_dump</a> (<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *matrix</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libg3d-matrix.description"></a><h2>Description</h2>
<p>
Matrices in libg3d have the following layout:
</p>
<p>
G3DMatrix matrix[16]:
</p>
<p>
matrix[col * 4 + row] = f;
</p>
</div>
<div class="refsect1">
<a name="libg3d-matrix.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="G3DMatrix"></a><h3>G3DMatrix</h3>
<pre class="programlisting">typedef G3DFloat G3DMatrix;
</pre>
<p>
Matrix element type.
</p>
</div>
<hr>
<div class="refsect2">
<a name="g3d-matrix-identity"></a><h3>g3d_matrix_identity ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_matrix_identity (<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *matrix</code></em>);</pre>
<p>
Sets the given matrix to the identity matrix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
<td>4x4 matrix (float[16])</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-matrix-multiply"></a><h3>g3d_matrix_multiply ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_matrix_multiply (<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *m1</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *m2</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *rm</code></em>);</pre>
<p>
Multiplies the matrixes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>m1</code></em> :</span></p></td>
<td>first matrix</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>m2</code></em> :</span></p></td>
<td>second matrix</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rm</code></em> :</span></p></td>
<td>resulting matrix</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-matrix-translate"></a><h3>g3d_matrix_translate ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_matrix_translate (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> x</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> y</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> z</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *rm</code></em>);</pre>
<p>
Adds a translation to the the matrix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>x translation</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>y translation</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>z</code></em> :</span></p></td>
<td>z translation</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rm</code></em> :</span></p></td>
<td>resulting matrix</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-matrix-rotate"></a><h3>g3d_matrix_rotate ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_matrix_rotate (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> angle</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> ax</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> ay</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> az</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *rm</code></em>);</pre>
<p>
Adds a rotation to the matrix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>angle</code></em> :</span></p></td>
<td>rotation angle</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ax</code></em> :</span></p></td>
<td>x component of rotation axis</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ay</code></em> :</span></p></td>
<td>y component of rotation axis</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>az</code></em> :</span></p></td>
<td>z component of rotation axis</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rm</code></em> :</span></p></td>
<td>resulting matrix</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-matrix-rotate-xyz"></a><h3>g3d_matrix_rotate_xyz ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_matrix_rotate_xyz (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> rx</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> ry</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> rz</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *rm</code></em>);</pre>
<p>
Adds a rotation around the 3 coordinate system axes to the matrix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>rx</code></em> :</span></p></td>
<td>rotation around x axis</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ry</code></em> :</span></p></td>
<td>rotation around y axis</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rz</code></em> :</span></p></td>
<td>rotation around z axis</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rm</code></em> :</span></p></td>
<td>resulting matrix</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-matrix-scale"></a><h3>g3d_matrix_scale ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_matrix_scale (<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> x</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> y</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="type">G3DFloat</span></a> z</code></em>,
<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *rm</code></em>);</pre>
<p>
Adds a scaling to the matrix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
<td>x factor</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
<td>y factor</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>z</code></em> :</span></p></td>
<td>z factor</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rm</code></em> :</span></p></td>
<td>resulting matrix</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-matrix-transpose"></a><h3>g3d_matrix_transpose ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_matrix_transpose (<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *matrix</code></em>);</pre>
<p>
Transposes the matrix.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
<td>the matrix</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE on success, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-matrix-determinant"></a><h3>g3d_matrix_determinant ()</h3>
<pre class="programlisting"><a class="link" href="libg3d-types.html#G3DFloat" title="G3DFloat"><span class="returnvalue">G3DFloat</span></a> g3d_matrix_determinant (<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *matrix</code></em>);</pre>
<p>
Calculate the determinant of the matrix (FIXME: not verified).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
<td>the matrix</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the determinant.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="g3d-matrix-dump"></a><h3>g3d_matrix_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> g3d_matrix_dump (<em class="parameter"><code><a class="link" href="libg3d-matrix.html#G3DMatrix" title="G3DMatrix"><span class="type">G3DMatrix</span></a> *matrix</code></em>);</pre>
<p>
If debugging is enabled, this function dump the matrix to stderr.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>matrix</code></em> :</span></p></td>
<td>the matrix</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if matrix is dumped, FALSE else</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|