From 6d78be95569519bcad7d381e4135f76bf5bd31ec Mon Sep 17 00:00:00 2001
From: David Thompson <dthompson2@worcester.edu>
Date: Sat, 1 Apr 2017 12:00:44 -0400
Subject: input: Add keyboard module.

* chickadee/input/keyboard.scm: New file.
* Makefile.am (SOURCES): Add it.
* doc/api.texi (Keyboard): New section.
---
 doc/api.texi | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'doc')

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
 
-- 
cgit v1.2.3