summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2017-01-25 22:28:00 -0500
committerDavid Thompson <dthompson2@worcester.edu>2017-01-25 22:28:00 -0500
commit6306a7dc561d1108586c4a9c27b869f9a60e18a5 (patch)
treea7ef5a0a4273c225eb9464afcbee2de19bb632d2
parent0c9e24e2bd5daa263ec0b90013101f39ea35158d (diff)
doc: Fix multi-line @deffn commands.
-rw-r--r--doc/api.texi25
1 files changed, 14 insertions, 11 deletions
diff --git a/doc/api.texi b/doc/api.texi
index d72980a..9f4ca69 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -31,9 +31,10 @@ There are many hooks available, so read on to learn about all of them.
For information about using Guile's hook API, see @xref{Hooks,,,
guile, GNU Guile Reference Manual}.
-@deffn {Scheme Procedure} run-game [#:window-title "Chickadee!"]
- [#:window-width 640] [#:window-height 480] [#:window-fullscreen? #f]
+@deffn {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
@code{abort-game} is called.
@@ -445,8 +446,10 @@ would be tedious to have to have to specify them each time
The following procedures and syntax can be found in the
@code{(chickadee render)} module.
-@deffn {Scheme Syntax} gpu-apply @var{shader} @var{vertex-array} [#:uniform-key @var{uniform-value} ...]
-@deffnx {Scheme Syntax} gpu-apply* @var{shader} @var{vertex-array} @var{count} [#:uniform-key @var{uniform-value} ...]
+@deffn {Scheme Syntax} gpu-apply @var{shader} @var{vertex-array} @
+ [#:uniform-key @var{uniform-value} ...]
+@deffnx {Scheme Syntax} gpu-apply* @var{shader} @var{vertex-array} @
+ @var{count} [#:uniform-key @var{uniform-value} ...]
Render @var{vertex-array} using @var{shader} with the uniform values
specified in the following keyword arguments.
@@ -518,7 +521,7 @@ Evaluate @var{body} with the current projection matrix bound to
@node Textures
@subsection Textures
-@deffn {Scheme Procedure} load-image @var{file} [#:min-filter nearest]
+@deffn {Scheme Procedure} load-image @var{file} [#:min-filter nearest] @
[#:mag-filter nearest] [#:wrap-s repeat] [#:wrap-t repeat]
Load the image data from @var{file} and return a new texture object.
@@ -544,8 +547,8 @@ players, NPCs, items, particles, text, etc. In Chickadee, bitmaps are
stored in textures (@pxref{Textures}) and can be used to draw sprites
via the @code{draw-sprite} procedure.
-@deffn {Scheme Procedure} draw-sprite @var{texture} @var{region}
- [#:scale] [#:rotation] [#:blend-mode alpha] [#:texture-region]
+@deffn {Scheme Procedure} draw-sprite @var{texture} @var{region} @
+ [#:scale] [#:rotation] [#:blend-mode alpha] [#:texture-region] @
[#:shader]
@end deffn
@@ -603,10 +606,10 @@ interface widgets like buttons and dialog boxes. By using a nine
patch, they can be rendered at any size without unappealing scaling
artifacts.
-@deffn {Scheme Procedure} draw-nine-patch @var{texture} @var{region}
- [#:margin 0] [#:top-margin margin] [#:bottom-margin margin]
- [#:left-margin margin] [#:right-margin margin]
- [#:texture-region] [#:scale] [#:rotation] [#:blend-mode alpha]
+@deffn {Scheme Procedure} draw-nine-patch @var{texture} @var{region} @
+ [#:margin 0] [#:top-margin margin] [#:bottom-margin margin] @
+ [#:left-margin margin] [#:right-margin margin] @
+ [#:texture-region] [#:scale] [#:rotation] [#:blend-mode alpha] @
[#:shader]
Draw a nine patch sprite. A nine patch sprite renders @var{texture}