From 7fe48853acbd376cdd9c701d6d37acc2784d130d Mon Sep 17 00:00:00 2001 From: David Thompson Date: Mon, 23 Jan 2017 21:44:37 -0500 Subject: Add Chickadee manual. --- haunt.scm | 1 + manuals/chickadee/API-Reference.html | 93 ++++ manuals/chickadee/Audio.html | 82 +++ manuals/chickadee/Blending-and-Depth-Testing.html | 80 +++ manuals/chickadee/Copying-This-Manual.html | 85 ++++ manuals/chickadee/Framebuffers.html | 80 +++ .../chickadee/GNU-Free-Documentation-License.html | 553 +++++++++++++++++++++ manuals/chickadee/Graphics.html | 110 ++++ manuals/chickadee/Index.html | 204 ++++++++ manuals/chickadee/Input.html | 80 +++ manuals/chickadee/Installation.html | 93 ++++ manuals/chickadee/Kernel.html | 416 ++++++++++++++++ manuals/chickadee/Lines-and-Shapes.html | 80 +++ manuals/chickadee/Math.html | 94 ++++ manuals/chickadee/Matrices.html | 80 +++ manuals/chickadee/Rectangles.html | 80 +++ manuals/chickadee/Rendering-Engine.html | 183 +++++++ manuals/chickadee/Requirements.html | 92 ++++ manuals/chickadee/Shaders.html | 86 ++++ manuals/chickadee/Sprites.html | 80 +++ manuals/chickadee/Textures.html | 97 ++++ manuals/chickadee/Vectors.html | 80 +++ manuals/chickadee/Vertex-Arrays.html | 80 +++ manuals/chickadee/Viewports.html | 80 +++ manuals/chickadee/index.html | 164 ++++++ 25 files changed, 3153 insertions(+) create mode 100644 manuals/chickadee/API-Reference.html create mode 100644 manuals/chickadee/Audio.html create mode 100644 manuals/chickadee/Blending-and-Depth-Testing.html create mode 100644 manuals/chickadee/Copying-This-Manual.html create mode 100644 manuals/chickadee/Framebuffers.html create mode 100644 manuals/chickadee/GNU-Free-Documentation-License.html create mode 100644 manuals/chickadee/Graphics.html create mode 100644 manuals/chickadee/Index.html create mode 100644 manuals/chickadee/Input.html create mode 100644 manuals/chickadee/Installation.html create mode 100644 manuals/chickadee/Kernel.html create mode 100644 manuals/chickadee/Lines-and-Shapes.html create mode 100644 manuals/chickadee/Math.html create mode 100644 manuals/chickadee/Matrices.html create mode 100644 manuals/chickadee/Rectangles.html create mode 100644 manuals/chickadee/Rendering-Engine.html create mode 100644 manuals/chickadee/Requirements.html create mode 100644 manuals/chickadee/Shaders.html create mode 100644 manuals/chickadee/Sprites.html create mode 100644 manuals/chickadee/Textures.html create mode 100644 manuals/chickadee/Vectors.html create mode 100644 manuals/chickadee/Vertex-Arrays.html create mode 100644 manuals/chickadee/Viewports.html create mode 100644 manuals/chickadee/index.html diff --git a/haunt.scm b/haunt.scm index 2da7a99..32516cf 100644 --- a/haunt.scm +++ b/haunt.scm @@ -421,6 +421,7 @@ following modules:") #:name "Chickadee" #:file-name "chickadee.html" #:repo "chickadee" + #:manual? #t #:description `((p "Chickadee is a game development toolkit for " ,(anchor "Guile Scheme" "https://gnu.org/s/guile") diff --git a/manuals/chickadee/API-Reference.html b/manuals/chickadee/API-Reference.html new file mode 100644 index 0000000..bee3d9d --- /dev/null +++ b/manuals/chickadee/API-Reference.html @@ -0,0 +1,93 @@ + + + + + +The Chickadee Game Toolkit: API Reference + + + + + + + + + + + + + + + + + + + + + +

+ +

2 API Reference

