summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2021-04-09 22:37:49 -0400
committerDavid Thompson <dthompson2@worcester.edu>2021-04-09 22:45:33 -0400
commite05aa45f672eb49312449d359a9e345223741b19 (patch)
tree1a00e89b1116546c2fb93e294870f9005fea46dc /doc
parent5c919ae2dfaee36d689b2c2bedee1d2745bd2d6d (diff)
graphics: Rewrite tile map module.
Diffstat (limited to 'doc')
-rw-r--r--doc/api.texi25
1 files changed, 23 insertions, 2 deletions
diff --git a/doc/api.texi b/doc/api.texi
index e99c89c..28a5553 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -2532,7 +2532,7 @@ A tile map is a scene created by composing lots of small sprites,
called ``tiles'', into a larger image. One program for editing such
maps is called @url{http://mapeditor.org,Tiled}. Chickadee has native
support for loading and rendering Tiled maps in the @code{(chickadee
-graphics tiled)} module.
+graphics tile-map)} module.
@deffn {Procedure} load-tile-map file-name
Load the Tiled formatted map in @var{file-name} and return a new tile
@@ -2581,7 +2581,8 @@ coordinates.
@end deffn
@deffn {Procedure} draw-tile-map tile-map [#:layers] [#:camera] @
- [#:origin] [#:position] [#:scale] [#:rotation]
+ [#:origin] [#:position] [#:scale] [#:rotation] [#:blend-mode] @
+ [#:tint] [#:time] [#:chunk-size]
Draw the layers of @var{tile-map} as viewed from @var{camera}, a 2D
vector offset. By default, all layers are drawn. To draw a subset of
@@ -2621,6 +2622,14 @@ Return the texture atlas for @var{tileset}.
Return the tiles in @var{tileset}.
@end deffn
+@deffn {Procedure} tileset-rows tileset
+Return the number of rows in @var{tileset}.
+@end deffn
+
+@deffn {Procedure} tileset-columns tileset
+Return the number of columns in @var{tileset}.
+@end deffn
+
@deffn {Procedure} tileset-properties tileset
Return the custom properties of @var{tileset}.
@end deffn
@@ -2641,6 +2650,18 @@ Return the animation for @var{tile}.
Return the custom properties of @var{tile}.
@end deffn
+@deffn {Procedure} animation? obj
+Return @code{#t} if @var{obj} is an animation.
+@end deffn
+
+@deffn {Procedure} animation-frames animation
+Return a vector of frames in @var{animation}.
+@end deffn
+
+@deffn {Procedure} animation-duration animation
+Return the duration of @var{animation}.
+@end deffn
+
@deffn {Procedure} animation-frame? obj
Return @code{#t} if @var{obj} is an animation frame.
@end deffn