summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Matrices.html
blob: 5f664ef1b6e14064f8346d4c8ddc80bbe41020be (plain)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2017  David Thompson davet@gnu.org

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".

A copy of the license is also available from the Free Software
Foundation Web site at http://www.gnu.org/licenses/fdl.html.


The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
 -->
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Matrices (The Chickadee Game Toolkit)</title>

<meta name="description" content="Matrices (The Chickadee Game Toolkit)">
<meta name="keywords" content="Matrices (The Chickadee Game Toolkit)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index.html#Index" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Math.html#Math" rel="up" title="Math">
<link href="Quaternions.html#Quaternions" rel="next" title="Quaternions">
<link href="Grid.html#Grid" rel="prev" title="Grid">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
@media (min-width: 1140px) {
    body {
        margin-left: 14rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (min-width: 800px) and (max-width: 1140px) {
    body {
        margin-left: 6rem;
        margin-right: 4rem;
        max-width: 52rem;
    }
}

@media (max-width: 800px) {
    body {
        margin: 1rem;
    }
}

-->
</style>
<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css">


</head>

<body lang="en">
<a name="Matrices"></a>
<div class="header">
<p>
Next: <a href="Quaternions.html#Quaternions" accesskey="n" rel="next">Quaternions</a>, Previous: <a href="Grid.html#Grid" accesskey="p" rel="prev">Grid</a>, Up: <a href="Math.html#Math" accesskey="u" rel="up">Math</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Matrices-1"></a>
<h4 class="subsection">2.2.5 Matrices</h4>

<p>The <code>(chickadee math matrix)</code> module provides an interface for
working with the most common type of matrices in game development: 4x4
transformation matrices.
</p>
<a name="Another-Note-About-Performance"></a>
<h4 class="subsubsection">2.2.5.1 Another Note About Performance</h4>

<p>Much like the vector API, the matrix API is commonly used in
performance critical code paths.  In order to reduce the amount of
garbage generated and improve matrix multiplication performance, there
are many procedures that perform in-place modifications of matrix
objects.
</p>
<a name="Matrix-Operations"></a>
<h4 class="subsubsection">2.2.5.2 Matrix Operations</h4>

<dl>
<dt><a name="index-make_002dmatrix4"></a>Procedure: <strong>make-matrix4</strong> <em><var>aa</var> <var>ab</var> <var>ac</var> <var>ad</var>                                 <var>ba</var> <var>bb</var> <var>bc</var> <var>bd</var>                                 <var>ca</var> <var>cb</var> <var>cc</var> <var>cd</var>                                 <var>da</var> <var>db</var> <var>dc</var> <var>dd</var></em></dt>
<dd>
<p>Return a new 4x4 matrix initialized with the given 16 values in
column-major format.
</p></dd></dl>

<dl>
<dt><a name="index-make_002dnull_002dmatrix4"></a>Procedure: <strong>make-null-matrix4</strong></dt>
<dd><p>Return a new 4x4 matrix with all values initialized to 0.
</p></dd></dl>

<dl>
<dt><a name="index-make_002didentity_002dmatrix4"></a>Procedure: <strong>make-identity-matrix4</strong></dt>
<dd><p>Return a new 4x4 identity matrix.  Any matrix multiplied by the
identity matrix yields the original matrix.  This procedure is
equivalent to the following code:
</p>
<div class="example">
<pre class="example">(make-matrix4 1 0 0 0
              0 1 0 0
              0 0 1 0
              0 0 0 1)
</pre></div>

</dd></dl>

<dl>
<dt><a name="index-matrix4_003f"></a>Procedure: <strong>matrix4?</strong> <em><var>obj</var></em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a 4x4 matrix.
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002a"></a>Procedure: <strong>matrix4*</strong> <em>. <var>matrices</var></em></dt>
<dd><p>Return a new 4x4 matrix containing the product of multiplying all of
the given <var>matrices</var>.
</p>
<p>Note: Remember that matrix multiplication is <strong>not</strong> commutative!
</p></dd></dl>

<dl>
<dt><a name="index-orthographic_002dprojection"></a>Procedure: <strong>orthographic-projection</strong> <em><var>left</var> <var>right</var>                                            <var>top</var> <var>bottom</var>                                            <var>near</var> <var>far</var></em></dt>
<dd>
<p>Return a new 4x4 matrix that represents an orthographic (2D)
projection for the horizontal clipping plane <var>top</var> and
<var>bottom</var>, the vertical clipping plane <var>top</var> and <var>bottom</var>,
and the depth clipping plane <var>near</var> and <var>far</var>.
</p></dd></dl>

<dl>
<dt><a name="index-perspective_002dprojection"></a>Procedure: <strong>perspective-projection</strong> <em><var>fov</var>                                           <var>aspect-ratio</var>                                           <var>near</var> <var>far</var></em></dt>
<dd>
<p>Return a new 4x4 matrix that represents a perspective (3D) projection
with a field of vision of <var>fov</var> radians, an aspect ratio of
<var>aspect-ratio</var>, and a depth clipping plane defined by <var>near</var>
and <var>far</var>.
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002dtranslate"></a>Procedure: <strong>matrix4-translate</strong> <em><var>x</var></em></dt>
<dd><p>Return a new 4x4 matrix that represents a translation by <var>x</var>, a 2D
vector, a 3D vector, or a rectangle (in which case the bottom-left
corner of the rectangle is used).
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002dscale"></a>Procedure: <strong>matrix4-scale</strong> <em><var>s</var></em></dt>
<dd><p>Return a new 4x4 matrix that represents a scaling along the X, Y, and
Z axes by the scaling factor <var>s</var>, a real number.
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002drotate"></a>Procedure: <strong>matrix4-rotate</strong> <em><var>q</var></em></dt>
<dd><p>Return a new 4x4 matrix that represents a rotation about an arbitrary
axis defined by the quaternion <var>q</var>.
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002drotate_002dz"></a>Procedure: <strong>matrix4-rotate-z</strong> <em><var>theta</var></em></dt>
<dd><p>Return a new 4x4 matrix that represents a rotation about the Z axis by
<var>theta</var> radians.
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002didentity_0021"></a>Procedure: <strong>matrix4-identity!</strong> <em><var>matrix</var></em></dt>
<dd><p>Modify <var>matrix</var> in-place to contain the identity matrix.
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002dmult_0021"></a>Procedure: <strong>matrix4-mult!</strong> <em><var>dest</var> <var>a</var> <var>b</var></em></dt>
<dd><p>Multiply the 4x4 matrix <var>a</var> by the 4x4 matrix <var>b</var> and store
the result in the 4x4 matrix <var>dest</var>.
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002dtranslate_0021"></a>Procedure: <strong>matrix4-translate!</strong> <em><var>matrix</var> <var>x</var></em></dt>
<dd><p>Modify <var>matrix</var> in-place to contain a translation by <var>x</var>, a 2D
vector, a 3D vector, or a rectangle (in which case the bottom-left
corner of the rectangle is used).
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002dscale_0021"></a>Procedure: <strong>matrix4-scale!</strong> <em><var>matrix</var> <var>s</var></em></dt>
<dd><p>Modify <var>matrix</var> in-place to contain a scaling along the X, Y, and
Z axes by the scaling factor <var>s</var>, a real number.
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002drotate_0021"></a>Procedure: <strong>matrix4-rotate!</strong> <em><var>matrix</var> <var>q</var></em></dt>
<dd><p>Modify <var>matrix</var> in-place to contain a rotation about an arbitrary
axis defined by the quaternion <var>q</var>.
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002drotate_002dz_0021"></a>Procedure: <strong>matrix4-rotate-z!</strong> <em><var>matrix</var> <var>theta</var></em></dt>
<dd><p>Modify <var>matrix</var> in-place to contain a rotation about the Z axis by
<var>theta</var> radians.
</p></dd></dl>

<dl>
<dt><a name="index-matrix4_002d2d_002dtransform_0021"></a>Procedure: <strong>matrix4-2d-transform!</strong> <em><var>matrix</var> [#:origin]                                          [#:position] [#:rotation]                                          [#:scale] [#:skew]</em></dt>
<dd>
<p>Modify <var>matrix</var> in-place to contain the transformation described
by <var>position</var>, a 2D vector or rectangle, <var>rotation</var>, a scalar
representing a rotation about the Z axis, <var>scale</var>, a 2D vector,
and <var>skew</var>, a 2D vector.  The transformation happens with respect
to <var>origin</var>, a 2D vector.  If an argument is not provided, that
particular transformation will not be included in the result.
</p></dd></dl>

<dl>
<dt><a name="index-transform_0021"></a>Procedure: <strong>transform!</strong> <em><var>matrix</var> <var>v</var></em></dt>
<dd><p>Modify the 2D vector <var>v</var> in-place by multiplying it by the 4x4
matrix <var>matrix</var>.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="Quaternions.html#Quaternions" accesskey="n" rel="next">Quaternions</a>, Previous: <a href="Grid.html#Grid" accesskey="p" rel="prev">Grid</a>, Up: <a href="Math.html#Math" accesskey="u" rel="up">Math</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>