+ + + + + + + + + + + + + + diff --git a/manuals/chickadee/Audio.html b/manuals/chickadee/Audio.html new file mode 100644 index 0000000..2f20199 --- /dev/null +++ b/manuals/chickadee/Audio.html @@ -0,0 +1,82 @@ + + + + + +The Chickadee Game Toolkit: Audio + + + + + + + + + + + + + + + + + + + + + +

+ +

2.5 Audio

+ +

There is no audio support yet. Stay tuned! +

+ + + + + diff --git a/manuals/chickadee/Blending-and-Depth-Testing.html b/manuals/chickadee/Blending-and-Depth-Testing.html new file mode 100644 index 0000000..0c0aaa3 --- /dev/null +++ b/manuals/chickadee/Blending-and-Depth-Testing.html @@ -0,0 +1,80 @@ + + + + + +The Chickadee Game Toolkit: Blending and Depth Testing + + + + + + + + + + + + + + + + + + + + + +

+ +

2.4.5 Blending and Depth Testing

+ + + + + + diff --git a/manuals/chickadee/Copying-This-Manual.html b/manuals/chickadee/Copying-This-Manual.html new file mode 100644 index 0000000..f8bef99 --- /dev/null +++ b/manuals/chickadee/Copying-This-Manual.html @@ -0,0 +1,85 @@ + + + + + +The Chickadee Game Toolkit: Copying This Manual + + + + + + + + + + + + + + + + + + + + + +

+ +

Appendix A Copying This Manual

+ + + + + + + + + + diff --git a/manuals/chickadee/Framebuffers.html b/manuals/chickadee/Framebuffers.html new file mode 100644 index 0000000..fd0c64f --- /dev/null +++ b/manuals/chickadee/Framebuffers.html @@ -0,0 +1,80 @@ + + + + + +The Chickadee Game Toolkit: Framebuffers + + + + + + + + + + + + + + + + + + + + + +

+ +

2.4.8 Framebuffers

+ + + + + + diff --git a/manuals/chickadee/GNU-Free-Documentation-License.html b/manuals/chickadee/GNU-Free-Documentation-License.html new file mode 100644 index 0000000..ea990ae --- /dev/null +++ b/manuals/chickadee/GNU-Free-Documentation-License.html @@ -0,0 +1,553 @@ + + + + + +The Chickadee Game Toolkit: GNU Free Documentation License + + + + + + + + + + + + + + + + + + + + + +

+ +

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.
+

+ +

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. +
+
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. +
+
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. +
+
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. +
+
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. +
+
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.” +
+
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. +
+
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. +
+
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. +
+
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. +
+
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. +
+
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. +

+ +

+ + + + + + diff --git a/manuals/chickadee/Graphics.html b/manuals/chickadee/Graphics.html new file mode 100644 index 0000000..efe6df6 --- /dev/null +++ b/manuals/chickadee/Graphics.html @@ -0,0 +1,110 @@ + + + + + +The Chickadee Game Toolkit: Graphics + + + + + + + + + + + + + + + + + + + + + +

+ +

2.4 Graphics

+ +

Chickadee aims to make hardware-accelerated graphics rendering as +simple and efficient as possible by providing high-level APIs that +interact with the low-level OpenGL API under the hood. Anyone that +has worked with OpenGL directly knows that it has a steep learning +curve and a lot of effort is needed to render even a single triangle. +The Chickadee rendering engine attempts to make it easy to do common +tasks like rendering a sprite while also providing all of the building +blocks to implement additional rendering techniques. +

+ + + + + + + + + + + + + + + + + diff --git a/manuals/chickadee/Index.html b/manuals/chickadee/Index.html new file mode 100644 index 0000000..3863270 --- /dev/null +++ b/manuals/chickadee/Index.html @@ -0,0 +1,204 @@ + + + + + +The Chickadee Game Toolkit: Index + + + + + + + + + + + + + + + + + + + + +

+ +

Index

+ +

Jump to:	A + +B + +C + +D + +G + +K + +L + +M + +Q + +R + +T + +U + +W + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	Index Entry	Section

