summaryrefslogtreecommitdiff
path: root/manuals/guile-sdl2/Game-Controllers.html
blob: 0a1df88405f2ba9320b89b7fc3cd95aafac417db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 2016, 2017, 2018, 2019  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.


* Guile-SDL2: (guile-sdl2).     SDL2 bindings for Guile.

The document was typeset with
http://www.texinfo.org/ (GNU Texinfo).
 -->
<!-- Created by GNU Texinfo 6.7, 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" rel="start" title="Top">
<link href="Index.html" rel="index" title="Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Input.html" rel="up" title="Input">
<link href="Events.html" rel="next" title="Events">
<link href="Joysticks.html" rel="prev" title="Joysticks">
<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="Game-Controllers"></span><div class="header">
<p>
Previous: <a href="Joysticks.html" accesskey="p" rel="prev">Joysticks</a>, Up: <a href="Input.html" 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" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Game-Controllers-1"></span><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 id="index-load_002dgame_002dcontroller_002dmappings_0021">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 id="index-open_002dgame_002dcontroller">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 id="index-close_002dgame_002dcontroller">Procedure: <strong>close-game-controller</strong> <em>controller</em></dt>
<dd><p>Close <var>controller</var>.
</p></dd></dl>

<dl>
<dt id="index-game_002dcontroller_003f">Procedure: <strong>game-controller?</strong> <em>controller</em></dt>
<dd><p>Close <var>controller</var>.
</p></dd></dl>

<dl>
<dt id="index-game_002dcontroller_002dattached_003f">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 id="index-game_002dcontroller_002djoystick">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 id="index-game_002dcontroller_002dname">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 id="index-game_002dcontroller_002daxis">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 id="index-game_002dcontroller_002dbutton_002dpressed_003f">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 id="index-game_002dcontroller_002dindex_003f">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>