Add Sly manual.

author: David Thompson <dthompson2@worcester.edu> 2016-08-19 20:40:12 -0400
committer: David Thompson <dthompson2@worcester.edu> 2016-08-19 20:40:12 -0400
commit: 9224412274e1e1a31a959083bb257a7d6ab2b113 (patch)
tree: c82ef8b0136037aa1b278957f42ae665188861be /manuals/sly/Joystick.html
parent: c47d942552568e9a866e9d4887944e0c074dec93 (diff)
1 files changed, 188 insertions, 0 deletions
diff --git a/manuals/sly/Joystick.html b/manuals/sly/Joystick.html
new file mode 100644
index 0000000..68748c3
--- /dev/null
+++ b/manuals/sly/Joystick.html
@@ -0,0 +1,188 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!-- Copyright (C) 2013, 2014  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.
+
+
+The document was typeset with
+http://www.texinfo.org/ (GNU Texinfo).
+ -->
+<!-- Created by GNU Texinfo 6.0, http://www.gnu.org/software/texinfo/ -->
+<head>
+<title>Sly: Joystick</title>
+
+<meta name="description" content="Sly: Joystick">
+<meta name="keywords" content="Sly: Joystick">
+<meta name="resource-type" content="document">
+<meta name="distribution" content="global">
+<meta name="Generator" content="makeinfo">
+<meta charset="UTF-8">
+<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="Input.html#Input" rel="up" title="Input">
+<link href="Rendering.html#Rendering" rel="next" title="Rendering">
+<link href="Mouse.html#Mouse" rel="prev" title="Mouse">
+<style type="text/css">
+<!--
+a.summary-letter {text-decoration: none}
+blockquote.indentedblock {margin-right: 0em}
+blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
+blockquote.smallquotation {font-size: smaller}
+div.display {margin-left: 3.2em}
+div.example {margin-left: 3.2em}
+div.lisp {margin-left: 3.2em}
+div.smalldisplay {margin-left: 3.2em}
+div.smallexample {margin-left: 3.2em}
+div.smalllisp {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}
+pre.smalldisplay {font-family: inherit; font-size: smaller}
+pre.smallexample {font-size: smaller}
+pre.smallformat {font-family: inherit; font-size: smaller}
+pre.smalllisp {font-size: smaller}
+span.nocodebreak {white-space: nowrap}
+span.nolinebreak {white-space: nowrap}
+span.roman {font-family: serif; font-weight: normal}
+span.sansserif {font-family: sans-serif; font-weight: normal}
+ul.no-bullet {list-style: none}
+-->
+</style>
+
+
+</head>
+
+<body lang="en">
+<a name="Joystick"></a>
+<div class="header">
+<p>
+Previous: <a href="Mouse.html#Mouse" accesskey="p" rel="prev">Mouse</a>, Up: <a href="Input.html#Input" accesskey="u" rel="up">Input</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>
+<a name="Joystick-1"></a>
+<h4 class="subsection">4.4.3 Joystick</h4>
+
+<div class="example">
+<pre class="example">(use-modules (sly input joystick))
+</pre></div>
+
+<p>Joystick hooks, signals, and procedures.
+</p>
+<p>Before using joystick procedures, you must first call the
+initialization procedure <code>enable-joystick</code>.
+</p>
+<dl>
+<dt><a name="index-enable_002djoystick"></a>Scheme Procedure: <strong>enable-joystick</strong></dt>
+<dd><p>Initialize joystick module.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-joystick_002dnum_002daxes"></a>Scheme Procedure: <strong>joystick-num-axes</strong> <em><var>idx</var></em></dt>
+<dd><p>Get number of axes of joystick at <code>idx</code>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-joystick_002dnum_002dbuttons"></a>Scheme Procedure: <strong>joystick-num-buttons</strong> <em><var>idx</var></em></dt>
+<dd><p>Get number of buttons of joystick at <code>idx</code>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-joystick_002daxis_002dhook"></a>Scheme Variable: <strong>joystick-axis-hook</strong></dt>
+<dd><p>This hook is run whenever a joystick motion occurs.  Procedures added
+to this hook should accept three arguments: <code>which</code>, the joystick
+ID; <code>axis</code>, the axis ID; and <code>value</code>, the motion coordinate.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-joystick_002dbutton_002dpress_002dhook"></a>Scheme Variable: <strong>joystick-button-press-hook</strong></dt>
+<dd><p>This hook is run whenever a joystick button is pressed.  Procedures
+added to this hook should accept two arguments: <code>which</code>, the
+joystick ID; <code>button</code>, the button ID.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-joystick_002dbutton_002drelease_002dhook"></a>Scheme Variable: <strong>joystick-button-release-hook</strong></dt>
+<dd><p>This hook is run whenever a joystick button is released.  Procedures
+added to this hook should accept two arguments: <code>which</code>, the
+joystick ID; <code>button</code>, the button ID.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-raw_002daxis_002dmin"></a>Scheme Variable: <strong>raw-axis-min</strong></dt>
+<dd><p>-32768
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-raw_002daxis_002dmax"></a>Scheme Variable: <strong>raw-axis-max</strong></dt>
+<dd><p>32767
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-axis_002dvalue_002draw"></a>Scheme Procedure: <strong>axis-value-raw</strong> <em><var>idx</var> <var>axis</var></em></dt>
+<dd><p>Create a signal on the axis at <code>axis</code> of the joystick at
+<var>idx</var>; joystick axis values are stored in a signed 16 bit integer
+and so, values range from [<code>raw-axis-min</code>, <code>raw-axis-max</code>].
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-axis_002dvalue"></a>Scheme Procedure: <strong>axis-value</strong> <em><var>idx</var> <var>axis</var></em></dt>
+<dd><p>Create a signal for the value of <var>axis</var> on joystick <var>idx</var>;
+values are scaled to the range [-1,1].
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-button_002ddown_003f"></a>Scheme Procedure: <strong>button-down?</strong> <em><var>idx</var> <var>n</var></em></dt>
+<dd><p>Create a signal for the state of button <code>n</code> on joystick at
+<code>idx</code>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-make_002ddirectional_002dsignal"></a>Scheme Procedure: <strong>make-directional-signal</strong> <em><var>idx</var> <var>x-axis</var> <var>y-axis</var></em></dt>
+<dd><p>Create a signal for a directional pad or analog stick with <code>x</code>
+and <code>y</code> axes.  Values are scaled to the range [-1,1].
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-make_002ddirectional_002dsignal_002draw"></a>Scheme Procedure: <strong>make-directional-signal-raw</strong> <em>idx x-axis y-axis</em></dt>
+<dd><p>Create a signal for a directional pad or analog stick with <code>x</code>
+and <code>y</code> axes.  Values range from [<code>raw-axis-min</code>,
+<code>raw-axis-max</code>].
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-axis_002dscale"></a>Scheme Procedure: <strong>axis-scale</strong> <em><var>raw-value</var></em></dt>
+<dd><p>Map <code>raw-value</code> in the range [<code>raw-axis-min</code>,
+<code>raw-axis-max</code>] to a value in the range [-1, 1].
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-joystick_002dname"></a>Scheme Procedure: <strong>joystick-name</strong> <em><var>joystick</var></em></dt>
+<dd><p>Return the name of <code>joystick</code>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-num_002djoysticks"></a>Scheme Procedure: <strong>num-joysticks</strong></dt>
+<dd><p>Return the number of joysticks available.
+</p></dd></dl>
+<hr>
+<div class="header">
+<p>
+Previous: <a href="Mouse.html#Mouse" accesskey="p" rel="prev">Mouse</a>, Up: <a href="Input.html#Input" accesskey="u" rel="up">Input</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>
+
+
+
+</body>
+</html>
author	David Thompson <dthompson2@worcester.edu>	2016-08-19 20:40:12 -0400
committer	David Thompson <dthompson2@worcester.edu>	2016-08-19 20:40:12 -0400
commit	9224412274e1e1a31a959083bb257a7d6ab2b113 (patch)
tree	c82ef8b0136037aa1b278957f42ae665188861be /manuals/sly/Joystick.html
parent	c47d942552568e9a866e9d4887944e0c074dec93 (diff)