summaryrefslogtreecommitdiff
path: root/manuals/chickadee/Input-Devices.html
diff options
context:
space:
mode:
Diffstat (limited to 'manuals/chickadee/Input-Devices.html')
-rw-r--r--manuals/chickadee/Input-Devices.html156
1 files changed, 156 insertions, 0 deletions
diff --git a/manuals/chickadee/Input-Devices.html b/manuals/chickadee/Input-Devices.html
new file mode 100644
index 0000000..0b50481
--- /dev/null
+++ b/manuals/chickadee/Input-Devices.html
@@ -0,0 +1,156 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!-- Copyright (C) 2017-2020 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
+or any later version published by the Free Software Foundation;
+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+A copy of the license is included in the section entitled "GNU
+Free Documentation License".
+
+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).
+ -->
+<!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Input Devices (The Chickadee Game Toolkit)</title>
+
+<meta name="description" content="Input Devices (The Chickadee Game Toolkit)">
+<meta name="keywords" content="Input Devices (The Chickadee Game Toolkit)">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="makeinfo">
+<link href="index.html#Top" rel="start" title="Top">
+<link href="Index.html#Index" rel="index" title="Index">
+<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
+<link href="Kernel.html#Kernel" rel="up" title="Kernel">
+<link href="Window-Manipulation.html#Window-Manipulation" rel="next" title="Window Manipulation">
+<link href="The-Game-Loop.html#The-Game-Loop" rel="prev" title="The Game Loop">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.indentedblock {margin-right: 0em}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+kbd {font-style: oblique}
+pre.display {font-family: inherit}
+pre.format {font-family: inherit}
+pre.menu-comment {font-family: serif}
+pre.menu-preformatted {font-family: serif}
+span.nolinebreak {white-space: nowrap}
+span.roman {font-family: initial; font-weight: normal}
+span.sansserif {font-family: sans-serif; font-weight: normal}
+ul.no-bullet {list-style: none}
+@media (min-width: 1140px) {
+ body {
+ margin-left: 14rem;
+ margin-right: 4rem;
+ max-width: 52rem;
+ }
+}
+
+@media (min-width: 800px) and (max-width: 1140px) {
+ body {
+ margin-left: 6rem;
+ margin-right: 4rem;
+ max-width: 52rem;
+ }
+}
+
+@media (max-width: 800px) {
+ body {
+ margin: 1rem;
+ }
+}
+
+-->
+</style>
+<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css">
+
+
+</head>
+
+<body lang="en">
+<span id="Input-Devices"></span><div class="header">
+<p>
+Next: <a href="Window-Manipulation.html#Window-Manipulation" accesskey="n" rel="next">Window Manipulation</a>, Previous: <a href="The-Game-Loop.html#The-Game-Loop" accesskey="p" rel="prev">The Game Loop</a>, Up: <a href="Kernel.html#Kernel" accesskey="u" rel="up">Kernel</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
+</div>
+<hr>
+<span id="Input-Devices-1"></span><h4 class="subsection">2.1.2 Input Devices</h4>
+
+<p>While <code>run-game</code> provides hooks for mouse/keyboard/controller
+input events, it is often necessary to query input devices for their
+current state. For example, it could be desirable to query the state
+of the arrow keys every time the update hook is called to determine
+which direction the player should move that frame.
+</p>
+<dl>
+<dt id="index-key_002dpressed_003f">Procedure: <strong>key-pressed?</strong> <em>key</em></dt>
+<dd><p>Return <code>#t</code> if <var>key</var> is currently being pressed.
+</p></dd></dl>
+
+<dl>
+<dt id="index-key_002dreleased_003f">Procedure: <strong>key-released?</strong> <em>key</em></dt>
+<dd><p>Return <code>#t</code> if <var>key</var> is <em>not</em> currently being pressed.
+</p></dd></dl>
+
+<dl>
+<dt id="index-mouse_002dx">Procedure: <strong>mouse-x</strong></dt>
+<dd><p>Return the current X coordinate of the mouse cursor.
+</p></dd></dl>
+
+<dl>
+<dt id="index-mouse_002dy">Procedure: <strong>mouse-y</strong></dt>
+<dd><p>Return the current Y coordinate of the mouse cursor.
+</p></dd></dl>
+
+<dl>
+<dt id="index-mouse_002dbutton_002dpressed_003f">Procedure: <strong>mouse-button-pressed?</strong> <em>button</em></dt>
+<dd><p>Return <code>#t</code> if <var>button</var> is currently being pressed.
+</p></dd></dl>
+
+<dl>
+<dt id="index-mouse_002dbutton_002dreleased_003f">Procedure: <strong>mouse-button-released?</strong> <em>button</em></dt>
+<dd><p>Return <code>#t</code> if <var>button</var> is <em>not</em> currently being
+pressed.
+</p></dd></dl>
+
+<dl>
+<dt id="index-controller_002daxis">Procedure: <strong>controller-axis</strong> <em>controller axis</em></dt>
+<dd><p>Return a floating point value in the range [-1, 1] corresponding to
+how much <var>axis</var> (an analog stick or trigger) is being pushed on
+<var>controller</var>. 0 is returned if <var>axis</var> is not being pushed at
+all.
+</p></dd></dl>
+
+<dl>
+<dt id="index-controller_002dname">Procedure: <strong>controller-name</strong> <em>controller</em></dt>
+<dd><p>Return the name of <var>controller</var>.
+</p></dd></dl>
+
+<dl>
+<dt id="index-controller_002dbutton_002dpressed_003f">Procedure: <strong>controller-button-pressed?</strong> <em>controller button</em></dt>
+<dd><p>Return <code>#t</code> if <var>button</var> on <var>controller</var> is currently
+being pressed.
+</p></dd></dl>
+
+<dl>
+<dt id="index-controller_002dbutton_002dreleased_003f">Procedure: <strong>controller-button-released?</strong> <em>controller button</em></dt>
+<dd><p>Return <code>#t</code> if <var>button</var> on <var>controller</var> is <em>not</em>
+currently being pressed.
+</p></dd></dl>
+
+
+
+
+</body>
+</html>