summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Rectangles.html
diff options
context:
space:
mode:
authorDavid Thompson <dthompson@vistahigherlearning.com>2019-06-04 20:49:16 -0400
committerDavid Thompson <dthompson@vistahigherlearning.com>2019-06-04 20:49:16 -0400
commit279f17ac0e1b3d019c2b294098e834d249376686 (patch)
tree47be849d3b35635d167e00cd8448815a75167a23 /manuals/chickadee/Rectangles.html
parent7b808b9268ec735a7a176d10bf1887b3fa66d13e (diff)
Update chickadee manual.
Diffstat (limited to 'manuals/chickadee/Rectangles.html')
-rw-r--r--manuals/chickadee/Rectangles.html83
1 files changed, 43 insertions, 40 deletions
diff --git a/manuals/chickadee/Rectangles.html b/manuals/chickadee/Rectangles.html
index edaf4e6..ecfbde0 100644
--- a/manuals/chickadee/Rectangles.html
+++ b/manuals/chickadee/Rectangles.html
@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
-<!-- Copyright (C) 2017 David Thompson davet@gnu.org
+<!-- Copyright (C) 2017, 2018, 2019 David Thompson davet@gnu.org
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
@@ -13,6 +13,8 @@ A copy of the license is also available from the Free Software
Foundation Web site at http://www.gnu.org/licenses/fdl.html.
+* Chickadee: (chickadee). Game programming toolkit for Guile.
+
The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
-->
@@ -108,220 +110,221 @@ functions that do in-place modification of rectangles for use in
performance critical code paths.
</p>
<dl>
+<dt><a name="index-rect"></a>Procedure: <strong>rect</strong> <em>x y width height</em></dt>
<dt><a name="index-make_002drect"></a>Procedure: <strong>make-rect</strong> <em><var>x</var> <var>y</var> <var>width</var> <var>height</var></em></dt>
<dd><p>Create a new rectangle that is <var>width</var> by <var>height</var> in size and
whose bottom-left corner is located at (<var>x</var>, <var>y</var>).
</p></dd></dl>
<dl>
-<dt><a name="index-rect_003f"></a>Procedure: <strong>rect?</strong> <em><var>obj</var></em></dt>
+<dt><a name="index-rect_003f"></a>Procedure: <strong>rect?</strong> <em>obj</em></dt>
<dd><p>Return <code>#t</code> if <var>obj</var> is a rectangle.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dwithin_003f"></a>Procedure: <strong>rect-within?</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
+<dt><a name="index-rect_002dwithin_003f"></a>Procedure: <strong>rect-within?</strong> <em>rect1 rect2</em></dt>
<dd><p>Return <code>#t</code> if <var>rect2</var> is completely within <var>rect1</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dintersects_003f"></a>Procedure: <strong>rect-intersects?</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
+<dt><a name="index-rect_002dintersects_003f"></a>Procedure: <strong>rect-intersects?</strong> <em>rect1 rect2</em></dt>
<dd><p>Return <code>#t</code> if <var>rect2</var> overlaps <var>rect1</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dcontains_003f"></a>Procedure: <strong>rect-contains?</strong> <em><var>rect</var> <var>x</var> <var>y</var></em></dt>
+<dt><a name="index-rect_002dcontains_003f"></a>Procedure: <strong>rect-contains?</strong> <em>rect x y</em></dt>
<dd><p>Return <code>#t</code> if the coordinates (<var>x</var>, <var>y</var>) are within
<var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dcontains_002dvec2_003f"></a>Procedure: <strong>rect-contains-vec2?</strong> <em><var>rect</var> <var>v</var></em></dt>
+<dt><a name="index-rect_002dcontains_002dvec2_003f"></a>Procedure: <strong>rect-contains-vec2?</strong> <em>rect v</em></dt>
<dd><p>Return <code>#t</code> if the 2D vector <var>v</var> is within the bounds of
<var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dx"></a>Procedure: <strong>rect-x</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002dx"></a>Procedure: <strong>rect-x</strong> <em>rect</em></dt>
<dd><p>Return the X coordinate of the lower-left corner of <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dy"></a>Procedure: <strong>rect-y</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002dy"></a>Procedure: <strong>rect-y</strong> <em>rect</em></dt>
<dd><p>Return the Y coordinate of the lower-left corner of <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dleft"></a>Procedure: <strong>rect-left</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002dleft"></a>Procedure: <strong>rect-left</strong> <em>rect</em></dt>
<dd><p>Return the left-most X coordinate of <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dright"></a>Procedure: <strong>rect-right</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002dright"></a>Procedure: <strong>rect-right</strong> <em>rect</em></dt>
<dd><p>Return the right-most X coordinate of <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dbottom"></a>Procedure: <strong>rect-bottom</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002dbottom"></a>Procedure: <strong>rect-bottom</strong> <em>rect</em></dt>
<dd><p>Return the bottom-most Y coordinate of <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dtop"></a>Procedure: <strong>rect-top</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002dtop"></a>Procedure: <strong>rect-top</strong> <em>rect</em></dt>
<dd><p>Return the top-most Y coordinate of <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dcenter_002dx"></a>Procedure: <strong>rect-center-x</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002dcenter_002dx"></a>Procedure: <strong>rect-center-x</strong> <em>rect</em></dt>
<dd><p>Return the X coordinate of the center of <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dcenter_002dy"></a>Procedure: <strong>rect-center-y</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002dcenter_002dy"></a>Procedure: <strong>rect-center-y</strong> <em>rect</em></dt>
<dd><p>Return the Y coordinate of the center of <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dwidth"></a>Procedure: <strong>rect-width</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002dwidth"></a>Procedure: <strong>rect-width</strong> <em>rect</em></dt>
<dd><p>Return the width of <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dheight"></a>Procedure: <strong>rect-height</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002dheight"></a>Procedure: <strong>rect-height</strong> <em>rect</em></dt>
<dd><p>Return the height of <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002darea"></a>Procedure: <strong>rect-area</strong> <em><var>rect</var></em></dt>
+<dt><a name="index-rect_002darea"></a>Procedure: <strong>rect-area</strong> <em>rect</em></dt>
<dd><p>Return the surface area covered by <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dclamp_002dx"></a>Procedure: <strong>rect-clamp-x</strong> <em><var>rect</var> <var>x</var></em></dt>
+<dt><a name="index-rect_002dclamp_002dx"></a>Procedure: <strong>rect-clamp-x</strong> <em>rect x</em></dt>
<dd><p>Restrict <var>x</var> to the portion of the X axis covered by <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dclamp_002dy"></a>Procedure: <strong>rect-clamp-y</strong> <em><var>rect</var> <var>y</var></em></dt>
+<dt><a name="index-rect_002dclamp_002dy"></a>Procedure: <strong>rect-clamp-y</strong> <em>rect y</em></dt>
<dd><p>Restrict <var>y</var> to the portion of the Y axis covered by <var>rect</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dclamp"></a>Procedure: <strong>rect-clamp</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
+<dt><a name="index-rect_002dclamp"></a>Procedure: <strong>rect-clamp</strong> <em>rect1 rect2</em></dt>
<dd><p>Return a new rect that adjusts the location of <var>rect1</var> so that it
is completely within <var>rect2</var>. An exception is thrown in the case
that <var>rect1</var> cannot fit completely within <var>rect2</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dmove"></a>Procedure: <strong>rect-move</strong> <em><var>rect</var> <var>x</var> <var>y</var></em></dt>
+<dt><a name="index-rect_002dmove"></a>Procedure: <strong>rect-move</strong> <em>rect x y</em></dt>
<dd><p>Return a new rectangle based on <var>rect</var> but moved to the
coordinates (<var>x</var>, <var>y</var>).
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dmove_002dvec2"></a>Procedure: <strong>rect-move-vec2</strong> <em><var>rect</var> <var>v</var></em></dt>
+<dt><a name="index-rect_002dmove_002dvec2"></a>Procedure: <strong>rect-move-vec2</strong> <em>rect v</em></dt>
<dd><p>Return a new rectangle based on <var>rect</var> but moved to the
coordinates in the 2D vector <var>v</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dmove_002dby"></a>Procedure: <strong>rect-move-by</strong> <em><var>rect</var> <var>x</var> <var>y</var></em></dt>
+<dt><a name="index-rect_002dmove_002dby"></a>Procedure: <strong>rect-move-by</strong> <em>rect x y</em></dt>
<dd><p>Return a new rectangle based on <var>rect</var> but moved by (<var>x</var>,
<var>y</var>) units relative to its current location.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dmove_002dby_002dvec2"></a>Procedure: <strong>rect-move-by-vec2</strong> <em><var>rect</var> <var>v</var></em></dt>
+<dt><a name="index-rect_002dmove_002dby_002dvec2"></a>Procedure: <strong>rect-move-by-vec2</strong> <em>rect v</em></dt>
<dd><p>Return a new rectangle based on <var>rect</var> but moved by the 2D vector
<var>v</var> relative to its current location.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dinflate"></a>Procedure: <strong>rect-inflate</strong> <em><var>rect</var> <var>width</var> <var>height</var></em></dt>
+<dt><a name="index-rect_002dinflate"></a>Procedure: <strong>rect-inflate</strong> <em>rect width height</em></dt>
<dd><p>Return a new rectangle based on <var>rect</var>, but expanded by
<var>width</var> units on the X axis and <var>height</var> units on the Y axis,
while keeping the rectangle centered on the same point.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dunion"></a>Procedure: <strong>rect-union</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
+<dt><a name="index-rect_002dunion"></a>Procedure: <strong>rect-union</strong> <em>rect1 rect2</em></dt>
<dd><p>Return a new rectangle that completely covers the area of <var>rect1</var>
and <var>rect2</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dclip"></a>Procedure: <strong>rect-clip</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
+<dt><a name="index-rect_002dclip"></a>Procedure: <strong>rect-clip</strong> <em>rect1 rect2</em></dt>
<dd><p>Return a new rectangle that is the overlapping region of <var>rect1</var>
and <var>rect2</var>. If the two rectangles do not overlap, a rectangle of
0 width and 0 height is returned.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002drect_002dx_0021"></a>Procedure: <strong>set-rect-x!</strong> <em><var>rect</var> <var>x</var></em></dt>
+<dt><a name="index-set_002drect_002dx_0021"></a>Procedure: <strong>set-rect-x!</strong> <em>rect x</em></dt>
<dd><p>Set the left X coordinate of <var>rect</var> to <var>x</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002drect_002dy_0021"></a>Procedure: <strong>set-rect-y!</strong> <em><var>rect</var> <var>y</var></em></dt>
+<dt><a name="index-set_002drect_002dy_0021"></a>Procedure: <strong>set-rect-y!</strong> <em>rect y</em></dt>
<dd><p>Set the bottom Y coordinate of <var>rect</var> to <var>y</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002drect_002dwidth_0021"></a>Procedure: <strong>set-rect-width!</strong> <em><var>rect</var> <var>width</var></em></dt>
+<dt><a name="index-set_002drect_002dwidth_0021"></a>Procedure: <strong>set-rect-width!</strong> <em>rect width</em></dt>
<dd><p>Set the width of <var>rect</var> to <var>width</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-set_002drect_002dheight_0021"></a>Procedure: <strong>set-rect-height!</strong> <em><var>rect</var> <var>height</var></em></dt>
+<dt><a name="index-set_002drect_002dheight_0021"></a>Procedure: <strong>set-rect-height!</strong> <em>rect height</em></dt>
<dd><p>Set the height of <var>rect</var> to <var>height</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dmove_0021"></a>Procedure: <strong>rect-move!</strong> <em><var>rect</var> <var>x</var> <var>y</var></em></dt>
+<dt><a name="index-rect_002dmove_0021"></a>Procedure: <strong>rect-move!</strong> <em>rect x y</em></dt>
<dd><p>Move <var>rect</var> to (<var>x</var>, <var>y</var>) in-place.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dmove_002dvec2_0021"></a>Procedure: <strong>rect-move-vec2!</strong> <em><var>rect</var> <var>v</var></em></dt>
+<dt><a name="index-rect_002dmove_002dvec2_0021"></a>Procedure: <strong>rect-move-vec2!</strong> <em>rect v</em></dt>
<dd><p>Move <var>rect</var> to the 2D vector <var>v</var> in-place.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dmove_002dby_0021"></a>Procedure: <strong>rect-move-by!</strong> <em><var>rect</var> <var>x</var> <var>y</var></em></dt>
+<dt><a name="index-rect_002dmove_002dby_0021"></a>Procedure: <strong>rect-move-by!</strong> <em>rect x y</em></dt>
<dd><p>Move <var>rect</var> by (<var>x</var>, <var>y</var>) in-place.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dmove_002dby_002dvec2_0021"></a>Procedure: <strong>rect-move-by-vec2!</strong> <em><var>rect</var> <var>v</var></em></dt>
+<dt><a name="index-rect_002dmove_002dby_002dvec2_0021"></a>Procedure: <strong>rect-move-by-vec2!</strong> <em>rect v</em></dt>
<dd><p>Move <var>rect</var> by the 2D vector <var>v</var> in-place.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dinflate_0021"></a>Procedure: <strong>rect-inflate!</strong> <em><var>rect</var> <var>width</var> <var>height</var></em></dt>
+<dt><a name="index-rect_002dinflate_0021"></a>Procedure: <strong>rect-inflate!</strong> <em>rect width height</em></dt>
<dd><p>Expand <var>rect</var> by <var>width</var> and <var>height</var> in-place.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dunion_0021"></a>Procedure: <strong>rect-union!</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
+<dt><a name="index-rect_002dunion_0021"></a>Procedure: <strong>rect-union!</strong> <em>rect1 rect2</em></dt>
<dd><p>Modify <var>rect1</var> in-place to completely cover the area of both
<var>rect1</var> and <var>rect2</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dclip_0021"></a>Procedure: <strong>rect-clip!</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
+<dt><a name="index-rect_002dclip_0021"></a>Procedure: <strong>rect-clip!</strong> <em>rect1 rect2</em></dt>
<dd><p>Modify <var>rect1</var> in-place to be the overlapping region of
<var>rect1</var> and <var>rect2</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-rect_002dclamp_0021"></a>Procedure: <strong>rect-clamp!</strong> <em><var>rect1</var> <var>rect2</var></em></dt>
+<dt><a name="index-rect_002dclamp_0021"></a>Procedure: <strong>rect-clamp!</strong> <em>rect1 rect2</em></dt>
<dd><p>Adjust the location of <var>rect1</var> in-place so that its bounds are
completely within <var>rect2</var>. An exception is thrown in the case
that <var>rect1</var> cannot fit completely within <var>rect2</var>.
</p></dd></dl>
<dl>
-<dt><a name="index-vec2_002dclamp_002dto_002drect_0021"></a>Procedure: <strong>vec2-clamp-to-rect!</strong> <em><var>v</var> <var>rect</var></em></dt>
+<dt><a name="index-vec2_002dclamp_002dto_002drect_0021"></a>Procedure: <strong>vec2-clamp-to-rect!</strong> <em>v rect</em></dt>
<dd><p>Restrict the coordinates of the 2D vector <var>v</var> so that they are
within the bounds of <var>rect</var>. <var>v</var> is modified in-place.
</p></dd></dl>