A
	`abort-game`:	Kernel
	`after-draw-hook`:	Kernel

B
	`before-draw-hook`:	Kernel

C
	`controller-add-hook`:	Kernel
	`controller-move-hook`:	Kernel
	`controller-press-hook`:	Kernel
	`controller-release-hook`:	Kernel
	`controller-remove-hook`:	Kernel
	`current-blend-mode`:	Rendering Engine
	`current-depth-test`:	Rendering Engine
	`current-framebuffer`:	Rendering Engine
	`current-projection`:	Rendering Engine
	`current-texture`:	Rendering Engine
	`current-viewport`:	Rendering Engine

D
	`draw-hook`:	Kernel

G
	`gpu-apply`:	Rendering Engine
	`gpu-apply*`:	Rendering Engine

K
	`key-press-hook`:	Kernel
	`key-release-hook`:	Kernel

L
	`load-hook`:	Kernel
	`load-image`:	Textures

M
	`mouse-move-hook`:	Kernel
	`mouse-press-hook`:	Kernel
	`mouse-release-hook`:	Kernel

Q
	`quit-hook`:	Kernel

R
	`run-game`:	Kernel

T
	`text-input-hook`:	Kernel
	`time`:	Kernel

U
	`update-hook`:	Kernel

W
	`with-blend-mode`:	Rendering Engine
	`with-depth-test`:	Rendering Engine
	`with-framebuffer`:	Rendering Engine
	`with-projection`:	Rendering Engine
	`with-texture`:	Rendering Engine
	`with-viewport`:	Rendering Engine

Jump to:	A + +B + +C + +D + +G + +K + +L + +M + +Q + +R + +T + +U + +W + +

+ +

+ + + + + + diff --git a/manuals/chickadee/Input.html b/manuals/chickadee/Input.html new file mode 100644 index 0000000..3c25932 --- /dev/null +++ b/manuals/chickadee/Input.html @@ -0,0 +1,80 @@ + + + + + +The Chickadee Game Toolkit: Input + + + + + + + + + + + + + + + + + + + + + +

+ +

2.2 Input

+ + + + + + diff --git a/manuals/chickadee/Installation.html b/manuals/chickadee/Installation.html new file mode 100644 index 0000000..f9f3629 --- /dev/null +++ b/manuals/chickadee/Installation.html @@ -0,0 +1,93 @@ + + + + + +The Chickadee Game Toolkit: Installation + + + + + + + + + + + + + + + + + + + + + +

+ +

1 Installation

+ +

Chickadee is available for download from its website at +dthompson.us/projects/chickadee.html. This section describes +the software requirements of Chickadee, as well as how to install it. +

The build procedure for Chickadee is the same as for GNU software +packages, and is not covered here. Please see the files README +and INSTALL for additional details. +

+ + + + + + + + + diff --git a/manuals/chickadee/Kernel.html b/manuals/chickadee/Kernel.html new file mode 100644 index 0000000..c9d635b --- /dev/null +++ b/manuals/chickadee/Kernel.html @@ -0,0 +1,416 @@ + + + + + +The Chickadee Game Toolkit: Kernel + + + + + + + + + + + + + + + + + + + + + +

+ +

2.1 Kernel

+ +

At the very core of Chickadee, in the (chickadee) module, lies +an event loop. This loop, or “kernel”, is responsible for creating +and managing the game window, dispatching input events, ensuring that +the game is updated at the desired interval, and rendering graphics. +The kernel implements what is known as a “fixed timestep” game loop, +meaning that the game simulation will be advanced by a fixed interval +of time and will never vary from frame to frame, unlike some other +styles of game loops. The appropriately named run-game and +abort-game procedures are the entry and exit points to the +Chickadee kernel. +

On its own, the kernel does not do very much at all. In order to +actually respond to input events, update game state, or draw something +to the game window, a hacker with a penchant for game development must +latch onto extension points built into the kernel, called “hooks”, +and specify what action ought to be taken for any given event. For +example, the key-press-hook can be used to respond to the +a key being pressed by swinging the player’s mighty sword. +There are many hooks available, so read on to learn about all of them. +For information about using Guile’s hook API, see See Hooks in GNU Guile Reference Manual. +

