summaryrefslogtreecommitdiff
path: root/manuals/guile-sdl2/Game-Controllers.html
diff options
context:
space:
mode:
Diffstat (limited to 'manuals/guile-sdl2/Game-Controllers.html')
-rw-r--r--manuals/guile-sdl2/Game-Controllers.html192
1 files changed, 192 insertions, 0 deletions
diff --git a/manuals/guile-sdl2/Game-Controllers.html b/manuals/guile-sdl2/Game-Controllers.html
new file mode 100644
index 0000000..1b77c66
--- /dev/null
+++ b/manuals/guile-sdl2/Game-Controllers.html
@@ -0,0 +1,192 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<!-- Copyright (C) 2016 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.5, http://www.gnu.org/software/texinfo/ -->
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<title>Game Controllers (Guile-SDL2)</title>
+
+<meta name="description" content="Game Controllers (Guile-SDL2)">
+<meta name="keywords" content="Game Controllers (Guile-SDL2)">
+<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="Input.html#Input" rel="up" title="Input">
+<link href="Events.html#Events" rel="next" title="Events">
+<link href="Joysticks.html#Joysticks" rel="prev" title="Joysticks">
+<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.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">
+<a name="Game-Controllers"></a>
+<div class="header">
+<p>
+Previous: <a href="Joysticks.html#Joysticks" accesskey="p" rel="prev">Joysticks</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="Game-Controllers-1"></a>
+<h4 class="subsection">3.3.4 Game Controllers</h4>
+
+<div class="example">
+<pre class="example">(use-modules (sdl2 input game-controller))
+</pre></div>
+
+<dl>
+<dt><a name="index-load_002dgame_002dcontroller_002dmappings_0021"></a>Procedure: <strong>load-game-controller-mappings!</strong> <em>file</em></dt>
+<dd><p>Load game controller mapping from <var>file</var> and return the number of
+mappings added this way.
+</p>
+<p>See <a href="https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt">https://raw.github.com/gabomdq/SDL_GameControllerDB/master/gamecontrollerdb.txt</a>
+for a community maintained controller mapping file.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-open_002dgame_002dcontroller"></a>Procedure: <strong>open-game-controller</strong> <em>joystick-index</em></dt>
+<dd><p>Return a game controller object for the physical joystick device associated
+with the <var>joystick-index</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-close_002dgame_002dcontroller"></a>Procedure: <strong>close-game-controller</strong> <em>controller</em></dt>
+<dd><p>Close <var>controller</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-game_002dcontroller_003f"></a>Procedure: <strong>game-controller?</strong> <em>controller</em></dt>
+<dd><p>Close <var>controller</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-game_002dcontroller_002dattached_003f"></a>Procedure: <strong>game-controller-attached?</strong> <em>controller</em></dt>
+<dd><p>Return <code>#t</code> if <var>controller</var> is currently in use.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-game_002dcontroller_002djoystick"></a>Procedure: <strong>game-controller-joystick</strong> <em>controller</em></dt>
+<dd><p>Return the underlying joystick object associated with <var>controller</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-game_002dcontroller_002dname"></a>Procedure: <strong>game-controller-name</strong> <em>controller</em></dt>
+<dd><p>Return the human readable name for <var>controller</var>.
+</p></dd></dl>
+
+<dl>
+<dt><a name="index-game_002dcontroller_002daxis"></a>Procedure: <strong>game-controller-axis</strong> <em>controller axis</em></dt>
+<dd><p>Return a number in the range [-32768, 32767] representing the
+current state of <var>axis</var> on <var>controller</var>.
+</p>
+<p><var>axis</var> may be one of the following symbols:
+</p><ul>
+<li> <code>left-x</code>
+</li><li> <code>left-y</code>
+</li><li> <code>right-x</code>
+</li><li> <code>right-y</code>
+</li><li> <code>trigger-left</code>
+</li><li> <code>trigger-right</code>
+</li></ul>
+</dd></dl>
+
+<dl>
+<dt><a name="index-game_002dcontroller_002dbutton_002dpressed_003f"></a>Procedure: <strong>game-controller-button-pressed?</strong> <em>controller button</em></dt>
+<dd><p>Return <code>#t</code> if <var>button</var> is pressed on <var>controller</var>.
+</p>
+<p><var>button</var> may be one of the following symbols:
+</p><ul>
+<li> <code>a</code>
+</li><li> <code>b</code>
+</li><li> <code>x</code>
+</li><li> <code>y</code>
+</li><li> <code>back</code>
+</li><li> <code>guide</code>
+</li><li> <code>start</code>
+</li><li> <code>left-stick</code>
+</li><li> <code>right-stick</code>
+</li><li> <code>left-shoulder</code>
+</li><li> <code>right-shoulder</code>
+</li><li> <code>dpad-up</code>
+</li><li> <code>dpad-down</code>
+</li><li> <code>dpad-left</code>
+</li><li> <code>dpad-right</code>
+</li></ul>
+</dd></dl>
+
+<dl>
+<dt><a name="index-game_002dcontroller_002dindex_003f"></a>Procedure: <strong>game-controller-index?</strong> <em>joystick-index</em></dt>
+<dd><p>Return <code>#t</code> if <var>joystick-index</var> is a valid game controller index.
+</p></dd></dl>
+
+
+
+
+</body>
+</html>