summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Thompson <dthompson2@worcester.edu>2017-04-01 12:00:44 -0400
committerDavid Thompson <dthompson2@worcester.edu>2017-04-01 12:00:44 -0400
commit6d78be95569519bcad7d381e4135f76bf5bd31ec (patch)
treee7fc6893992291450637103ae8dc102f19fccb1f /doc
parent1234a65ee79b087125b64d7bd9fa7b2be23f47e7 (diff)
input: Add keyboard module.
* chickadee/input/keyboard.scm: New file. * Makefile.am (SOURCES): Add it. * doc/api.texi (Keyboard): New section.
Diffstat (limited to 'doc')
-rw-r--r--doc/api.texi18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/api.texi b/doc/api.texi
index 126d7dd..74ccfff 100644
--- a/doc/api.texi
+++ b/doc/api.texi
@@ -378,6 +378,24 @@ values are:
@node Input
@section Input
+Chickadee can handle input events from the keyboard, mouse, and game
+controllers.
+
+@menu
+* Keyboard:: Keyboard input.
+@end menu
+
+@node Keyboard
+@subsection Keyboard
+
+@deffn {Scheme Procedure} key-pressed? @var{key}
+Return @code{#t} if @var{key} is currently being pressed.
+@end deffn
+
+@deffn {Scheme Procedure} key-released? @var{key}
+Return @code{#t} if @var{key} is not currently being pressed.
+@end deffn
+
@node Math
@section Math