Scheme Procedure: run-game [#:window-title "Chickadee!"]

[#:window-width 640] [#:window-height 480] [#:window-fullscreen? #f] + [#:update-hz 60] +Start the event loop. This procedure will not return until +abort-game is called. +

The update-hook will be run update-hz times per second. +

A new graphical window will be opened with window-width x +window-height as its dimensions, window-title as its +title, and in fullscreen mode if window-fullscreen? is +#t. +

+ +

Scheme Procedure: abort-game: Stop the currently running Chickadee event loop. +

+ +

Scheme Procedure: time: Return the current game time in milliseconds. +

+ +

Scheme Variable: load-hook

A hook that is run once when the event loop boots, before any other +hook is run. This hook is run with zero arguments. +

(add-hook! load-hook (lambda () (display "hello!\n")))
+

+ +

Scheme Variable: update-hook

A hook that is run every time the game simulation should be advanced. +This hook is run with a single argument dt, the fixed timestep +that was configured when the event loop was started, in milliseconds. +

(add-hook! update-hook (lambda (dt) (display "tick!\n")))
+

+ +

Scheme Variable: before-draw-hook

A hook that is run before a frame is rendered. This hook is run with +zero arguments. +

(add-hook! before-draw-hook (lambda () (display "about to draw!\n")))
+

+ +

Scheme Variable: after-draw-hook

A hook that is run after a frame is rendered. This hook is run with +zero arguments. +

(add-hook! after-draw-hook (lambda () (display "done drawing!\n")))
+

+ +

Combined with before-draw-hook, one can perform a frames per +second calculation to monitor game performance and stability. +

+ +

Scheme Variable: draw-hook

A hook that is run each time a frame should be rendered. This hook is +run with a single argument alpha, a value in the range [0, 1] +which represents how much time has past since the last game state +update relative to the upcoming game state update, as a percentage. +Because the game state is updated independent of rendering, it is +often the case that rendering is occuring between two updates. If the +game is rendered as it was during the last update, a strange +side-effect will occur that makes animation appear rough or +“choppy”. To counter this, the alpha value can be used to +perfrom a linear interpolation of a moving object between its current +position and its previous position. This odd trick has the pleasing +result of making the animation look smooth again, but requires keeping +track of previous state. +

+ +

(add-hook! draw-hook (lambda (alpha) (display "<(._.<) \n")))
+

+ +

Scheme Variable: quit-hook

A hook that is run when the user clicks the close button on the game +window. This hook is run with zero arguments. +

(add-hook! quit-hook (lambda () (display "bye!\n")))
+

+ +

Scheme Variable: key-press-hook

A hook that is run when a key is pressed on the keyboard. This hook +is run with four arguments: +

key: The symbolic name of the “virtual” key that was pressed. +For example: backspace. It’s called a virtual key because the +operating system may map a physical keyboard key to another key +entirely, such as how the author binds the “caps lock” key to mean +“control”. + +
scancode: The symbolic name of the physical key that was +pressed. + +
modifiers: A list of the symbolic names of modifier keys that +were being held down when the key was pressed. Possible values +include ctrl, alt, and shift. + +
repeat?: #t if this is a repeated press of the same key. + +

+ +

(add-hook! key-press-hook
+           (lambda (key scancode modifiers repeat?)
+             (display "pressed key: ")
+             (display key)
+             (newline)))
+

+ +

Scheme Variable: key-release-hook

A hook that is run when a key is released on the keyboard. This hook +is run with three arguments: +

key: The symbolic name of the “virtual” key that was released. + +
scancode: The symbolic name of the physical key that was +released. + +
modifiers: A list of the symbolic names of modifier keys that +were being held down when the key was released. + +

+ +

Scheme Variable: text-input-hook: A hook that is run when printable text is typed on the keyboard. This +hook is run with a single argument, text, a string containing +the text that was entered. +

+ +

Scheme Variable: mouse-press-hook

A hook that is run when a mouse button is pressed. This hook is run +with four arguments: +

button: The symbolic name of the button that was pressed, such +as left, middle, or right. + +
clicks: The number of times the button has been clicked in a row. + +
x: The x coordinate of the mouse cursor. + +
y: The y coordinate of the mouse cursor. + +

+ +

Scheme Variable: mouse-release-hook

A hook that is run when a mouse button is released. This hook is run +with three arguments: +

button: The symbolic name of the button that was released. + +
x: The x coordinate of the mouse cursor. + +
y: The y coordinate of the mouse cursor. + +

+ +

Scheme Variable: mouse-move-hook

A hook that is run when the mouse is moved. This hook is run with +five arguments: +

x: The x coordinate of the mouse cursor. + +
y: The y coordinate of the mouse cursor. + +
dx: The amount the mouse has moved along the x axis since the +last mouse move event. + +
dy: The amount the mouse has moved along the y axis since the +last mouse move event. + +
buttons: A list of the buttons that were pressed down when the +mouse was moved. + +

+ +

Scheme Variable: controller-add-hook: A hook that is run when a game controller is connected. This hook is +run with a single argument, controller, the controller that was +connected. +

+ +

Scheme Variable: controller-remove-hook: A hook that is run when a game controller is disconnected. This hook +is run with a single argument, controller, the controller that +was disconnected. +

+ +

Scheme Variable: controller-press-hook

A hook that is run when a button on a game controller is pressed. +This hook is run with two arguments: +

controller: The controller that triggered the event. + +
button: The symbolic name of the button that was pressed. +Possible buttons are: + +
- a +
- b +
- x +
- y +
- back +
- guide +
- start +
- left-stick +
- right-stick +
- left-shoulder +
- right-shoulder +
- dpad-up +
- dpad-down +
- dpad-left +
- dpad-right + +
+ +

+ +

Scheme Variable: controller-release-hook

A hook that is run when a button on a game controller is released. +

This hook is run with two arguments: +

controller: The controller that triggered the event. + +
button: The symbolic name of the button that was released. + +

+ +

Scheme Variable: controller-move-hook

A hook that is run when an analog stick or trigger on a game +controller is moved. This hook is run with three arguments +

controller: The controller that triggered the event. + +
axis: The symbolic name of the axis that was moved. Possible +values are: + +
- left-x +
- left-y +
- right-x +
- right-y +
- trigger-left +
- trigger-right +
+ +

+ +

+ + + + + + diff --git a/manuals/chickadee/Lines-and-Shapes.html b/manuals/chickadee/Lines-and-Shapes.html new file mode 100644 index 0000000..01fac7b --- /dev/null +++ b/manuals/chickadee/Lines-and-Shapes.html @@ -0,0 +1,80 @@ + + + + + +The Chickadee Game Toolkit: Lines and Shapes + + + + + + + + + + + + + + + + + + + + + +

+ +

2.4.3 Lines and Shapes

+ + + + + + diff --git a/manuals/chickadee/Math.html b/manuals/chickadee/Math.html new file mode 100644 index 0000000..0204efc --- /dev/null +++ b/manuals/chickadee/Math.html @@ -0,0 +1,94 @@ + + + + + +The Chickadee Game Toolkit: Math + + + + + + + + + + + + + + + + + + + + + +

+ +

2.3 Math

+ +

Chickadee contains data types and procedures for performing the most +common computations in video game simulations such as linear algebra +with vectors and matrices and axis-aligned bounding box collision +detection. +

+ + + + + + + + + + + diff --git a/manuals/chickadee/Matrices.html b/manuals/chickadee/Matrices.html new file mode 100644 index 0000000..f84f62d --- /dev/null +++ b/manuals/chickadee/Matrices.html @@ -0,0 +1,80 @@ + + + + + +The Chickadee Game Toolkit: Matrices + + + + + + + + + + + + + + + + + + + + + +

+ +

2.3.2 Matrices

+ + + + + + diff --git a/manuals/chickadee/Rectangles.html b/manuals/chickadee/Rectangles.html new file mode 100644 index 0000000..743db15 --- /dev/null +++ b/manuals/chickadee/Rectangles.html @@ -0,0 +1,80 @@ + + + + + +The Chickadee Game Toolkit: Rectangles + + + + + + + + + + + + + + + + + + + + + +

+ +

2.3.3 Rectangles

+ + + + + + diff --git a/manuals/chickadee/Rendering-Engine.html b/manuals/chickadee/Rendering-Engine.html new file mode 100644 index 0000000..b4514db --- /dev/null +++ b/manuals/chickadee/Rendering-Engine.html @@ -0,0 +1,183 @@ + + + + + +The Chickadee Game Toolkit: Rendering Engine + + + + + + + + + + + + + + + + + + + + + +

+ +

2.4.1 Rendering Engine

+ +

Chickadee defines rendering using a metaphor familiar to Scheme +programmers: procedure application. A shader (see Shaders) is +like a procedure for the GPU to apply. Shaders are passed arguments: +A vertex array containing the geometry to render (see Vertex Arrays) and zero or more keyword arguments that the shader +understands. Similar to how Scheme has apply for calling +procedures, Chickadee provides gpu-apply for calling shaders. +

Additionally, there is some dynamic state that effects how +gpu-apply will behave. Things like the current viewport, +framebuffer, and blend mode are stored as dynamic state because it +would be tedious to have to have to specify them each time +gpu-apply is called. +

The following procedures and syntax can be found in the +(chickadee render) module. +

Scheme Syntax: gpu-apply shader vertex-array [#:uniform-key uniform-value ...]

Scheme Syntax: gpu-apply* shader vertex-array count [#:uniform-key uniform-value ...]

Render vertex-array using shader with the uniform values +specified in the following keyword arguments. +

While gpu-apply will draw every vertex in vertex-array, +gpu-apply* will only draw count vertices. +

+ +

Scheme Procedure: current-viewport: Return the currently bound viewport. See Viewports for more +details about using viewports. +

+ +

Scheme Procedure: current-framebuffer: Return the currently bound framebuffer. See Framebuffers for more +details about using framebuffers. +

+ +

Scheme Procedure: current-blend-mode: Return the currently bound blend mode. See Blending and Depth Testing for more details about using blend modes. +

+ +

Scheme Procedure: current-depth-test: Return #t if depth testing is currently enabled. +See Blending and Depth Testing for more details about using the +depth test. +

+ +

Scheme Procedure: current-texture: Return the currently bound texture. See Textures for more details +about using textures. +

+ +

Scheme Procedure: current-projection: Return the currently bound projection matrix. See Matrices for +more details about matrices. +

+ +

Scheme Syntax: with-viewport viewport body ...: Evaluate body with the current viewport bound to viewport. +

+ +

Scheme Syntax: with-framebuffer framebuffer body ...: Evaluate body with the current framebuffer bound to +framebuffer. +

+ +

Scheme Syntax: with-blend-mode blend-mode body ...: Evaluate body with the current blend mode bound to +blend-mode. +

+ +

Scheme Syntax: with-depth-test depth-test? body ...: Evaluate body with the depth-test disabled if depth-test? +is #f, or enabled otherwise. +

+ +

Scheme Syntax: with-texture texture body ...: Evaluate body with the current texture bound to texture. +

+ +

Scheme Syntax: with-projection projection body ...: Evaluate body with the current projection matrix bound to +projection. +

+ +

+ + + + + + diff --git a/manuals/chickadee/Requirements.html b/manuals/chickadee/Requirements.html new file mode 100644 index 0000000..53927d7 --- /dev/null +++ b/manuals/chickadee/Requirements.html @@ -0,0 +1,92 @@ + + + + + +The Chickadee Game Toolkit: Requirements + + + + + + + + + + + + + + + + + + + + + +

+ +

1.1 Requirements

+ +

Chickadee depends on the following packages: +

GNU Guile, version 2.1.0 or later; +
GNU guile-opengl, version 0.1 or later. +
guile-sdl2, version 0.2.0 or later; +

+ +

Additionally, Chickadee depends on being able to create an OpenGL 3.3 +context at runtime, which means that some older computers may not be +able to run games written with Chickadee. +

+ + + + + diff --git a/manuals/chickadee/Shaders.html b/manuals/chickadee/Shaders.html new file mode 100644 index 0000000..a0e7637 --- /dev/null +++ b/manuals/chickadee/Shaders.html @@ -0,0 +1,86 @@ + + + + + +The Chickadee Game Toolkit: Shaders + + + + + + + + + + + + + + + + + + + + + +

+ +

2.4.7 Shaders

+ +

Shaders are programs for the GPU to evaluate. They are written in the +OpenGL Shading Language, or GLSL. Chickadee does not currently +provide a Scheme-like domain specific language for writing shaders. +Since shaders must be written in GLSL and not Scheme, they are +considered an advanced feature. +

+ + + + + diff --git a/manuals/chickadee/Sprites.html b/manuals/chickadee/Sprites.html new file mode 100644 index 0000000..700941b --- /dev/null +++ b/manuals/chickadee/Sprites.html @@ -0,0 +1,80 @@ + + + + + +The Chickadee Game Toolkit: Sprites + + + + + + + + + + + + + + + + + + + + + +

+ +

2.4.2 Sprites

+ + + + + + diff --git a/manuals/chickadee/Textures.html b/manuals/chickadee/Textures.html new file mode 100644 index 0000000..a31d6fb --- /dev/null +++ b/manuals/chickadee/Textures.html @@ -0,0 +1,97 @@ + + + + + +The Chickadee Game Toolkit: Textures + + + + + + + + + + + + + + + + + + + + + +

+ +

2.4.4 Textures

+ +

Scheme Procedure: load-image file [#:min-filter nearest]

[#:mag-filter nearest] [#:wrap-s repeat] [#:wrap-t repeat] +

Load the image data from file and return a new texture object. +

min-filter and mag-filter describe the method that should +be used for minification and magnification when rendering, +respectively. Possible values are nearest and linear. +

wrap-s and wrap-t describe how to interpret texture +coordinates that are greater than 1.0. Possible values are +repeat, clamp, clamp-to-border, and +clamp-to-edge. +

+ + + + + + diff --git a/manuals/chickadee/Vectors.html b/manuals/chickadee/Vectors.html new file mode 100644 index 0000000..8a624ff --- /dev/null +++ b/manuals/chickadee/Vectors.html @@ -0,0 +1,80 @@ + + + + + +The Chickadee Game Toolkit: Vectors + + + + + + + + + + + + + + + + + + + + + +

+ +

2.3.1 Vectors

+ + + + + + diff --git a/manuals/chickadee/Vertex-Arrays.html b/manuals/chickadee/Vertex-Arrays.html new file mode 100644 index 0000000..72b0273 --- /dev/null +++ b/manuals/chickadee/Vertex-Arrays.html @@ -0,0 +1,80 @@ + + + + + +The Chickadee Game Toolkit: Vertex Arrays + + + + + + + + + + + + + + + + + + + + + +

+ +

2.4.6 Vertex Arrays

+ + + + + + diff --git a/manuals/chickadee/Viewports.html b/manuals/chickadee/Viewports.html new file mode 100644 index 0000000..f55d386 --- /dev/null +++ b/manuals/chickadee/Viewports.html @@ -0,0 +1,80 @@ + + + + + +The Chickadee Game Toolkit: Viewports + + + + + + + + + + + + + + + + + + + + + +

+ +

2.4.9 Viewports

+ + + + + + diff --git a/manuals/chickadee/index.html b/manuals/chickadee/index.html new file mode 100644 index 0000000..d044f9f --- /dev/null +++ b/manuals/chickadee/index.html @@ -0,0 +1,164 @@ + + + + + +The Chickadee Game Toolkit: Top + + + + + + + + + + + + + + + + + + +

The Chickadee Game Toolkit

+ + + +

+ +