blob: 0d414d5398e7e727267b59cb8a6cb9f11426bee1 (
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
261
262
263
264
265
266
267
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2017-2023 David Thompson dthompson2@worcester.edu
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.
* Chickadee: (chickadee). Game programming toolkit for Guile.
The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
-->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Top (The Chickadee Game Toolkit)</title>
<meta name="description" content="Top (The Chickadee Game Toolkit)" />
<meta name="keywords" content="Top (The Chickadee Game Toolkit)" />
<meta name="resource-type" content="document" />
<meta name="distribution" content="global" />
<meta name="Generator" content="makeinfo" />
<link href="#Top" rel="start" title="Top" />
<link href="Index.html" rel="index" title="Index" />
<link href="#SEC_Contents" rel="contents" title="Table of Contents" />
<link href="Installation.html" rel="next" title="Installation" />
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {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}
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">
<h1 class="settitle" align="center">The Chickadee Game Toolkit</h1>
<span id="SEC_Contents"></span>
<h2 class="contents-heading">Table of Contents</h2>
<div class="contents">
<ul class="no-bullet">
<li><a id="toc-Installation-1" href="Installation.html#Installation">1 Installation</a>
<ul class="no-bullet">
<li><a id="toc-Requirements-1" href="Requirements.html#Requirements">1.1 Requirements</a></li>
</ul></li>
<li><a id="toc-Getting-Started-1" href="Getting-Started.html#Getting-Started">2 Getting Started</a></li>
<li><a id="toc-Command-Line-Interface-1" href="Command-Line-Interface.html#Command-Line-Interface">3 Command Line Interface</a>
<ul class="no-bullet">
<li><a id="toc-Invoking-chickadee-play-1" href="Invoking-chickadee-play.html#Invoking-chickadee-play">3.1 Invoking <code>chickadee play</code></a></li>
<li><a id="toc-Invoking-chickadee-bundle-1" href="Invoking-chickadee-bundle.html#Invoking-chickadee-bundle">3.2 Invoking <code>chickadee bundle</code></a></li>
</ul></li>
<li><a id="toc-Live-Coding-1" href="Live-Coding.html#Live-Coding">4 Live Coding</a></li>
<li><a id="toc-API-Reference-1" href="API-Reference.html#API-Reference">5 API Reference</a>
<ul class="no-bullet">
<li><a id="toc-Kernel-1" href="Kernel.html#Kernel">5.1 Kernel</a>
<ul class="no-bullet">
<li><a id="toc-The-Game-Loop-1" href="The-Game-Loop.html#The-Game-Loop">5.1.1 The Game Loop</a></li>
<li><a id="toc-Input-Devices-1" href="Input-Devices.html#Input-Devices">5.1.2 Input Devices</a></li>
<li><a id="toc-Window-Manipulation-1" href="Window-Manipulation.html#Window-Manipulation">5.1.3 Window Manipulation</a></li>
</ul></li>
<li><a id="toc-Math-1" href="Math.html#Math">5.2 Math</a>
<ul class="no-bullet">
<li><a id="toc-Basics-1" href="Basics.html#Basics">5.2.1 Basics</a></li>
<li><a id="toc-Vectors-1" href="Vectors.html#Vectors">5.2.2 Vectors</a>
<ul class="no-bullet">
<li><a id="toc-2D-Vectors" href="Vectors.html#g_t2D-Vectors">5.2.2.1 2D Vectors</a></li>
<li><a id="toc-3D-Vectors" href="Vectors.html#g_t3D-Vectors">5.2.2.2 3D Vectors</a></li>
</ul></li>
<li><a id="toc-Rectangles-1" href="Rectangles.html#Rectangles">5.2.3 Rectangles</a></li>
<li><a id="toc-Matrices-1" href="Matrices.html#Matrices">5.2.4 Matrices</a>
<ul class="no-bullet">
<li><a id="toc-3x3-Matrices" href="Matrices.html#g_t3x3-Matrices">5.2.4.1 3x3 Matrices</a></li>
<li><a id="toc-4x4-Matrices" href="Matrices.html#g_t4x4-Matrices">5.2.4.2 4x4 Matrices</a></li>
</ul></li>
<li><a id="toc-Quaternions-1" href="Quaternions.html#Quaternions">5.2.5 Quaternions</a></li>
<li><a id="toc-Easings-1" href="Easings.html#Easings">5.2.6 Easings</a></li>
<li><a id="toc-Bezier-Curves-1" href="Bezier-Curves.html#Bezier-Curves">5.2.7 Bezier Curves</a></li>
</ul></li>
<li><a id="toc-Graphics-1" href="Graphics.html#Graphics">5.3 Graphics</a>
<ul class="no-bullet">
<li><a id="toc-Colors-1" href="Colors.html#Colors">5.3.1 Colors</a>
<ul class="no-bullet">
<li><a id="toc-Stock-Colors" href="Colors.html#Stock-Colors">5.3.1.1 Stock Colors</a></li>
</ul></li>
<li><a id="toc-Textures-1" href="Textures.html#Textures">5.3.2 Textures</a>
<ul class="no-bullet">
<li><a id="toc-Tile-Atlases" href="Textures.html#Tile-Atlases">5.3.2.1 Tile Atlases</a></li>
<li><a id="toc-Cube-Maps" href="Textures.html#Cube-Maps">5.3.2.2 Cube Maps</a></li>
</ul></li>
<li><a id="toc-Sprites-1" href="Sprites.html#Sprites">5.3.3 Sprites</a>
<ul class="no-bullet">
<li><a id="toc-Sprite-Batches" href="Sprites.html#Sprite-Batches">5.3.3.1 Sprite Batches</a></li>
<li><a id="toc-9_002dPatches" href="Sprites.html#g_t9_002dPatches">5.3.3.2 9-Patches</a></li>
</ul></li>
<li><a id="toc-Fonts-1" href="Fonts.html#Fonts">5.3.4 Fonts</a></li>
<li><a id="toc-Vector-Paths-1" href="Vector-Paths.html#Vector-Paths">5.3.5 Vector Paths</a></li>
<li><a id="toc-Particles-1" href="Particles.html#Particles">5.3.6 Particles</a></li>
<li><a id="toc-Tile-Maps-1" href="Tile-Maps.html#Tile-Maps">5.3.7 Tile Maps</a></li>
<li><a id="toc-Models-1" href="Models.html#Models">5.3.8 Models</a></li>
<li><a id="toc-Lights-1" href="Lights.html#Lights">5.3.9 Lights</a></li>
<li><a id="toc-Skyboxes-1" href="Skyboxes.html#Skyboxes">5.3.10 Skyboxes</a></li>
<li><a id="toc-Meshes-1" href="Meshes.html#Meshes">5.3.11 Meshes</a>
<ul class="no-bullet">
<li><a id="toc-Materials" href="Meshes.html#Materials">5.3.11.1 Materials</a></li>
<li><a id="toc-Blinn_002dPhong-Materials" href="Meshes.html#Blinn_002dPhong-Materials">5.3.11.2 Blinn-Phong Materials</a></li>
<li><a id="toc-PBR-Materials" href="Meshes.html#PBR-Materials">5.3.11.3 PBR Materials</a></li>
<li><a id="toc-Primitives-and-Meshes" href="Meshes.html#Primitives-and-Meshes">5.3.11.4 Primitives and Meshes</a></li>
</ul></li>
<li><a id="toc-Buffers-1" href="Buffers.html#Buffers">5.3.12 Buffers</a></li>
<li><a id="toc-Shaders-1" href="Shaders.html#Shaders">5.3.13 Shaders</a>
<ul class="no-bullet">
<li><a id="toc-Attributes" href="Shaders.html#Attributes">5.3.13.1 Attributes</a></li>
<li><a id="toc-Uniforms" href="Shaders.html#Uniforms">5.3.13.2 Uniforms</a></li>
<li><a id="toc-User_002dDefined-Shader-Types" href="Shaders.html#User_002dDefined-Shader-Types">5.3.13.3 User-Defined Shader Types</a></li>
</ul></li>
<li><a id="toc-Framebuffers-1" href="Framebuffers.html#Framebuffers">5.3.14 Framebuffers</a></li>
<li><a id="toc-Viewports-1" href="Viewports.html#Viewports">5.3.15 Viewports</a></li>
<li><a id="toc-Render-Settings-1" href="Render-Settings.html#Render-Settings">5.3.16 Render Settings</a>
<ul class="no-bullet">
<li><a id="toc-Blending" href="Render-Settings.html#Blending">5.3.16.1 Blending</a></li>
<li><a id="toc-Polygon-Modes-and-Culling" href="Render-Settings.html#Polygon-Modes-and-Culling">5.3.16.2 Polygon Modes and Culling</a></li>
<li><a id="toc-Depth-Testing" href="Render-Settings.html#Depth-Testing">5.3.16.3 Depth Testing</a></li>
<li><a id="toc-Stencil-Testing" href="Render-Settings.html#Stencil-Testing">5.3.16.4 Stencil Testing</a></li>
<li><a id="toc-Multisample-Antialiasing" href="Render-Settings.html#Multisample-Antialiasing">5.3.16.5 Multisample Antialiasing</a></li>
</ul></li>
<li><a id="toc-Rendering-Engine-1" href="Rendering-Engine.html#Rendering-Engine">5.3.17 Rendering Engine</a>
<ul class="no-bullet">
<li><a id="toc-Render-States" href="Rendering-Engine.html#Render-States">5.3.17.1 Render States</a></li>
<li><a id="toc-Rendering" href="Rendering-Engine.html#Rendering">5.3.17.2 Rendering</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Audio-1" href="Audio.html#Audio">5.4 Audio</a>
<ul class="no-bullet">
<li><a id="toc-Audio-Files-1" href="Audio-Files.html#Audio-Files">5.4.1 Audio Files</a></li>
<li><a id="toc-Sources-1" href="Sources.html#Sources">5.4.2 Sources</a></li>
<li><a id="toc-The-Listener-1" href="The-Listener.html#The-Listener">5.4.3 The Listener</a></li>
<li><a id="toc-The-Environment-1" href="The-Environment.html#The-Environment">5.4.4 The Environment</a></li>
</ul></li>
<li><a id="toc-Scripting-1" href="Scripting.html#Scripting">5.5 Scripting</a>
<ul class="no-bullet">
<li><a id="toc-Agendas-1" href="Agendas.html#Agendas">5.5.1 Agendas</a></li>
<li><a id="toc-Scripts-1" href="Scripts.html#Scripts">5.5.2 Scripts</a></li>
<li><a id="toc-Tweening-1" href="Tweening.html#Tweening">5.5.3 Tweening</a></li>
<li><a id="toc-Channels-1" href="Channels.html#Channels">5.5.4 Channels</a></li>
</ul></li>
<li><a id="toc-Data-Structures-1" href="Data-Structures.html#Data-Structures">5.6 Data Structures</a>
<ul class="no-bullet">
<li><a id="toc-Array-Lists-1" href="Array-Lists.html#Array-Lists">5.6.1 Array Lists</a></li>
<li><a id="toc-Queues-1" href="Queues.html#Queues">5.6.2 Queues</a></li>
<li><a id="toc-Heaps-1" href="Heaps.html#Heaps">5.6.3 Heaps</a></li>
<li><a id="toc-Quadtrees-1" href="Quadtrees.html#Quadtrees">5.6.4 Quadtrees</a></li>
<li><a id="toc-Grids-1" href="Grids.html#Grids">5.6.5 Grids</a></li>
<li><a id="toc-Path-Finding-1" href="Path-Finding.html#Path-Finding">5.6.6 Path Finding</a></li>
</ul></li>
</ul></li>
<li><a id="toc-Copying-This-Manual-1" href="Copying-This-Manual.html#Copying-This-Manual">Appendix A Copying This Manual</a>
<ul class="no-bullet">
<li><a id="toc-Apache-2_002e0-License-1" href="Apache-2_002e0-License.html#Apache-2_002e0-License">A.1 Apache 2.0 License</a></li>
</ul></li>
<li><a id="toc-Index-1" href="Index.html#Index" rel="index">Index</a></li>
</ul>
</div>
<span id="Top"></span><div class="header">
<p>
Next: <a href="Installation.html" accesskey="n" rel="next">Installation</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr />
<span id="Chickadee"></span><h1 class="top">Chickadee</h1>
<p>Copyright © 2017-2023 David Thompson <a href="mailto:dthompson2@worcester.edu">dthompson2@worcester.edu</a>
</p>
<blockquote>
<p>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”.
</p>
<p>A copy of the license is also available from the Free Software
Foundation Web site at <a href="http://www.gnu.org/licenses/fdl.html">http://www.gnu.org/licenses/fdl.html</a>.
</p>
</blockquote>
<p>The document was typeset with
<a href="http://www.texinfo.org/">GNU Texinfo</a>.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="Installation.html" accesskey="1">Installation</a></td><td> </td><td align="left" valign="top">Installing Chickadee.
</td></tr>
<tr><td align="left" valign="top">• <a href="Getting-Started.html" accesskey="2">Getting Started</a></td><td> </td><td align="left" valign="top">Writing your first Chickadee program.
</td></tr>
<tr><td align="left" valign="top">• <a href="Command-Line-Interface.html" accesskey="3">Command Line Interface</a></td><td> </td><td align="left" valign="top">Run Chickadee programs from the terminal.
</td></tr>
<tr><td align="left" valign="top">• <a href="Live-Coding.html" accesskey="4">Live Coding</a></td><td> </td><td align="left" valign="top">Tips for building games from the REPL.
</td></tr>
<tr><td align="left" valign="top">• <a href="API-Reference.html" accesskey="5">API Reference</a></td><td> </td><td align="left" valign="top">Chickadee API reference.
</td></tr>
<tr><td align="left" valign="top">• <a href="Copying-This-Manual.html" accesskey="6">Copying This Manual</a></td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="Index.html" rel="index" accesskey="7">Index</a></td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr />
<div class="header">
<p>
Next: <a href="Installation.html" accesskey="n" rel="next">Installation</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
