From 03072ef67af0623758a660e2cd3fb5e153133efa Mon Sep 17 00:00:00 2001 From: David Thompson Date: Wed, 24 May 2023 08:09:03 -0400 Subject: Update chickadee manual. --- manuals/chickadee/API-Reference.html | 38 +- manuals/chickadee/Agendas.html | 66 +-- manuals/chickadee/Apache-2_002e0-License.html | 305 +++++++++++ manuals/chickadee/Array-Lists.html | 40 +- manuals/chickadee/Audio-Files.html | 40 +- manuals/chickadee/Audio.html | 44 +- manuals/chickadee/Basics.html | 38 +- manuals/chickadee/Bezier-Curves.html | 40 +- manuals/chickadee/Buffers.html | 130 ++--- manuals/chickadee/Channels.html | 62 +-- manuals/chickadee/Colors.html | 62 +-- manuals/chickadee/Command-Line-Interface.html | 38 +- manuals/chickadee/Copying-This-Manual.html | 40 +- manuals/chickadee/Data-Structures.html | 38 +- manuals/chickadee/Easings.html | 38 +- manuals/chickadee/Fonts.html | 56 +- manuals/chickadee/Framebuffers.html | 38 +- .../chickadee/GNU-Free-Documentation-License.html | 566 --------------------- manuals/chickadee/Getting-Started.html | 88 ++-- manuals/chickadee/Graphics.html | 40 +- manuals/chickadee/Grids.html | 40 +- manuals/chickadee/Heaps.html | 38 +- manuals/chickadee/Index.html | 94 ++-- manuals/chickadee/Input-Devices.html | 38 +- manuals/chickadee/Installation.html | 38 +- manuals/chickadee/Invoking-chickadee-bundle.html | 54 +- manuals/chickadee/Invoking-chickadee-play.html | 50 +- manuals/chickadee/Kernel.html | 38 +- manuals/chickadee/Lights.html | 40 +- manuals/chickadee/Live-Coding.html | 54 +- manuals/chickadee/Math.html | 38 +- manuals/chickadee/Matrices.html | 58 +-- manuals/chickadee/Meshes.html | 44 +- manuals/chickadee/Models.html | 68 +-- manuals/chickadee/Particles.html | 58 +-- manuals/chickadee/Path-Finding.html | 66 +-- manuals/chickadee/Quadtrees.html | 40 +- manuals/chickadee/Quaternions.html | 38 +- manuals/chickadee/Queues.html | 38 +- manuals/chickadee/Rectangles.html | 40 +- manuals/chickadee/Render-Settings.html | 40 +- manuals/chickadee/Rendering-Engine.html | 48 +- manuals/chickadee/Requirements.html | 38 +- manuals/chickadee/Scripting.html | 38 +- manuals/chickadee/Scripts.html | 70 +-- manuals/chickadee/Shaders.html | 70 +-- manuals/chickadee/Skyboxes.html | 38 +- manuals/chickadee/Sources.html | 40 +- manuals/chickadee/Sprites.html | 40 +- manuals/chickadee/Textures.html | 40 +- manuals/chickadee/The-Environment.html | 38 +- manuals/chickadee/The-Game-Loop.html | 94 +++- manuals/chickadee/The-Listener.html | 38 +- manuals/chickadee/Tile-Maps.html | 40 +- manuals/chickadee/Tweening.html | 48 +- manuals/chickadee/Vector-Paths.html | 62 +-- manuals/chickadee/Vectors.html | 44 +- manuals/chickadee/Viewports.html | 41 +- manuals/chickadee/Window-Manipulation.html | 38 +- manuals/chickadee/index.html | 42 +- 60 files changed, 1763 insertions(+), 1963 deletions(-) create mode 100644 manuals/chickadee/Apache-2_002e0-License.html delete mode 100644 manuals/chickadee/GNU-Free-Documentation-License.html diff --git a/manuals/chickadee/API-Reference.html b/manuals/chickadee/API-Reference.html index 7ccd8b2..4b69116 100644 --- a/manuals/chickadee/API-Reference.html +++ b/manuals/chickadee/API-Reference.html @@ -1,6 +1,6 @@ - - + --> + - + API Reference (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

Next: , Previous: , Up: Top   [Contents][Index]

-
+

5 API Reference

diff --git a/manuals/chickadee/Agendas.html b/manuals/chickadee/Agendas.html index f6acd57..51be160 100644 --- a/manuals/chickadee/Agendas.html +++ b/manuals/chickadee/Agendas.html @@ -1,6 +1,6 @@ - - + --> + - +Agendas (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

Next: , Up: Scripting   [Contents][Index]

-
+

5.5.1 Agendas

To schedule a task to be performed later, an “agenda” is used. @@ -93,15 +93,15 @@ additional agendas may be created for different purposes. The following example prints the text “hello” when the agenda has advanced to time unit 10.

-
-
(at 10 (display "hello\n"))
+

+
(at 10 (display "hello\n"))
 

 
 
Most of the time it is more convenient to schedule tasks relative to
 the current time.  This is where after comes in handy:
 

-

-
(after 10 (display "hello\n"))
+

+
(after 10 (display "hello\n"))
 

 
 
Time units in the agenda are in no way connected to real time.  It’s
@@ -109,9 +109,9 @@ up to the programmer to decide what agenda time means.  A simple and
 effective approach is to map each call of the update procedure
 (see Kernel) to 1 unit of agenda time, like so:
 

-

-
(define (update dt)
-  (update-agenda 1))
+

+
(define (update dt)
+  (update-agenda 1))
 

 
 
It is important to call update-agenda periodically, otherwise
@@ -124,13 +124,13 @@ a simple matter of not updating the world’s agenda while continuing to
 update the user interface’s agenda.  The current agenda is dynamically
 scoped and can be changed using the with-agenda special form:
 

-

-
(define game-world-agenda (make-agenda))
+

+
(define game-world-agenda (make-agenda))
 
-(with-agenda game-world-agenda
-  (at 60 (spawn-goblin))
-  (at 120 (spawn-goblin))
-  (at 240 (spawn-goblin-king)))
+(with-agenda game-world-agenda
+  (at 60 (spawn-goblin))
+  (at 120 (spawn-goblin))
+  (at 240 (spawn-goblin-king)))
 

 
 

@@ -211,7 +211,7 @@ registered conditions are met.
 (returns a value other than #f.)
 

 
-

+

 

 

 Next: , Up: Scripting   [Contents][Index]

diff --git a/manuals/chickadee/Apache-2_002e0-License.html b/manuals/chickadee/Apache-2_002e0-License.html
new file mode 100644
index 0000000..361c858
--- /dev/null
+++ b/manuals/chickadee/Apache-2_002e0-License.html
@@ -0,0 +1,305 @@
+
+
+
+
+
+
+Apache 2.0 License (The Chickadee Game Toolkit)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+

+Up: Copying This Manual   [Contents][Index]

+

+

+
A.1 Apache 2.0 License

+
+
Apache License
+

+
Version 2.0, January 2004
+

+
http://www.apache.org/licenses/
+

+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+

+
    
+
  1.  Definitions.
+
+
    “License” shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
    
+
    “Licensor” shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
    
+
    “Legal Entity” shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+“control” means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
    
+
    “You” (or “Your”) shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
    
+
    “Source” form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
    
+
    “Object” form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
    
+
    “Work” shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
    
+
    “Derivative Works” shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
    
+
    “Contribution” shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, “submitted”
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as “Not a Contribution.”
+
    
+
    “Contributor” shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
    
+
  2.  Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+
  3.  Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+
  4.  Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+
    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
    
+
    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
    
+
    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
    
+
    (d) If the Work includes a “NOTICE” text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
    
+
    You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
    
+
  5.  Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+
  6.  Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+
  7.  Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+
  8.  Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+
  9.  Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+

+
+
END OF TERMS AND CONDITIONS
+

+
APPENDIX: How to apply the Apache License to your work.
+

+
To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets “[]”
+replaced with your own identifying information. (Don’t include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same “printed page” as the copyright notice for easier
+identification within third-party archives.
+

+
Copyright [yyyy] [name of copyright owner]
+

+
Licensed under the Apache License, Version 2.0 (the “License”);
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+

+
http://www.apache.org/licenses/LICENSE-2.0
+

+
Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+

+

+

+

+Up: Copying This Manual   [Contents][Index]

+

+
+
+
+
+
diff --git a/manuals/chickadee/Array-Lists.html b/manuals/chickadee/Array-Lists.html
index 0aa5eb4..ca30f16 100644
--- a/manuals/chickadee/Array-Lists.html
+++ b/manuals/chickadee/Array-Lists.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Array Lists (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Next: , Up: Data Structures   [Contents][Index]

 

-

+

 
5.6.1 Array Lists

 
 
The (chickadee data array-list) module provides an array/vector
@@ -167,7 +167,7 @@ return that result.  init is the initial result.  If there are
 no objects in the vicinity of rect, just init is returned.
 

 
-

+

 

 

 Next: , Up: Data Structures   [Contents][Index]

diff --git a/manuals/chickadee/Audio-Files.html b/manuals/chickadee/Audio-Files.html
index f120772..a4d7994 100644
--- a/manuals/chickadee/Audio-Files.html
+++ b/manuals/chickadee/Audio-Files.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Audio Files (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Next: , Up: Audio   [Contents][Index]

 

-

+

 
5.4.1 Audio Files

 
 
Sound data is represented by a special <audio> data type that
@@ -209,7 +209,7 @@ and pitch.
 

 
 
-

+

 

 

 Next: , Up: Audio   [Contents][Index]

diff --git a/manuals/chickadee/Audio.html b/manuals/chickadee/Audio.html
index 4a72f03..8f167d0 100644
--- a/manuals/chickadee/Audio.html
+++ b/manuals/chickadee/Audio.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Audio (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Next: , Previous: , Up: API Reference   [Contents][Index]

 

-

+

 
5.4 Audio

 
 
A game isn’t complete without sound.  Most games play some cool
@@ -107,10 +107,10 @@ robust audio API backed by the OpenAL 3D audio system.
 in the load hook (or anywhere else once the game loop is running) and
 play it!
 

-

-
(define sample (load-audio "neat-sound-effect.wav"))
+

+
(define sample (load-audio "neat-sound-effect.wav"))
 
-(audio-play sample)
+(audio-play sample)
 

 
 
For more advanced usage, check out the full API reference in the
diff --git a/manuals/chickadee/Basics.html b/manuals/chickadee/Basics.html
index 8b3a5d7..c968a8c 100644
--- a/manuals/chickadee/Basics.html
+++ b/manuals/chickadee/Basics.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Basics (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Next: , Up: Math   [Contents][Index]

 

-

+

 
5.2.1 Basics

 
 

diff --git a/manuals/chickadee/Bezier-Curves.html b/manuals/chickadee/Bezier-Curves.html
index fe6deaa..8935b0f 100644
--- a/manuals/chickadee/Bezier-Curves.html
+++ b/manuals/chickadee/Bezier-Curves.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Bezier Curves (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Previous: , Up: Math   [Contents][Index]

 

-

+

 
5.2.7 Bezier Curves

 
 
The (chickadee math bezier) module provides an API for
@@ -149,7 +149,7 @@ check) as a 2D vector.
 for bezier at t.
 

 
-

+

 

 

 Previous: , Up: Math   [Contents][Index]

diff --git a/manuals/chickadee/Buffers.html b/manuals/chickadee/Buffers.html
index ffb4714..ac5fb02 100644
--- a/manuals/chickadee/Buffers.html
+++ b/manuals/chickadee/Buffers.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Buffers (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Next: , Previous: , Up: Graphics   [Contents][Index]

 

-

+

 
5.3.12 Buffers

 
 
Alright, let’s brush aside all of those pretty high level abstractions
@@ -99,25 +99,25 @@ API for manipulating GPU buffers.
 that could be transformed into a GPU buffer that packs together vertex
 position and texture coordinates:
 

-

-
(use-modules (chickadee graphics buffer) (srfi srfi-4))
-(define data
-  (f32vector -8.0 -8.0 ; 2D vertex
-             0.0 0.0   ; 2D texture coordinate
-             8.0 -8.0  ; 2D vertex
-             1.0 0.0   ; 2D texture coordinate
-             8.0 8.0   ; 2D vertex
-             1.0 1.0   ; 2D texture coordinate
-             -8.0 8.0  ; 2D vertex
-             0.0 1.0)) ; 2D texture coordinate
-

+

+
(use-modules (chickadee graphics buffer) (srfi srfi-4))
+(define data
+  (f32vector -8.0 -8.0 ; 2D vertex
+             0.0 0.0   ; 2D texture coordinate
+             8.0 -8.0  ; 2D vertex
+             1.0 0.0   ; 2D texture coordinate
+             8.0 8.0   ; 2D vertex
+             1.0 1.0   ; 2D texture coordinate
+             -8.0 8.0  ; 2D vertex
+             0.0 1.0)) ; 2D texture coordinate
+

 
 
This data represents a textured 16x16 square centered on the
 origin. To send this data to the GPU, the make-buffer procedure
 is needed:
 

-

-
(define buffer (make-buffer data #:stride 16))
+

+
(define buffer (make-buffer data #:stride 16))
 

 
 
The #:stride keyword argument indicates how many bytes make up
@@ -131,18 +131,18 @@ particular data type.  In this case, there are two attributes packed
 into the buffer.  To define vertex attributes, the
 make-vertex-attribute procedure is needed:
 

-

-
(define vertices
-  (make-vertex-attribute #:buffer buffer
-                         #:type 'vec2
-                         #:component-type 'float
-                         #:length 4))
-(define texcoords
-  (make-vertex-attribute #:buffer buffer
-                         #:type 'vec2
-                         #:component-type 'float
-                         #:length 4
-                         #:offset 8))
+

+
(define vertices
+  (make-vertex-attribute #:buffer buffer
+                         #:type 'vec2
+                         #:component-type 'float
+                         #:length 4))
+(define texcoords
+  (make-vertex-attribute #:buffer buffer
+                         #:type 'vec2
+                         #:component-type 'float
+                         #:length 4
+                         #:offset 8))
 

 
 
To render a square, the GPU needs to draw two triangles, which means
@@ -152,14 +152,14 @@ for a square, but 2 of them must be repeated for each triangle.  To
 work with deduplicated vertex data, an “index buffer” must be
 created.
 

-

-
(define index-buffer
-  (make-buffer (u32vector 0 3 2 0 2 1)
-               #:target 'index)
-(define indices
-  (make-vertex-attribute #:type 'scalar
-                         #:component-type 'unsigned-int
-                         #:buffer index-buffer))
+

+
(define index-buffer
+  (make-buffer (u32vector 0 3 2 0 2 1)
+               #:target 'index)
+(define indices
+  (make-vertex-attribute #:type 'scalar
+                         #:component-type 'unsigned-int
+                         #:buffer index-buffer))
 

 
 
Note the use of the #:target keyword argument.  It is required
@@ -172,11 +172,11 @@ each vertex attribute with an attribute index on the GPU.  The indices
 that are chosen must correspond with the indices that the shader
 (see Shaders) expects for each attribute.
 

-

-
(define vertex-array
-  (make-vertex-array #:indices indices
-                     #:attributes `((0 . ,vertices)
-                                    (1 . ,texcoords))))
+

+
(define vertex-array
+  (make-vertex-array #:indices indices
+                     #:attributes `((0 . ,vertices)
+                                    (1 . ,texcoords))))
 

 
 
With the vertex array created, the GPU is now fully aware of how to
@@ -190,7 +190,7 @@ shapes, or particles to see GPU buffers in action.
 
Without further ado, the API reference:
 

 

-
Procedure: make-buffer data [#:name "anonymous"]        [#:length] [#:offset 0] [#:stride 0] [#:target vertex]        [#:usage static]

+
Procedure: make-buffer data [#:name "anonymous"]        [#:length] [#:offset 0] [#:stride 0] [#:target vertex]        [#:usage static]

 

 
Upload data, a bytevector, to the GPU.  By default, the entire
 bytevector is uploaded.  A subset of the data may be uploaded by
@@ -304,7 +304,7 @@ contents dynamically, such as a sprite batch.
 

 
 

-
Procedure: make-vertex-attribute #:buffer #:type        #:component-type #:length [#:offset 0] [#:divisor 1]        [#:name "anonymous"]

+
Procedure: make-vertex-attribute #:buffer #:type        #:component-type #:length [#:offset 0] [#:divisor 1]        [#:name "anonymous"]

 

 
Return a new vertex attribute for buffer starting at byte index
 offset of length elements, where each element is of
@@ -411,10 +411,10 @@ attributes indices and the vertex attribute data within
 
attributes is an alist mapping shader attribute indices to
 vertex attributes:
 

-

-
`((1 . ,vertex-attribute-a)
-  (2 . ,vertex-attribute-b)
-  …)
+

+
`((1 . ,vertex-attribute-a)
+  (2 . ,vertex-attribute-b)
+  ...)
 

 
 
By default, the vertex array is interpreted as containing a series of
@@ -470,7 +470,7 @@ data for vertex-array.
 
Render state for vertex arrays (see Rendering Engine.)
 

 
-

+

 

 

 Next: , Previous: , Up: Graphics   [Contents][Index]

diff --git a/manuals/chickadee/Channels.html b/manuals/chickadee/Channels.html
index 24c3dba..78f8564 100644
--- a/manuals/chickadee/Channels.html
+++ b/manuals/chickadee/Channels.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Channels (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Previous: , Up: Scripting   [Contents][Index]

 

-

+

 
5.5.4 Channels

 
 
Channels are a tool for communicating amongst different scripts.  One
@@ -94,18 +94,18 @@ someone on the other end of the line to complete the transaction.
 

 
Here’s a simplistic example:
 

-

-
(define c (make-channel))
-
-(script
- (forever
-  (let ((item (channel-get c)))
-    (pk 'got item))))
-
-(script
- (channel-put c 'sword)
- (channel-put c 'shield)
- (channel-put c 'potion))
+

+
(define c (make-channel))
+
+(script
+ (forever
+  (let ((item (channel-get c)))
+    (pk 'got item))))
+
+(script
+ (channel-put c 'sword)
+ (channel-put c 'shield)
+ (channel-put c 'potion))
 

 
 

diff --git a/manuals/chickadee/Colors.html b/manuals/chickadee/Colors.html
index a7fc10f..4a361b1 100644
--- a/manuals/chickadee/Colors.html
+++ b/manuals/chickadee/Colors.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Colors (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Next: , Up: Graphics   [Contents][Index]

 

-

+

 
5.3.1 Colors

 
 
Merriam-Webster defines color as “a phenomenon of light (such as red,
@@ -106,18 +106,18 @@ depending on what’s most convenient.  The first is make-color
 where you specify each channel exactly as described above.  This is
 fully opaque magenta:
 

-

-
(make-color 1.0 0.0 1.0 1.0)
+

+
(make-color 1.0 0.0 1.0 1.0)
 

 
 
Many people are used to representing colors as 6 or 8 digit
 hexadecimal numbers, so Chickadee also allows that.  Here’s magenta,
 again:
 

-

-
(rgba #xFF00FFFF)
-(rgb #xFF00FF) ; equivalent to the above
-

+

+
(rgba #xFF00FFFF)
+(rgb #xFF00FF) ; equivalent to the above
+

 
 

 
Procedure: make-color r g b a

@@ -179,11 +179,11 @@ transparent.
 
Convert the hexadecimal color code in the string s to a color
 object.  The following string formats are supported:
 

-

-
(string->color "#FF00FFFF")
-(string->color "FF00FFFF")
-(string->color "#FF00FF")
-(string->color "FF00FF")
+

+
(string->color "#FF00FFFF")
+(string->color "FF00FFFF")
+(string->color "#FF00FF")
+(string->color "FF00FF")
 

 
 

@@ -365,7 +365,7 @@ factor alpha, a number in the range [0, 1].
 
Variable: tango-aluminium-6

 
 
-

+

 

 

 Next: , Up: Graphics   [Contents][Index]

diff --git a/manuals/chickadee/Command-Line-Interface.html b/manuals/chickadee/Command-Line-Interface.html
index 787c652..01d2e90 100644
--- a/manuals/chickadee/Command-Line-Interface.html
+++ b/manuals/chickadee/Command-Line-Interface.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Command Line Interface (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Next: , Previous: , Up: Top   [Contents][Index]

 

-

+

 
3 Command Line Interface

 
 
While Chickadee is a library at heart, it also comes with a command
diff --git a/manuals/chickadee/Copying-This-Manual.html b/manuals/chickadee/Copying-This-Manual.html
index 4738441..9fd7c29 100644
--- a/manuals/chickadee/Copying-This-Manual.html
+++ b/manuals/chickadee/Copying-This-Manual.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Copying This Manual (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,11 +84,11 @@ ul.no-bullet {list-style: none}
 

 Next: , Previous: , Up: Top   [Contents][Index]

 

-

+

 
Appendix A Copying This Manual
-
• GNU Free Documentation License  License for copying this manual. +
• Apache 2.0 License  License for copying this manual.
diff --git a/manuals/chickadee/Data-Structures.html b/manuals/chickadee/Data-Structures.html index db95890..d268bf3 100644 --- a/manuals/chickadee/Data-Structures.html +++ b/manuals/chickadee/Data-Structures.html @@ -1,6 +1,6 @@ - - + --> + - + Data Structures (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

Previous: , Up: API Reference   [Contents][Index]

-
+

5.6 Data Structures

diff --git a/manuals/chickadee/Easings.html b/manuals/chickadee/Easings.html index 6169f14..67aba95 100644 --- a/manuals/chickadee/Easings.html +++ b/manuals/chickadee/Easings.html @@ -1,6 +1,6 @@ - - + --> + - +Easings (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

Next: , Previous: , Up: Math   [Contents][Index]

-
+

5.2.6 Easings

Easing functions are essential for animation. Each easing function diff --git a/manuals/chickadee/Fonts.html b/manuals/chickadee/Fonts.html index a442f91..9383789 100644 --- a/manuals/chickadee/Fonts.html +++ b/manuals/chickadee/Fonts.html @@ -1,6 +1,6 @@ - - + --> + - + Fonts (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,13 +84,13 @@ ul.no-bullet {list-style: none}

Next: , Previous: , Up: Graphics   [Contents][Index]

-
+

5.3.4 Fonts

Printing text to the screen is quite easy:

-
-
(draw-text "Hello, world" (vec2 100.0 100.0))
+

+
(draw-text "Hello, world" (vec2 100.0 100.0))
 

 
 
Chickadee supports OpenType/TrueType fonts (via the FreeType library),
@@ -100,16 +100,20 @@ rendering operations where a font is not specified, as is the case in
 the above example.
 

 
The following procedures can be found in the (chickadee graphics
-font) module:
+text) module:
 

 

-
Procedure: load-font file-name point-size [#:char-set]

+
Procedure: load-font file-name point-size [#:char-set] [#:smooth? #t]

 
Load the scalable (OpenType, TrueType, etc.) font in the file
 file-name and display it at the given point-size.  By
 default, all the characters in the ASCII character set are loaded.
 This can be changed by passing a different character set
 (see Character Sets in GNU Guile Reference Manual) using
 the char-set keyword argument.
+

+
If smooth? is #t (the default), text rendered with this
+font will have a smoother appearance when text is rotated or scaled,
+otherwise non-smooth scaling will be used.
 

 
 

@@ -157,8 +161,8 @@ and return a new font object.
 position using font.  If font is not specified, a
 built-in font is used.
 

-

-
(draw-text "Hello, world!" (vec2 128.0 128.0))
+

+
(draw-text "Hello, world!" (vec2 128.0 128.0))
 

 
 
To render a substring of text, use the start and end
@@ -168,7 +172,7 @@ arguments.
 the other arguments.
 

 
-

+

 

 

 Next: , Previous: , Up: Graphics   [Contents][Index]

diff --git a/manuals/chickadee/Framebuffers.html b/manuals/chickadee/Framebuffers.html
index a3d247d..6560323 100644
--- a/manuals/chickadee/Framebuffers.html
+++ b/manuals/chickadee/Framebuffers.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Framebuffers (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Next: , Previous: , Up: Graphics   [Contents][Index]

 

-

+

 
5.3.14 Framebuffers

 
 
A framebuffer is a chunk of memory that the GPU can render things
diff --git a/manuals/chickadee/GNU-Free-Documentation-License.html b/manuals/chickadee/GNU-Free-Documentation-License.html
deleted file mode 100644
index b940738..0000000
--- a/manuals/chickadee/GNU-Free-Documentation-License.html
+++ /dev/null
@@ -1,566 +0,0 @@
-
-
-
-
-
-
-GNU Free Documentation License (The Chickadee Game Toolkit)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-

-Up: Copying This Manual   [Contents][Index]

-

-

-
A.1 GNU Free Documentation License

-
Version 1.3, 3 November 2008
-

-
-

-
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
-http://fsf.org/
-
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-

-
-
    
-
  1.  PREAMBLE
-
-
    The purpose of this License is to make a manual, textbook, or other
-functional and useful document free in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
    
-
    This License is a kind of “copyleft”, which means that derivative
-works of the document must themselves be free in the same sense.  It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
    
-
    We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does.  But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book.  We recommend this License
-principally for works whose purpose is instruction or reference.
-
    
-
  2.  APPLICABILITY AND DEFINITIONS
-
-
    This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License.  Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein.  The “Document”, below,
-refers to any such manual or work.  Any member of the public is a
-licensee, and is addressed as “you”.  You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
    
-
    A “Modified Version” of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
    
-
    A “Secondary Section” is a named appendix or a front-matter section
-of the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document’s overall
-subject (or to related matters) and contains nothing that could fall
-directly within that overall subject.  (Thus, if the Document is in
-part a textbook of mathematics, a Secondary Section may not explain
-any mathematics.)  The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
    
-
    The “Invariant Sections” are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License.  If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant.  The Document may contain zero
-Invariant Sections.  If the Document does not identify any Invariant
-Sections then there are none.
-
    
-
    The “Cover Texts” are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License.  A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
    
-
    A “Transparent” copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters.  A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text.  A copy that is not “Transparent” is called “Opaque”.
-
    
-
    Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input
-format, SGML or XML using a publicly available
-DTD, and standard-conforming simple HTML,
-PostScript or PDF designed for human modification.  Examples
-of transparent image formats include PNG, XCF and
-JPG.  Opaque formats include proprietary formats that can be
-read and edited only by proprietary word processors, SGML or
-XML for which the DTD and/or processing tools are
-not generally available, and the machine-generated HTML,
-PostScript or PDF produced by some word processors for
-output purposes only.
-
    
-
    The “Title Page” means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page.  For works in
-formats which do not have any title page as such, “Title Page” means
-the text near the most prominent appearance of the work’s title,
-preceding the beginning of the body of the text.
-
    
-
    The “publisher” means any person or entity that distributes copies
-of the Document to the public.
-
    
-
    A section “Entitled XYZ” means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language.  (Here XYZ stands for a
-specific section name mentioned below, such as “Acknowledgements”,
-“Dedications”, “Endorsements”, or “History”.)  To “Preserve the Title”
-of such a section when you modify the Document means that it remains a
-section “Entitled XYZ” according to this definition.
-
    
-
    The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document.  These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
    
-
  3.  VERBATIM COPYING
-
-
    You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License.  You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute.  However, you may accept
-compensation in exchange for copies.  If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
    
-
    You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
    
-
  4.  COPYING IN QUANTITY
-
-
    If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document’s license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover.  Both covers must also clearly and legibly identify
-you as the publisher of these copies.  The front cover must present
-the full title with all words of the title equally prominent and
-visible.  You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
    
-
    If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
    
-
    If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
    
-
    It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
    
-
  5.  MODIFICATIONS
-
-
    You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it.  In addition, you must do these things in the Modified Version:
-
    
-
      
-
    1.  Use in the Title Page (and on the covers, if any) a title distinct
-from that of the Document, and from those of previous versions
-(which should, if there were any, be listed in the History section
-of the Document).  You may use the same title as a previous version
-if the original publisher of that version gives permission.
-
-
    2.  List on the Title Page, as authors, one or more persons or entities
-responsible for authorship of the modifications in the Modified
-Version, together with at least five of the principal authors of the
-Document (all of its principal authors, if it has fewer than five),
-unless they release you from this requirement.
-
-
    3.  State on the Title page the name of the publisher of the
-Modified Version, as the publisher.
-
-
    4.  Preserve all the copyright notices of the Document.
-
-
    5.  Add an appropriate copyright notice for your modifications
-adjacent to the other copyright notices.
-
-
    6.  Include, immediately after the copyright notices, a license notice
-giving the public permission to use the Modified Version under the
-terms of this License, in the form shown in the Addendum below.
-
-
    7.  Preserve in that license notice the full lists of Invariant Sections
-and required Cover Texts given in the Document’s license notice.
-
-
    8.  Include an unaltered copy of this License.
-
-
    9.  Preserve the section Entitled “History”, Preserve its Title, and add
-to it an item stating at least the title, year, new authors, and
-publisher of the Modified Version as given on the Title Page.  If
-there is no section Entitled “History” in the Document, create one
-stating the title, year, authors, and publisher of the Document as
-given on its Title Page, then add an item describing the Modified
-Version as stated in the previous sentence.
-
-
    10.  Preserve the network location, if any, given in the Document for
-public access to a Transparent copy of the Document, and likewise
-the network locations given in the Document for previous versions
-it was based on.  These may be placed in the “History” section.
-You may omit a network location for a work that was published at
-least four years before the Document itself, or if the original
-publisher of the version it refers to gives permission.
-
-
    11.  For any section Entitled “Acknowledgements” or “Dedications”, Preserve
-the Title of the section, and preserve in the section all the
-substance and tone of each of the contributor acknowledgements and/or
-dedications given therein.
-
-
    12.  Preserve all the Invariant Sections of the Document,
-unaltered in their text and in their titles.  Section numbers
-or the equivalent are not considered part of the section titles.
-
-
    13.  Delete any section Entitled “Endorsements”.  Such a section
-may not be included in the Modified Version.
-
-
    14.  Do not retitle any existing section to be Entitled “Endorsements” or
-to conflict in title with any Invariant Section.
-
-
    15.  Preserve any Warranty Disclaimers.
-
    
-
-
    If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant.  To do this, add their titles to the
-list of Invariant Sections in the Modified Version’s license notice.
-These titles must be distinct from any other section titles.
-
    
-
    You may add a section Entitled “Endorsements”, provided it contains
-nothing but endorsements of your Modified Version by various
-parties—for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
    
-
    You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version.  Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity.  If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
    
-
    The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
    
-
  6.  COMBINING DOCUMENTS
-
-
    You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
    
-
    The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy.  If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
    
-
    In the combination, you must combine any sections Entitled “History”
-in the various original documents, forming one section Entitled
-“History”; likewise combine any sections Entitled “Acknowledgements”,
-and any sections Entitled “Dedications”.  You must delete all
-sections Entitled “Endorsements.”
-
    
-
  7.  COLLECTIONS OF DOCUMENTS
-
-
    You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
    
-
    You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
    
-
  8.  AGGREGATION WITH INDEPENDENT WORKS
-
-
    A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an “aggregate” if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation’s users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
    
-
    If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document’s Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
    
-
  9.  TRANSLATION
-
-
    Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections.  You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers.  In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
    
-
    If a section in the Document is Entitled “Acknowledgements”,
-“Dedications”, or “History”, the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
    
-
  10.  TERMINATION
-
-
    You may not copy, modify, sublicense, or distribute the Document
-except as expressly provided under this License.  Any attempt
-otherwise to copy, modify, sublicense, or distribute it is void, and
-will automatically terminate your rights under this License.
-
    
-
    However, if you cease all violation of this License, then your license
-from a particular copyright holder is reinstated (a) provisionally,
-unless and until the copyright holder explicitly and finally
-terminates your license, and (b) permanently, if the copyright holder
-fails to notify you of the violation by some reasonable means prior to
-60 days after the cessation.
-
    
-
    Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
    
-
    Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, receipt of a copy of some or all of the same material does
-not give you any rights to use it.
-
    
-
  11.  FUTURE REVISIONS OF THIS LICENSE
-
-
    The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time.  Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.  See
-http://www.gnu.org/copyleft/.
-
    
-
    Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License “or any later version” applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation.  If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.  If the Document
-specifies that a proxy can decide which future versions of this
-License can be used, that proxy’s public statement of acceptance of a
-version permanently authorizes you to choose that version for the
-Document.
-
    
-
  12.  RELICENSING
-
-
    “Massive Multiauthor Collaboration Site” (or “MMC Site”) means any
-World Wide Web server that publishes copyrightable works and also
-provides prominent facilities for anybody to edit those works.  A
-public wiki that anybody can edit is an example of such a server.  A
-“Massive Multiauthor Collaboration” (or “MMC”) contained in the
-site means any set of copyrightable works thus published on the MMC
-site.
-
    
-
    “CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0
-license published by Creative Commons Corporation, a not-for-profit
-corporation with a principal place of business in San Francisco,
-California, as well as future copyleft versions of that license
-published by that same organization.
-
    
-
    “Incorporate” means to publish or republish a Document, in whole or
-in part, as part of another Document.
-
    
-
    An MMC is “eligible for relicensing” if it is licensed under this
-License, and if all works that were first published under this License
-somewhere other than this MMC, and subsequently incorporated in whole
-or in part into the MMC, (1) had no cover texts or invariant sections,
-and (2) were thus incorporated prior to November 1, 2008.
-
    
-
    The operator of an MMC Site may republish an MMC contained in the site
-under CC-BY-SA on the same site at any time before August 1, 2009,
-provided the MMC is eligible for relicensing.
-
    
-

-
-
ADDENDUM: How to use this License for your documents

-
-
To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-

-

-
  Copyright (C)  year  your name.
-  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''.
-

-
-
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the “with…Texts.” line with this:
-

-

-
    with the Invariant Sections being list their titles, with
-    the Front-Cover Texts being list, and with the Back-Cover Texts
-    being list.
-

-
-
If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-

-
If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-

-
-

-

-

-Up: Copying This Manual   [Contents][Index]

-

-
-
-
-
-
diff --git a/manuals/chickadee/Getting-Started.html b/manuals/chickadee/Getting-Started.html
index 7508ebe..e7d695d 100644
--- a/manuals/chickadee/Getting-Started.html
+++ b/manuals/chickadee/Getting-Started.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Getting Started (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,15 +84,15 @@ ul.no-bullet {list-style: none}
 

 Next: , Previous: , Up: Top   [Contents][Index]
-
+

2 Getting Started

One of the simplest programs we can make with Chickadee is rendering the text “Hello, world” on screen. Here’s what that looks like:

-
-
(define (draw alpha)
-  (draw-text "Hello, world!" (vec2 64.0 240.0)))
+

+
(define (draw alpha)
+  (draw-text "Hello, world!" (vec2 64.0 240.0)))
 

 
 
The draw procedure is called frequently to draw the game scene.
@@ -107,14 +107,14 @@ in this tutorial.
 
 
This is a good start, but it’s boring.  Let’s make the text move!
 

-

-
(define position (vec2 0.0 240.0))
+

+
(define position (vec2 0.0 240.0))
 
-(define (draw alpha)
-  (draw-text "Hello, world!" position))
+(define (draw alpha)
+  (draw-text "Hello, world!" position))
 
-(define (update dt)
-  (set-vec2-x! position (+ (vec2-x position) (* 100.0 dt))))
+(define (update dt)
+  (set-vec2-x! position (+ (vec2-x position) (* 100.0 dt))))
 

 
 
The vec2 type is used to store 2D coordinates
@@ -131,25 +131,25 @@ the position by 100 pixels per second.
 completely, never to be seen again.  It would be better if the text
 bounced back and forth against the sides of the window.
 

-

-
(define position (vec2 0.0 240.0))
+

+
(define position (vec2 0.0 240.0))
 
-(define (draw alpha)
-  (draw-text "Hello, world!" position))
+(define (draw alpha)
+  (draw-text "Hello, world!" position))
 
-(define (update dt)
-  (update-agenda dt))
+(define (update dt)
+  (update-agenda dt))
 
-(define (update-x x)
-  (set-vec2-x! position x))
+(define (update-x x)
+  (set-vec2-x! position x))
 
-(let ((start 0.0)
-      (end 536.0)
-      (duration 4.0))
-  (script
-   (while #t
-    (tween duration start end update-x)
-    (tween duration end start update-x))))
+(let ((start 0.0)
+      (end 536.0)
+      (duration 4.0))
+  (script
+   (while #t
+    (tween duration start end update-x)
+    (tween duration end start update-x))))
 

 
 
This final example uses Chickadee’s scripting features
@@ -165,7 +165,7 @@ that were glossed over, and much more.  Try rendering a sprite,
 playing a sound effect, or handling keyboard input.  But most
 importantly: Have fun!
 

-

+

 

 

 Next: , Previous: , Up: Top   [Contents][Index]

diff --git a/manuals/chickadee/Graphics.html b/manuals/chickadee/Graphics.html
index 31a2c83..e8b409b 100644
--- a/manuals/chickadee/Graphics.html
+++ b/manuals/chickadee/Graphics.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Graphics (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 

 Next: , Previous: , Up: API Reference   [Contents][Index]

 

-

+

 
5.3 Graphics

 
 
Chickadee aims to make hardware-accelerated graphics rendering as
@@ -133,7 +133,7 @@ blocks to implement additional rendering techniques.
-
+

Next: , Previous: , Up: API Reference   [Contents][Index]

diff --git a/manuals/chickadee/Grids.html b/manuals/chickadee/Grids.html index ef364be..e8ec2b6 100644 --- a/manuals/chickadee/Grids.html +++ b/manuals/chickadee/Grids.html @@ -1,6 +1,6 @@ - - + --> + - + Grids (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

Next: , Previous: , Up: Data Structures   [Contents][Index]

-
+

5.6.5 Grids

The (chickadee data grid) module provides a simple spatial @@ -202,7 +202,7 @@ the minimum amount needed to make it no longer overlap other-rect.

-
+

Next: , Previous: , Up: Data Structures   [Contents][Index]

diff --git a/manuals/chickadee/Heaps.html b/manuals/chickadee/Heaps.html index 8aea793..effdb89 100644 --- a/manuals/chickadee/Heaps.html +++ b/manuals/chickadee/Heaps.html @@ -1,6 +1,6 @@ - - + --> + - + Heaps (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

Next: , Previous: , Up: Data Structures   [Contents][Index]

-
+

5.6.3 Heaps

The (chickadee data heap) module provides a binary heap data diff --git a/manuals/chickadee/Index.html b/manuals/chickadee/Index.html index bc184bd..4d64ac2 100644 --- a/manuals/chickadee/Index.html +++ b/manuals/chickadee/Index.html @@ -1,6 +1,6 @@ - - + --> + - + Index (The Chickadee Game Toolkit) - - - - - - - - - - + + + + + + + + + + - + @@ -83,12 +83,12 @@ ul.no-bullet {list-style: none}

Previous: , Up: Top   [Contents][Index]

-
+

Index

Jump to:   %   -
+
A   B @@ -140,10 +140,10 @@ Previous:
- + - + @@ -183,7 +183,7 @@ Previous:
Index Entry  Section
%
%default-config: Invoking chickadee bundle
A
a*: Path Finding
abort-game: The Game Loop
audio-play: Audio Files
audio-sample-rate: Audio Files
audio?: Audio Files
B
back-cull-face-mode: Render Settings
below: Vector Paths
buffer-target: Buffers
buffer-usage: Buffers
buffer?: Buffers
C
call-when: Agendas
cancel-script: Scripts
current-viewport: Viewports
current-window: Window Manipulation
cyan: Colors
D
default-stencil-test: Render Settings
define-shader-type: Shaders
draw-sprite-batch: Sprites
draw-text: Fonts
draw-tile-map: Tile Maps
E
ease-in-cubic: Easings
ease-in-out-cubic: Easings
enqueue!: Queues
every: Agendas
every: Agendas
F
fill: Vector Paths
fill-and-stroke: Vector Paths
framebuffer?: Framebuffers
front-and-back-cull-face-mode: Render Settings
front-cull-face-mode: Render Settings
G
g:buffer: Buffers
g:cull-face-mode: Render Settings
grid-move: Grids
grid-remove: Grids
grid?: Grids
H
heap-clear!: Heaps
heap-empty?: Heaps
heap?: Heaps
hide-window!: Window Manipulation
horizontal-flip: Vector Paths
I
index-buffer?: Buffers
int: Shaders
J
join: Scripts
K
key-pressed?: Input Devices
key-released?: Input Devices
L
lerp: Basics
light-color: Lights
load-tile-map: Tile Maps
load-tileset: Textures
local-field: Shaders
M
magenta: Colors
make-agenda: Agendas
mouse-x: Input Devices
mouse-y: Input Devices
move-to: Vector Paths
N
no-cull-face-mode: Render Settings
null-buffer: Buffers
null-framebuffer: Framebuffers
null-shader: Shaders
null-vertex-array: Buffers
O
object-layer-name: Tile Maps
object-layer-objects: Tile Maps
object-layer-properties: Tile Maps
object-layer?: Tile Maps
orthographic-projection: Matrices
P
pad: Vector Paths
particle-emitter-done?: Particles
primitive-name: Meshes
primitive-vertex-array: Meshes
primitive?: Meshes
Q
quadtree-bounds: Quadtrees
quadtree-clear!: Quadtrees
queue-empty?: Queues
queue-length: Queues
queue?: Queues
R
radial-gradient: Vector Paths
radians->degrees: Basics
rounded-rectangle: Vector Paths
run-game: The Game Loop
run-game*: The Game Loop
S
sampler-2d: Shaders
sampler-cube: Shaders
strings->shader: Shaders
stroke: Vector Paths
superimpose: Vector Paths
T
tango-aluminium-1: Colors
tango-aluminium-2: Colors
translate: Vector Paths
transparency: Colors
tween: Tweening
U
uniform-name: Shaders
uniform-type: Shaders
up-split: Vector Paths
update-agenda: Agendas
update-particles: Particles
V
vec2: Vectors
vec2*: Vectors
viewport-x: Viewports
viewport-y: Viewports
viewport?: Viewports
W
wait-until: Scripts
white: Colors
with-mapped-vertex-attribute: Buffers
with-projection: Rendering Engine
with-style: Vector Paths
Y
yellow: Colors
yield: Scripts

, Up: Top   [Contents][Index]

diff --git a/manuals/chickadee/Input-Devices.html b/manuals/chickadee/Input-Devices.html index b3baf96..93b86d4 100644 --- a/manuals/chickadee/Input-Devices.html +++ b/manuals/chickadee/Input-Devices.html @@ -1,6 +1,6 @@ - - + --> + - + Input Devices (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

Next: , Previous: , Up: Kernel   [Contents][Index]

-
+

5.1.2 Input Devices

While run-game provides hooks for mouse/keyboard/controller diff --git a/manuals/chickadee/Installation.html b/manuals/chickadee/Installation.html index d02aaaa..810d4d0 100644 --- a/manuals/chickadee/Installation.html +++ b/manuals/chickadee/Installation.html @@ -1,6 +1,6 @@ - - + --> + - + Installation (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

Next: , Previous: , Up: Top   [Contents][Index]

-
+

1 Installation

Chickadee is available for download from its website at diff --git a/manuals/chickadee/Invoking-chickadee-bundle.html b/manuals/chickadee/Invoking-chickadee-bundle.html index 5c9e8f6..060c8ad 100644 --- a/manuals/chickadee/Invoking-chickadee-bundle.html +++ b/manuals/chickadee/Invoking-chickadee-bundle.html @@ -1,6 +1,6 @@ - - + --> + - + Invoking chickadee bundle (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

Previous: , Up: Command Line Interface   [Contents][Index]

-
+

3.2 Invoking chickadee bundle

Distributing games is difficult. While Chickadee games are free @@ -121,11 +121,11 @@ let’s get back to reality.

To get started with bundling, simply add a bundle.scm file to the root of the project directory. It could look something like this:

-
-
'((asset-directories . ("images" "models"))
-  (bundle-name . "the-legend-of-emacs-1.0")
-  (code . "the-legend-of-emacs.scm")
-  (launcher-name . "the-legend-of-emacs"))
+

+
'((asset-directories . ("images" "models"))
+  (bundle-name . "the-legend-of-emacs-1.0")
+  (code . "the-legend-of-emacs.scm")
+  (launcher-name . "the-legend-of-emacs"))
 

 
 
To create the bundle, simply run chickadee bundle.  Upon
@@ -160,12 +160,12 @@ archive.
 
  •  bundle-name
 
 
    The name of the bundle archive.  By default, the name is
-"chickadee-bundle".
+"chickadee-bundle".
 
    
 
  •  launcher-name
 
 
    The name of the launcher script.  By default, the name is
-"launch-game".
+"launch-game".
 
    
 
  •  libraries
 
@@ -207,7 +207,7 @@ can be programatically modified, if necessary.
 
    An association list of default configuration options.
 
    
 
-
    
+
    
 
    
 
    
 Previous: , Up: Command Line Interface   [Contents][Index]
    
diff --git a/manuals/chickadee/Invoking-chickadee-play.html b/manuals/chickadee/Invoking-chickadee-play.html
index 2841c18..786626a 100644
--- a/manuals/chickadee/Invoking-chickadee-play.html
+++ b/manuals/chickadee/Invoking-chickadee-play.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Invoking chickadee play (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Up: Command Line Interface   [Contents][Index]
    
 
    
-
    
+
    
 
    3.1 Invoking chickadee play
    
 
 
    The chickadee play command is used to open a window and run
@@ -166,6 +166,14 @@ controlled via the following options:
 
    Update the game n times per second.
 
    
 
+
    --clear-color=color
    
+
    -c color
    
+
    
+
    Set the screen clear color to color, a hex code in the format
+#RRGGBB.  For example, to set the clear color to black, pass
+--clear-color=#000000.
+
    
+
    
 
    --repl
    
 
    
 
    Launch a REPL in the terminal.  This will allow the game environment
@@ -206,7 +214,7 @@ Here’s what a “hello, world” Chickadee program looks like in W
 
    
 
    
 
    define : draw alpha
-  draw-text "Hello, world!" : vec2 260.0 240.0
+  draw-text "Hello, world!" : vec2 260.0 240.0
 
    
 
 
    Assuming the above code is saved to a hello.w file,
@@ -219,7 +227,7 @@ Here’s what a “hello, world” Chickadee program looks like in W
 
    
 
 
-
    
+
    
 
    
 
    
 Next: , Up: Command Line Interface   [Contents][Index]
    
diff --git a/manuals/chickadee/Kernel.html b/manuals/chickadee/Kernel.html
index 64647aa..da55234 100644
--- a/manuals/chickadee/Kernel.html
+++ b/manuals/chickadee/Kernel.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Kernel (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Up: API Reference   [Contents][Index]
    
 
    
-
    
+
    
 
    5.1 Kernel
    
 
 
    This section of the manual covers the foundation of Chickadee: The
diff --git a/manuals/chickadee/Lights.html b/manuals/chickadee/Lights.html
index 1e6d234..4ae75ff 100644
--- a/manuals/chickadee/Lights.html
+++ b/manuals/chickadee/Lights.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Lights (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    • -
    +

    5.3.9 Lights

    The (chickadee graphics light) module provides a data type for @@ -200,7 +200,7 @@ only relevant for spot lights.

    Set the cut off angle of light to cut-off.

    -
    +

    Next: , Previous: , Up: Graphics   [Contents][Index]

    diff --git a/manuals/chickadee/Live-Coding.html b/manuals/chickadee/Live-Coding.html index 4e3c174..e34b29e 100644 --- a/manuals/chickadee/Live-Coding.html +++ b/manuals/chickadee/Live-Coding.html @@ -1,6 +1,6 @@ - - + --> + - + Live Coding (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

    Next: , Previous: , Up: Top   [Contents][Index]

    -
    +

    4 Live Coding

    One of the biggest appeals of any Lisp dialect is the ability to use @@ -108,17 +108,17 @@ Then, in the game loop’s update procedure, call poll-coop-repl-server and pass the REPL object. Here is a template to follow:

    -
    -
    (use-modules (chickadee)
-             (system repl coop-server))
+
    
+
    (use-modules (chickadee)
+             (system repl coop-server))
 
-(define repl (spawn-coop-repl-server))
+(define repl (spawn-coop-repl-server))
 
-(define (update dt)
-  (poll-coop-repl-server repl)
-  ...)
+(define (update dt)
+  (poll-coop-repl-server repl)
+  ...)
 
-(run-game #:update update ...)
+(run-game #:update update ...)
 
    
 
 
    To use the REPL, connect to it via port 37146.  Telnet will do the
diff --git a/manuals/chickadee/Math.html b/manuals/chickadee/Math.html
index b3e4b0a..7b6456c 100644
--- a/manuals/chickadee/Math.html
+++ b/manuals/chickadee/Math.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Math (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: API Reference   [Contents][Index]
    -
    +

    5.2 Math

    Chickadee contains data types and procedures for performing the most diff --git a/manuals/chickadee/Matrices.html b/manuals/chickadee/Matrices.html index 354a9ef..bf65917 100644 --- a/manuals/chickadee/Matrices.html +++ b/manuals/chickadee/Matrices.html @@ -1,6 +1,6 @@ - - + --> + - + Matrices (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

    Next: , Previous: , Up: Math   [Contents][Index]

    -
    +

    5.2.4 Matrices

    The (chickadee math matrix) module provides an interface for @@ -118,10 +118,10 @@ format. identity matrix yields the original matrix. This procedure is equivalent to the following code:

    -
    -
    (make-matrix3 1 0 0
-              0 1 0
-              0 0 1)
+
    
+
    (make-matrix3 1 0 0
+              0 1 0
+              0 0 1)
 
    
 
 
@@ -247,11 +247,11 @@ column-major format.
 identity matrix yields the original matrix.  This procedure is
 equivalent to the following code:
 
    
-
    
-
    (make-matrix4 1 0 0 0
-              0 1 0 0
-              0 0 1 0
-              0 0 0 1)
+
    
+
    (make-matrix4 1 0 0 0
+              0 1 0 0
+              0 0 1 0
+              0 0 0 1)
 
    
 
 
@@ -397,7 +397,7 @@ particular transformation will not be included in the result.
 matrix matrix.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Math   [Contents][Index]
    
diff --git a/manuals/chickadee/Meshes.html b/manuals/chickadee/Meshes.html
index 2cd159e..7e66c4d 100644
--- a/manuals/chickadee/Meshes.html
+++ b/manuals/chickadee/Meshes.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Meshes (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
 
    
-
    
+
    
 
    5.3.11 Meshes
    
 
 
    The (chickadee graphics mesh) modules provides procedures for
@@ -190,7 +190,7 @@ on the lighting model.
 lighting model:
 
    
 
    
-
    Procedure: make-phong-material [#:name "anonymous"] [#:blend-mode]        [#:polygon-mode] [#:cull-face-mode] [#:depth-test] [#:stencil-test]        [#:multisample? #f] [#:ambient-factor (vec3 1 1 1)]        [#:diffuse-factor (vec3 1 1 1)] [#:specular-factor (vec3 1 1 1)]        [#:shininess 32] [#:ambient-texture] [#:diffuse-texture]        [#:specular-texture] [#:normal-texture]
    
+
    Procedure: make-phong-material [#:name "anonymous"] [#:blend-mode]        [#:polygon-mode] [#:cull-face-mode] [#:depth-test] [#:stencil-test]        [#:multisample? #f] [#:ambient-factor (vec3 1 1 1)]        [#:diffuse-factor (vec3 1 1 1)] [#:specular-factor (vec3 1 1 1)]        [#:shininess 32] [#:ambient-texture] [#:diffuse-texture]        [#:specular-texture] [#:normal-texture]
    
 
    
 
    Return a new Blinn-Phong material.
 
    
@@ -231,7 +231,7 @@ lighting model:
 
    The (chickadee graphics pbr) module has the PBR lighting model:
 
    
 
    
-
    Procedure: make-pbr-material [#:name "anonymous"] [#:blend-mode]        [#:polygon-mode] [#:cull-face-mode] [#:depth-test] [#:stencil-test]        [#:multisample? #f] [#:base-color-factor (vec3 1 1 1)]        [#:base-color-texcoord 0] [#:metallic-factor 1.0]        [#:roughness-factor 1.0] [#:metallic-roughness-texcoord 0]        [#:normal-texcoord 0] [#:occlusion-texcoord 0]        [#:emissive-factor (vec3 1 1 1)] [#:emissive-texcoord 0]        [#:alpha-mode opaque] [#:alpha-cutoff 0.5]        [#:base-color-texture] [#:metallic-roughness-texture]        [#:normal-texture] [#:occlusion-texture] [#:emissive-texture]
    
+
    Procedure: make-pbr-material [#:name "anonymous"] [#:blend-mode]        [#:polygon-mode] [#:cull-face-mode] [#:depth-test] [#:stencil-test]        [#:multisample? #f] [#:base-color-factor (vec3 1 1 1)]        [#:base-color-texcoord 0] [#:metallic-factor 1.0]        [#:roughness-factor 1.0] [#:metallic-roughness-texcoord 0]        [#:normal-texcoord 0] [#:occlusion-texcoord 0]        [#:emissive-factor (vec3 1 1 1)] [#:emissive-texcoord 0]        [#:alpha-mode opaque] [#:alpha-cutoff 0.5]        [#:base-color-texture] [#:metallic-roughness-texture]        [#:normal-texture] [#:occlusion-texture] [#:emissive-texture]
    
 
    
 
    Return a new PBR material.
 
    
@@ -401,7 +401,7 @@ triangles in the resulting sphere increases exponentially with each
 increment to quality.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
diff --git a/manuals/chickadee/Models.html b/manuals/chickadee/Models.html
index 3a1a6d6..4d319a1 100644
--- a/manuals/chickadee/Models.html
+++ b/manuals/chickadee/Models.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Models (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
 
    
-
    
+
    
 
    5.3.8 Models
    
 
 
    Disclaimer: Chickadee is alpha software, but 3D model support is
@@ -98,20 +98,20 @@ formats.
 
    
 
    Here’s some basic boilerplate to render a 3D model:
 
    
-
    
-
    (use-modules (chickadee graphics light)
-             (chickadee graphics model)
-             (chickadee graphics skybox))
-
-(define model (load-gltf "Suzanne.gltf"))
-(define camera-position (vec3 0.0 0.0 3.0))
-(define world (make-identity-matrix4))
-(define view (look-at camera-position (vec3 0.0 0.0 0.0) (vec3 0.0 1.0 0.0)))
-(define projection (perspective-projection (/ pi 3.0) (/ 4.0 3.0) 0.1 5.0))
-
-(define (draw alpha)
-  (with-projection projection
-    (draw-model model world view camera-position
+
    
+
    (use-modules (chickadee graphics light)
+             (chickadee graphics model)
+             (chickadee graphics skybox))
+
+(define model (load-gltf "Suzanne.gltf"))
+(define camera-position (vec3 0.0 0.0 3.0))
+(define world (make-identity-matrix4))
+(define view (look-at camera-position (vec3 0.0 0.0 0.0) (vec3 0.0 1.0 0.0)))
+(define projection (perspective-projection (/ pi 3.0) (/ 4.0 3.0) 0.1 5.0))
+
+(define (draw alpha)
+  (with-projection projection
+    (draw-model model world view camera-position
 
    
 
 
    
@@ -155,7 +155,7 @@ smooth metal?  Materials control all of this and more.
 
    
 
    There are two types of materials in Chickadee: Phong and PBR.
 
    
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
diff --git a/manuals/chickadee/Particles.html b/manuals/chickadee/Particles.html
index 38943fa..116e2e6 100644
--- a/manuals/chickadee/Particles.html
+++ b/manuals/chickadee/Particles.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Particles (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
 
    
-
    
+
    
 
    5.3.6 Particles
    
 
 
    Effects like smoke, fire, sparks, etc. are often achieved by animating
@@ -99,10 +99,10 @@ manipulating particle systems.
 
    Below is an example of a very simple particle system that utilizes
 nearly all of the default configuration settings:
 
    
-
    
-
    (use-modules (chickadee graphics particles))
-(define texture (load-image "particle.png"))
-(define particles (make-particles 2000 #:texture texture))
+
    
+
    (use-modules (chickadee graphics particles))
+(define texture (load-image "particle.png"))
+(define particles (make-particles 2000 #:texture texture))
 
    
 
 
    In order to put particles into a particle system, a particle
@@ -112,10 +112,10 @@ how many of them to spawn, and for how long they should do it.
 
    Below is an example of an emitter that spawns 16 particles per frame
 at the coordinates (320, 240):
 
    
-
    
-
    (use-modules (chickadee math rect))
-(define emitter (make-particle-emitter (make-rect 0.0 0.0 320.0 240.0) 16))
-(add-particle-emitter particles emitter)
+
    
+
    (use-modules (chickadee math rect))
+(define emitter (make-particle-emitter (make-rect 0.0 0.0 320.0 240.0) 16))
+(add-particle-emitter particles emitter)
 
    
 
 
    To see all of the tweakable knobs and switches, read on!
@@ -237,10 +237,10 @@ frame.
 
 
    
 
    Procedure: remove-particle-emitter particles emitter
    
-
    Remove emitter to particles
+
    Remove emitter from particles
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
diff --git a/manuals/chickadee/Path-Finding.html b/manuals/chickadee/Path-Finding.html
index 40dc80e..150ef88 100644
--- a/manuals/chickadee/Path-Finding.html
+++ b/manuals/chickadee/Path-Finding.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Path Finding (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Previous: , Up: Data Structures   [Contents][Index]
    
 
    
-
    
+
    
 
    5.6.6 Path Finding
    
 
 
    Most game worlds have maps.  Often, these games have a need to move
@@ -101,19 +101,19 @@ map implementation!
 
    The example below defines a very simple town map and finds the
 quickest way to get from the town common to the school.
 
    
-
    
-
    (define world-map
-  '((town-common . (town-hall library))
-    (town-hall . (town-common school))
-    (library . (town-common cafe))
-    (school . (town-hall cafe))
-    (cafe . (library school))))
-(define (neighbors building)
-  (assq-ref town-map building))
-(define (cost a b) 1)
-(define (distance a b) 1)
-(define pf (make-path-finder))
-(a* pf 'town-common 'school neighbors cost distance)
+
    
+
    (define world-map
+  '((town-common . (town-hall library))
+    (town-hall . (town-common school))
+    (library . (town-common cafe))
+    (school . (town-hall cafe))
+    (cafe . (library school))))
+(define (neighbors building)
+  (assq-ref town-map building))
+(define (cost a b) 1)
+(define (distance a b) 1)
+(define pf (make-path-finder))
+(a* pf 'town-common 'school neighbors cost distance)
 
    
 
 
    In this case, the a* procedure will return the list
@@ -159,7 +159,7 @@ number.  distance is a procedure that accepts two nodes and
 returns an approximate distance between them.
 
    
 
-
    
+
    
 
    
 
    
 Previous: , Up: Data Structures   [Contents][Index]
    
diff --git a/manuals/chickadee/Quadtrees.html b/manuals/chickadee/Quadtrees.html
index e6962a4..5675542 100644
--- a/manuals/chickadee/Quadtrees.html
+++ b/manuals/chickadee/Quadtrees.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Quadtrees (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Data Structures   [Contents][Index]
    
 
    
-
    
+
    
 
    5.6.4 Quadtrees
    
 
 
    The (chickadee data quadtree) module provides a 2D spatial
@@ -210,7 +210,7 @@ quadrants of a Cartesian coordinate system:
 quadtree is a leaf node.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Data Structures   [Contents][Index]
    
diff --git a/manuals/chickadee/Quaternions.html b/manuals/chickadee/Quaternions.html
index 3728f66..be875ee 100644
--- a/manuals/chickadee/Quaternions.html
+++ b/manuals/chickadee/Quaternions.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Quaternions (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Math   [Contents][Index]
    
 
    
-
    
+
    
 
    5.2.5 Quaternions
    
 
 
    In game development, the quaternion is most often used to represent
diff --git a/manuals/chickadee/Queues.html b/manuals/chickadee/Queues.html
index 1df6f78..9e5d238 100644
--- a/manuals/chickadee/Queues.html
+++ b/manuals/chickadee/Queues.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Queues (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Data Structures   [Contents][Index]
    
 
    
-
    
+
    
 
    5.6.2 Queues
    
 
 
    The (chickadee data queue) module provides a mutable queue that
diff --git a/manuals/chickadee/Rectangles.html b/manuals/chickadee/Rectangles.html
index 62d4f16..487fac7 100644
--- a/manuals/chickadee/Rectangles.html
+++ b/manuals/chickadee/Rectangles.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Rectangles (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Math   [Contents][Index]
    
 
    
-
    
+
    
 
    5.2.3 Rectangles
    
 
 
    The (chickadee math rect) module provides an API for
@@ -318,7 +318,7 @@ that rect1 cannot fit completely within rect2.
 within the bounds of rect.  v is modified in-place.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Math   [Contents][Index]
    
diff --git a/manuals/chickadee/Render-Settings.html b/manuals/chickadee/Render-Settings.html
index fe3fa98..66c0eb7 100644
--- a/manuals/chickadee/Render-Settings.html
+++ b/manuals/chickadee/Render-Settings.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Render Settings (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
 
    
-
    
+
    
 
    5.3.16 Render Settings
    
 
 
    5.3.16.1 Blending
    
@@ -500,7 +500,7 @@ graphics multisample) module provides access to the
 
    Render state for multisampling (see Rendering Engine.)
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
diff --git a/manuals/chickadee/Rendering-Engine.html b/manuals/chickadee/Rendering-Engine.html
index 1c90022..8f81fc6 100644
--- a/manuals/chickadee/Rendering-Engine.html
+++ b/manuals/chickadee/Rendering-Engine.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Rendering Engine (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Previous: , Up: Graphics   [Contents][Index]
    
 
    
-
    
+
    
 
    5.3.17 Rendering Engine
    
 
 
    The (chickadee graphics engine) module provides a Scheme
@@ -94,10 +94,10 @@ and state changes happen within the context of this engine.
 
    
 
    Performing a custom draw call could look something like this:
 
    
-
    
-
    (with-graphics-state ((g:blend-mode blend:alpha)
-                      (g:texture-0 my-texture))
-  (shader-apply my-shader #:foo 1))
+
    
+
    (with-graphics-state ((g:blend-mode blend:alpha)
+                      (g:texture-0 my-texture))
+  (shader-apply my-shader #:foo 1))
 
    
 
 
    5.3.17.1 Render States
    
@@ -164,7 +164,7 @@ particle effects described in Particles use instanc
 vertices.
 
    
 
-
    
+
    
 
    
 
    
 Previous: , Up: Graphics   [Contents][Index]
    
diff --git a/manuals/chickadee/Requirements.html b/manuals/chickadee/Requirements.html
index 980a180..1093943 100644
--- a/manuals/chickadee/Requirements.html
+++ b/manuals/chickadee/Requirements.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Requirements (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Up: Installation   [Contents][Index]
    
 
    
-
    
+
    
 
    1.1 Requirements
    
 
 
    Chickadee depends on the following packages:
diff --git a/manuals/chickadee/Scripting.html b/manuals/chickadee/Scripting.html
index 1a285c6..2ef1b5b 100644
--- a/manuals/chickadee/Scripting.html
+++ b/manuals/chickadee/Scripting.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Scripting (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: API Reference   [Contents][Index]
    
 
    
-
    
+
    
 
    5.5 Scripting
    
 
 
    Game logic is a web of asynchronous events that are carefully
diff --git a/manuals/chickadee/Scripts.html b/manuals/chickadee/Scripts.html
index bc82c5f..b62bb2d 100644
--- a/manuals/chickadee/Scripts.html
+++ b/manuals/chickadee/Scripts.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Scripts (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Scripting   [Contents][Index]
    -
    +

    5.5.2 Scripts

    Now that we can schedule tasks, let’s take things to the next level. @@ -98,13 +98,13 @@ turn and prevent blocking the game loop. Building on top of the scheduling that agendas provide, here is a script that models a child trying to get their mother’s attention:

    -
    -
    (script
-  (while #t
-    (display "mom!")
-    (newline)
-    (sleep 60))) ; where 60 = 1 second of real time
-
    +
    +
    (script
+  (while #t
+    (display "mom!")
+    (newline)
+    (sleep 60))) ; where 60 = 1 second of real time
+

    This code runs in an endless loop, but the sleep procedure suspends the script and schedules it to be run later by the agenda. @@ -125,10 +125,10 @@ been started. For example, when an enemy is defeated their AI routine needs to be shut down. When a script is spawned, a handle to that script is returned that can be used to cancel it when desired.

    -
    -
    (define script (script (while #t (display "hey\n") (sleep 60))))
-;; sometime later
-(cancel-script script)
+
    
+
    (define script (script (while #t (display "hey\n") (sleep 60))))
+;; sometime later
+(cancel-script script)
 
    
 
 
    
@@ -187,10 +187,10 @@ procedure handler.
 
    Syntax: wait-until condition
    
 
    Wait until condition is met before resuming the current script.
 
    
-
    
-
    (script
-  (wait-until (key-pressed? 'z))
-  (display "you pressed the Z key!\n"))
+
    
+
    (script
+  (wait-until (key-pressed? 'z))
+  (display "you pressed the Z key!\n"))
 
    
 
 
    
@@ -200,7 +200,7 @@ procedure handler.
 
    Evaluate body in an endless loop.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Scripting   [Contents][Index]
    
diff --git a/manuals/chickadee/Shaders.html b/manuals/chickadee/Shaders.html
index 95c5186..505e031 100644
--- a/manuals/chickadee/Shaders.html
+++ b/manuals/chickadee/Shaders.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Shaders (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
 
    
-
    
+
    
 
    5.3.13 Shaders
    
 
 
    Shaders are programs that the GPU can evaluate that allow the
@@ -139,10 +139,10 @@ Chickadee uses, is to think about it as a function call: The shader is
 a function, and it is applied to some “attributes” (positional
 arguments), and some “uniforms” (keyword arguments).
 
    
-
    
-
    (define my-shader (load-shader "vert.glsl" "frag.glsl"))
-(define vertices (make-vertex-array …))
-(shader-apply my-shader vertices #:color red)
+
    
+
    (define my-shader (load-shader "vert.glsl" "frag.glsl"))
+(define vertices (make-vertex-array ...))
+(shader-apply my-shader vertices #:color red)
 
    
 
 
    See Rendering Engine for more details about the shader-apply
@@ -277,17 +277,17 @@ shader struct.
 
    Some example code will explain this concept best.  Here is the Scheme
 equivalent of the Light struct:
 
    
-
    
-
    (define-shader-type <light>
-  make-light
-  light?
-  (bool enabled light-enabled?)
-  (int type light-type)
-  (float-vec3 position light-position)
-  (float-vec3 direction light-direction)
-  (float-vec4 color light-color)
-  (float intensity light-intensity)
-  (float cut-off light-cut-off))
+
    
+
    (define-shader-type <light>
+  make-light
+  light?
+  (bool enabled light-enabled?)
+  (int type light-type)
+  (float-vec3 position light-position)
+  (float-vec3 direction light-direction)
+  (float-vec4 color light-color)
+  (float intensity light-intensity)
+  (float cut-off light-cut-off))
 
    
 
 
    The macro define-shader-type closely resembles the familiar
@@ -393,7 +393,7 @@ optional.
 
    Return #t if obj is a shader data type object.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
diff --git a/manuals/chickadee/Skyboxes.html b/manuals/chickadee/Skyboxes.html
index 483f22f..07cc5d6 100644
--- a/manuals/chickadee/Skyboxes.html
+++ b/manuals/chickadee/Skyboxes.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Skyboxes (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
 
    
-
    
+
    
 
    5.3.10 Skyboxes
    
 
 
    Skyboxes are used as backgrounds in 3D environments, as well as a
diff --git a/manuals/chickadee/Sources.html b/manuals/chickadee/Sources.html
index c1ca1f3..cca3b56 100644
--- a/manuals/chickadee/Sources.html
+++ b/manuals/chickadee/Sources.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Sources (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Audio   [Contents][Index]
    
 
    
-
    
+
    
 
    5.4.2 Sources
    
 
 
    While the audio-play procedure provides a quick and convenient
@@ -324,7 +324,7 @@ interpreted as relative to the listener’s position.  Otherwise, the
 position of source is in absolute coordinates.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Audio   [Contents][Index]
    
diff --git a/manuals/chickadee/Sprites.html b/manuals/chickadee/Sprites.html
index 6069f8f..3d045ba 100644
--- a/manuals/chickadee/Sprites.html
+++ b/manuals/chickadee/Sprites.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Sprites (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
 
    
-
    
+
    
 
    5.3.3 Sprites
    
 
 
    For those who are new to this game, a sprite is a 2D rectangular
@@ -221,7 +221,7 @@ arguments may be used.
 as they are the same.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
diff --git a/manuals/chickadee/Textures.html b/manuals/chickadee/Textures.html
index 80a30db..5b8e506 100644
--- a/manuals/chickadee/Textures.html
+++ b/manuals/chickadee/Textures.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Textures (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
 
    
-
    
+
    
 
    5.3.2 Textures
    
 
 
    Textures are essentially images: a 2D grid of color values.  However,
@@ -285,7 +285,7 @@ practical use of cube maps.
 
    Return #t if obj is a cube map.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
diff --git a/manuals/chickadee/The-Environment.html b/manuals/chickadee/The-Environment.html
index db4e415..3e08719 100644
--- a/manuals/chickadee/The-Environment.html
+++ b/manuals/chickadee/The-Environment.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 The Environment (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Previous: , Up: Audio   [Contents][Index]
    
 
    
-
    
+
    
 
    5.4.4 The Environment
    
 
 
    The environment defines global parameters that govern how sound is
diff --git a/manuals/chickadee/The-Game-Loop.html b/manuals/chickadee/The-Game-Loop.html
index 7d7acfb..45a4d42 100644
--- a/manuals/chickadee/The-Game-Loop.html
+++ b/manuals/chickadee/The-Game-Loop.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 The Game Loop (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Up: Kernel   [Contents][Index]
    
 
    
-
    
+
    
 
    5.1.1 The Game Loop
    
 
 
    At the very core of Chickadee there is an event loop.  This loop, or
@@ -102,7 +102,7 @@ Chickadee game loop.
 calling run-game is already taken care of for you.
 
    
 
    
-
    Procedure: run-game [#:window-title "Chickadee!"]        [#:window-width 640] [#:window-height 480]        [#:window-fullscreen? #f]        [#:window-resizable? #f]        [#:update-hz 60]        [#:load] [#:update] [#:draw] [#:quit]        [#:key-press] [#:key-release] [#:text-input]        [#:mouse-press] [#:mouse-release] [#:mouse-move]        [#:controller-add] [#:controller-remove] [#:controller-press]        [#:controller-release] [#:controller-move] [#:error]
    
+
    Procedure: run-game [#:window-title "Chickadee!"]        [#:window-width 640] [#:window-height 480]        [#:window-fullscreen? #f]        [#:window-resizable? #f]        [#:update-hz 60]        [#:clear-color]        [#:load] [#:update] [#:draw] [#:quit]        [#:key-press] [#:key-release] [#:text-input]        [#:mouse-press] [#:mouse-release] [#:mouse-move]        [#:controller-add] [#:controller-remove] [#:controller-press]        [#:controller-release] [#:controller-move]        [#:window-keyboard-enter] [#:window-keyboard-leave]        [#:window-mouse-enter] [#:window-mouse-leave]        [#:window-show] [#:window-hide]        [#:window-minimize] [#:window-maximize]        [#:window-move] [#:window-resize]        [#:error]
    
 
    
 
    Run the Chickadee game loop.
 
    
@@ -110,7 +110,8 @@ calling run-game is already taken care of for you.
 window-height as its dimensions, window-title as its
 title, and in fullscreen mode if window-fullscreen? is
 #t.  If window-resizable? is #t then the window
-can be resized by the user.
+can be resized by the user.  The screen color will be set to
+clear-color, or a pleasant light blue, by default.
 
    
 
      
 
    •  load: Called with zero arguments when the game window has opened
@@ -277,6 +278,55 @@ values are:
 
 
      • 
 
+
    •  window-keyboard-enter: Called with zero arguments when the
+window gains keyboard focus.
+
+
    •  window-keyboard-leave: Called with zero arguments when the
+window loses keyboard focus.
+
+
    •  window-mouse-enter: Called with zero arguments when the window
+gains mouse focus.
+
+
    •  window-mouse-leave: Called with zero arguments when the window
+loses mouse focus.
+
+
    •  window-show: Called with zero arguments when the window is
+shown after having been hidden.
+
+
    •  window-hide: Called with zero arguments when the window is
+hidden.
+
+
    •  window-minimize: Called with zero arguments when the window is
+minimized.
+
+
    •  window-maximize: Called with zero arguments when the window is
+maximized.
+
+
    •  window-move: Called with two arguments when the window is moved
+within the desktop environment.
+
+
        
+
      1.  x: The x coordinate of the top-left corner of the window, in
+pixels.
+
+
      2.  y: The y coordinate of the top-left corner of the window, in
+pixels.
+
+
      
+
+
      Desktop environments use the top-left corner as the origin rather than
+the bottom-left like Chickadee does, hence the discrepancy here.
+
      
+
    •  window-resize: Called with zero arguments when the window is
+resized.
+
+
        
+
      1.  width: The new width in pixels.
+
+
      2.  height: The new height in pixels.
+
+
      
+
 
    •  error: Called with two arguments when an error occurs:
 
 
        
@@ -358,7 +408,7 @@ behavior is to simply re-throw the error.
 
        Return the current value of the system timer in seconds.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Up: Kernel   [Contents][Index]
    
diff --git a/manuals/chickadee/The-Listener.html b/manuals/chickadee/The-Listener.html
index 43e0f57..a6f5ab3 100644
--- a/manuals/chickadee/The-Listener.html
+++ b/manuals/chickadee/The-Listener.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 The Listener (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Audio   [Contents][Index]
    
 
    
-
    
+
    
 
    5.4.3 The Listener
    
 
 
    The listener is a collection of global state that represents the
diff --git a/manuals/chickadee/Tile-Maps.html b/manuals/chickadee/Tile-Maps.html
index 662d69f..c6d9339 100644
--- a/manuals/chickadee/Tile-Maps.html
+++ b/manuals/chickadee/Tile-Maps.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Tile Maps (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    -
    +

    5.3.7 Tile Maps

    A tile map is a scene created by composing lots of small sprites, @@ -354,7 +354,7 @@ keyword argument.

    Return the list of points that form polygon.

    -
    +

    Next: , Previous: , Up: Graphics   [Contents][Index]

    diff --git a/manuals/chickadee/Tweening.html b/manuals/chickadee/Tweening.html index a72886b..b69b75e 100644 --- a/manuals/chickadee/Tweening.html +++ b/manuals/chickadee/Tweening.html @@ -1,6 +1,6 @@ - - + --> + - + Tweening (The Chickadee Game Toolkit) - - - - - - - - - - - + + + + + + + + + + + - + @@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}

    Next: , Previous: , Up: Scripting   [Contents][Index]

    -
    +

    5.5.3 Tweening

    Tweening is the process of transitioning something from an initial @@ -92,11 +92,11 @@ state to a final state over a pre-determined period of time. In other words, tweening is a way to create animation. The tween procedure can be used within any script like so:

    -
    -
    (define x 0)
-(script
-  ;; 0 to 100 in 60 ticks of the agenda.
-  (tween 60 0 100 (lambda (y) (set! x y))))
+
    
+
    (define x 0)
+(script
+  ;; 0 to 100 in 60 ticks of the agenda.
+  (tween 60 0 100 (lambda (y) (set! x y))))
 
    
 
 
    
diff --git a/manuals/chickadee/Vector-Paths.html b/manuals/chickadee/Vector-Paths.html
index 68af3d8..81d6307 100644
--- a/manuals/chickadee/Vector-Paths.html
+++ b/manuals/chickadee/Vector-Paths.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Vector Paths (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    -
    +

    5.3.5 Vector Paths

    The (chickadee graphics path) module can be used to draw lines, @@ -107,13 +107,13 @@ the first.

    Procedure: path . commands

    Return a new path that follows commands.

    -
    -
    (path (move-to (vec2 50.0 50.0))
-      (line-to (vec2 500.0 50.0))
-      (line-to (vec2 400.0 200.0))
-      (bezier-to (vec2 500.0 250.0) (vec2 380.0 300.0) (vec2 400.0 400.0))
-      (line-to (vec2 300.0 400.0))
-      (close-path))
+
    
+
    (path (move-to (vec2 50.0 50.0))
+      (line-to (vec2 500.0 50.0))
+      (line-to (vec2 400.0 200.0))
+      (bezier-to (vec2 500.0 250.0) (vec2 380.0 300.0) (vec2 400.0 400.0))
+      (line-to (vec2 300.0 400.0))
+      (close-path))
    @@ -257,10 +257,10 @@ combined together to form arbitrarily complex pictures.
  • stroke-cap
    • -
    -
    (with-style ((stroke-color green)
-             (stroke-width 4.0))
-  (stroke (circle (vec2 100.0 100.0) 50.0)))
+
    
+
    (with-style ((stroke-color green)
+             (stroke-width 4.0))
+  (stroke (circle (vec2 100.0 100.0) 50.0)))
 
    
 
 
@@ -450,7 +450,7 @@ the image, should a painter later be associated with this canvas.
 
    Render canvas to the screen.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
diff --git a/manuals/chickadee/Vectors.html b/manuals/chickadee/Vectors.html
index d11bfc6..8761fe9 100644
--- a/manuals/chickadee/Vectors.html
+++ b/manuals/chickadee/Vectors.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Vectors (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Math   [Contents][Index]
    
 
    
-
    
+
    
 
    5.2.2 Vectors
    
 
 
    Unlike Scheme’s vector data type, which is a sequence of arbitrary
@@ -96,8 +96,8 @@ release.
 
    
 
    Here’s a quick example of adding two vectors:
 
    
-
    
-
    (define v (vec2+ (vec2 1 2) (vec2 3 4)))
+
    
+
    (define v (vec2+ (vec2 1 2) (vec2 3 4)))
 
    
 
 
    A Note About Performance
@@ -339,7 +339,7 @@ multiplying it by x, a 3D vector or a scalar.
 store the result in dest.
 
    
 
-
    
+
    
 
    
 
    
 Next: , Previous: , Up: Math   [Contents][Index]
    
diff --git a/manuals/chickadee/Viewports.html b/manuals/chickadee/Viewports.html
index 804b226..c60adc3 100644
--- a/manuals/chickadee/Viewports.html
+++ b/manuals/chickadee/Viewports.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Viewports (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Next: , Previous: , Up: Graphics   [Contents][Index]
    
 
    
-
    
+
    
 
    5.3.15 Viewports
    
 
 
    A viewport represents a subset of the screen (or framebuffer).  When
@@ -93,8 +93,7 @@ viewport.  These aren’t often needed, and Chickadee’s default viewpo
 occupies the entire screen, but there are certain situations where
 they are useful.  For example, a split-screen multiplayer game may
 render to two different viewports, each occupying a different half of
-the screen.  For information about how to set the current viewport,
-see with-viewport in Rendering Engine.
+the screen.
 
    
 
    The (chickadee graphics viewport) module provides the following
 API:
diff --git a/manuals/chickadee/Window-Manipulation.html b/manuals/chickadee/Window-Manipulation.html
index b322014..879c12c 100644
--- a/manuals/chickadee/Window-Manipulation.html
+++ b/manuals/chickadee/Window-Manipulation.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Window Manipulation (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -84,7 +84,7 @@ ul.no-bullet {list-style: none}
 
    
 Previous: , Up: Kernel   [Contents][Index]
    
 
    
-
    
+
    
 
    5.1.3 Window Manipulation
    
 
 
    
diff --git a/manuals/chickadee/index.html b/manuals/chickadee/index.html
index 915c50f..0d414d5 100644
--- a/manuals/chickadee/index.html
+++ b/manuals/chickadee/index.html
@@ -1,6 +1,6 @@
 
 
-
-
+  -->
+
 
-
+
 Top (The Chickadee Game Toolkit)
 
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
 
-
+
 
 
 
@@ -203,7 +203,7 @@ ul.no-bullet {list-style: none}
   
   
  • Appendix A Copying This Manual
   
    • 
   
  • Index
    • 
 
@@ -214,10 +214,10 @@ ul.no-bullet {list-style: none}
 
    
 Next:    [Contents][Index]
    -
    +

    Chickadee

    -

    Copyright © 2017-2021 David Thompson davet@gnu.org +

    Copyright © 2017-2023 David Thompson dthompson2@worcester.edu

    Permission is granted to copy, distribute and/or modify this document @@ -248,14 +248,14 @@ Foundation Web site at http://www • API Reference  Chickadee API reference. -• Copying This Manual  The GNU Free Documentation License and you! +• Copying This Manual   • Index   -

    +

    Next:   [Contents][Index]

    -- cgit v1.2.3