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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libg3d-matrix">
<refmeta>
<refentrytitle role="top_of_page" id="libg3d-matrix.top_of_page">matrix</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBG3D Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>matrix</refname>
<refpurpose>Matrix manipulation and calculation</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libg3d-matrix.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <g3d/matrix.h>
typedef <link linkend="G3DMatrix">G3DMatrix</link>;
<link linkend="gboolean">gboolean</link> <link linkend="g3d-matrix-identity">g3d_matrix_identity</link> (<link linkend="G3DMatrix">G3DMatrix</link> *matrix);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-matrix-multiply">g3d_matrix_multiply</link> (<link linkend="G3DMatrix">G3DMatrix</link> *m1,
<link linkend="G3DMatrix">G3DMatrix</link> *m2,
<link linkend="G3DMatrix">G3DMatrix</link> *rm);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-matrix-translate">g3d_matrix_translate</link> (<link linkend="G3DFloat">G3DFloat</link> x,
<link linkend="G3DFloat">G3DFloat</link> y,
<link linkend="G3DFloat">G3DFloat</link> z,
<link linkend="G3DMatrix">G3DMatrix</link> *rm);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-matrix-rotate">g3d_matrix_rotate</link> (<link linkend="G3DFloat">G3DFloat</link> angle,
<link linkend="G3DFloat">G3DFloat</link> ax,
<link linkend="G3DFloat">G3DFloat</link> ay,
<link linkend="G3DFloat">G3DFloat</link> az,
<link linkend="G3DMatrix">G3DMatrix</link> *rm);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-matrix-rotate-xyz">g3d_matrix_rotate_xyz</link> (<link linkend="G3DFloat">G3DFloat</link> rx,
<link linkend="G3DFloat">G3DFloat</link> ry,
<link linkend="G3DFloat">G3DFloat</link> rz,
<link linkend="G3DMatrix">G3DMatrix</link> *rm);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-matrix-scale">g3d_matrix_scale</link> (<link linkend="G3DFloat">G3DFloat</link> x,
<link linkend="G3DFloat">G3DFloat</link> y,
<link linkend="G3DFloat">G3DFloat</link> z,
<link linkend="G3DMatrix">G3DMatrix</link> *rm);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-matrix-transpose">g3d_matrix_transpose</link> (<link linkend="G3DMatrix">G3DMatrix</link> *matrix);
<link linkend="G3DFloat">G3DFloat</link> <link linkend="g3d-matrix-determinant">g3d_matrix_determinant</link> (<link linkend="G3DMatrix">G3DMatrix</link> *matrix);
<link linkend="gboolean">gboolean</link> <link linkend="g3d-matrix-dump">g3d_matrix_dump</link> (<link linkend="G3DMatrix">G3DMatrix</link> *matrix);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libg3d-matrix.description" role="desc">
<title role="desc.title">Description</title>
<para>
Matrices in libg3d have the following layout:
</para>
<para>
G3DMatrix matrix[16]:
</para>
<para>
matrix[col * 4 + row] = f;</para>
<para>
</para>
</refsect1>
<refsect1 id="libg3d-matrix.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="G3DMatrix" role="typedef">
<title>G3DMatrix</title>
<indexterm zone="G3DMatrix"><primary>G3DMatrix</primary></indexterm><programlisting>typedef G3DFloat G3DMatrix;
</programlisting>
<para>
Matrix element type.</para>
<para>
</para></refsect2>
<refsect2 id="g3d-matrix-identity" role="function">
<title>g3d_matrix_identity ()</title>
<indexterm zone="g3d-matrix-identity"><primary>g3d_matrix_identity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_matrix_identity (<link linkend="G3DMatrix">G3DMatrix</link> *matrix);</programlisting>
<para>
Sets the given matrix to the identity matrix.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>matrix</parameter> :</term>
<listitem><simpara> 4x4 matrix (float[16])
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-matrix-multiply" role="function">
<title>g3d_matrix_multiply ()</title>
<indexterm zone="g3d-matrix-multiply"><primary>g3d_matrix_multiply</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_matrix_multiply (<link linkend="G3DMatrix">G3DMatrix</link> *m1,
<link linkend="G3DMatrix">G3DMatrix</link> *m2,
<link linkend="G3DMatrix">G3DMatrix</link> *rm);</programlisting>
<para>
Multiplies the matrixes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>m1</parameter> :</term>
<listitem><simpara> first matrix
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>m2</parameter> :</term>
<listitem><simpara> second matrix
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rm</parameter> :</term>
<listitem><simpara> resulting matrix
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-matrix-translate" role="function">
<title>g3d_matrix_translate ()</title>
<indexterm zone="g3d-matrix-translate"><primary>g3d_matrix_translate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_matrix_translate (<link linkend="G3DFloat">G3DFloat</link> x,
<link linkend="G3DFloat">G3DFloat</link> y,
<link linkend="G3DFloat">G3DFloat</link> z,
<link linkend="G3DMatrix">G3DMatrix</link> *rm);</programlisting>
<para>
Adds a translation to the the matrix.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> x translation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> y translation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>z</parameter> :</term>
<listitem><simpara> z translation
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rm</parameter> :</term>
<listitem><simpara> resulting matrix
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-matrix-rotate" role="function">
<title>g3d_matrix_rotate ()</title>
<indexterm zone="g3d-matrix-rotate"><primary>g3d_matrix_rotate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_matrix_rotate (<link linkend="G3DFloat">G3DFloat</link> angle,
<link linkend="G3DFloat">G3DFloat</link> ax,
<link linkend="G3DFloat">G3DFloat</link> ay,
<link linkend="G3DFloat">G3DFloat</link> az,
<link linkend="G3DMatrix">G3DMatrix</link> *rm);</programlisting>
<para>
Adds a rotation to the matrix.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>angle</parameter> :</term>
<listitem><simpara> rotation angle
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ax</parameter> :</term>
<listitem><simpara> x component of rotation axis
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ay</parameter> :</term>
<listitem><simpara> y component of rotation axis
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>az</parameter> :</term>
<listitem><simpara> z component of rotation axis
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rm</parameter> :</term>
<listitem><simpara> resulting matrix
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-matrix-rotate-xyz" role="function">
<title>g3d_matrix_rotate_xyz ()</title>
<indexterm zone="g3d-matrix-rotate-xyz"><primary>g3d_matrix_rotate_xyz</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_matrix_rotate_xyz (<link linkend="G3DFloat">G3DFloat</link> rx,
<link linkend="G3DFloat">G3DFloat</link> ry,
<link linkend="G3DFloat">G3DFloat</link> rz,
<link linkend="G3DMatrix">G3DMatrix</link> *rm);</programlisting>
<para>
Adds a rotation around the 3 coordinate system axes to the matrix.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>rx</parameter> :</term>
<listitem><simpara> rotation around x axis
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ry</parameter> :</term>
<listitem><simpara> rotation around y axis
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rz</parameter> :</term>
<listitem><simpara> rotation around z axis
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rm</parameter> :</term>
<listitem><simpara> resulting matrix
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-matrix-scale" role="function">
<title>g3d_matrix_scale ()</title>
<indexterm zone="g3d-matrix-scale"><primary>g3d_matrix_scale</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_matrix_scale (<link linkend="G3DFloat">G3DFloat</link> x,
<link linkend="G3DFloat">G3DFloat</link> y,
<link linkend="G3DFloat">G3DFloat</link> z,
<link linkend="G3DMatrix">G3DMatrix</link> *rm);</programlisting>
<para>
Adds a scaling to the matrix.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>x</parameter> :</term>
<listitem><simpara> x factor
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter> :</term>
<listitem><simpara> y factor
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>z</parameter> :</term>
<listitem><simpara> z factor
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rm</parameter> :</term>
<listitem><simpara> resulting matrix
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-matrix-transpose" role="function">
<title>g3d_matrix_transpose ()</title>
<indexterm zone="g3d-matrix-transpose"><primary>g3d_matrix_transpose</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_matrix_transpose (<link linkend="G3DMatrix">G3DMatrix</link> *matrix);</programlisting>
<para>
Transposes the matrix.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>matrix</parameter> :</term>
<listitem><simpara> the matrix
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-matrix-determinant" role="function">
<title>g3d_matrix_determinant ()</title>
<indexterm zone="g3d-matrix-determinant"><primary>g3d_matrix_determinant</primary></indexterm><programlisting><link linkend="G3DFloat">G3DFloat</link> g3d_matrix_determinant (<link linkend="G3DMatrix">G3DMatrix</link> *matrix);</programlisting>
<para>
Calculate the determinant of the matrix (FIXME: not verified).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>matrix</parameter> :</term>
<listitem><simpara> the matrix
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the determinant.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="g3d-matrix-dump" role="function">
<title>g3d_matrix_dump ()</title>
<indexterm zone="g3d-matrix-dump"><primary>g3d_matrix_dump</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> g3d_matrix_dump (<link linkend="G3DMatrix">G3DMatrix</link> *matrix);</programlisting>
<para>
If debugging is enabled, this function dump the matrix to stderr.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>matrix</parameter> :</term>
<listitem><simpara> the matrix
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if matrix is dumped, FALSE else
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
