1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21      span.virtual_style
22      {
23        font-size			 : 8pt;
24        color				 : white;
25        font-weight			: bold;
26        background			: #0a0;
27        border-left			: solid 1px #0f0;
28        border-top			: solid 1px #0f0;
29        border-right		: solid 1px #060;
30        border-bottom		: solid 1px #060;
31        padding-left		: 2px;
32        padding-right		: 2px;
33      }
34      span.protected_style
35      {
36        font-size			 : 8pt;
37        color				 : white;
38        font-weight			: bold;
39        background			: #444;
40        border-left			: solid 1px #ccc;
41        border-top			: solid 1px #ccc;
42        border-right		: solid 1px #222;
43        border-bottom		: solid 1px #222;
44        padding-left		: 2px;
45        padding-right		: 2px;
46      }
47        --></style>
48<title>nn::hid::CTR::PadReader</title>
49  </head>
50  <body>
51<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/hid/Overview.html">hid</a>::<a href="../../../../nn/hid/CTR/Overview.html">CTR</a>::PadReader</CODE> Class</h1>
52<h2>Syntax</h2>
53    <div class="section">
54<pre class="definition">class PadReader : private <a href="../../../../nn/util/NonCopyable/Overview.html">nn::util::NonCopyable< PadReader ></a></pre>
55    </div>
56<h2>Description</h2>
57    <div class="section">
58<p>A class that reads sampling data from the gamepad (the gameplay buttons and the Circle Pad).</p><p>The gamepad is sampled every 4 milliseconds.</p><!-- write here --></div>
59    <a name="enum" id="enum">
60<h2>Enumerated Types</h2>
61      <div class="section">
62        <table class="members">
63          <tr>
64            <td width="100"> </td>
65            <th>
66<a href="../../../../nn/hid/CTR/PadReader/StickClampMode.html"><CODE>StickClampMode</CODE></a>
67            </th>
68<td>Enumerated type that indicates the Circle Pad clamp mode set by the <a href="../../../../nn/hid/CTR/PadReader/SetStickClampMode.html"><CODE>SetStickClampMode</CODE></a> function.</td>
69          </tr> </table>
70      </div>
71    </a> <a name="constant" id="constant">
72<h2>Member Constants</h2>
73      <div class="section">
74        <table class="members">
75          <tr>
76            <td width="100">
77<span class="static_style" title="static">S</span>
78            </td>
79            <th>
80<span class="argument"><a href="../../../../nn/hid/CTR/PadReader/MAX_READ_NUM.html"><CODE>MAX_READ_NUM</CODE></a></span>
81            </th>
82<td width="100">const <a href="../../../../nn_types/s8.html">s8</a></td>
83<td>The maximum number of data samples that can be read.</td>
84          </tr> </table>
85      </div>
86    </a> <a name="function" id="function">
87<h2>Member Functions</h2>
88      <div class="section">
89        <table class="members">
90          <tr>
91            <td width="100">  </td>
92            <th>
93<a href="../../../../nn/hid/CTR/PadReader/PadReader.html"><CODE>PadReader</CODE></a>
94            </th>
95<td>Constructor.</td>
96          </tr>
97          <tr>
98            <td width="100">  </td>
99            <th>
100<a href="../../../../nn/hid/CTR/PadReader/~PadReader.html"><CODE>~PadReader</CODE></a>
101            </th>
102<td>Destructor.</td>
103          </tr>
104          <tr>
105            <td width="100">  </td>
106            <th>
107<a href="../../../../nn/hid/CTR/PadReader/Read.html"><CODE>Read</CODE></a>
108            </th>
109<td>Loads sampling data from the gamepad, starting with the most recent samples. Does not load any data that has been previously loaded.</td>
110          </tr>
111          <tr>
112            <td width="100">  </td>
113            <th>
114<a href="../../../../nn/hid/CTR/PadReader/ReadLatest.html"><CODE>ReadLatest</CODE></a>
115            </th>
116<td>Loads the most recent sampling data from the gamepad. Unlike the <a href="../../../../nn/hid/CTR/PadReader/Read.html"><CODE>nn::hid::CTR::PadReader::Read</CODE></a> function, this function can load the same sampling data more than once.</td>
117          </tr>
118          <tr>
119            <td width="100">  </td>
120            <th>
121<a href="../../../../nn/hid/CTR/PadReader/SetStickClamp.html"><CODE>SetStickClamp</CODE></a>
122            </th>
123<td>Sets the clamp values for the Circle Pad.</td>
124          </tr>
125          <tr>
126            <td width="100">  </td>
127            <th>
128<a href="../../../../nn/hid/CTR/PadReader/GetStickClamp.html"><CODE>GetStickClamp</CODE></a>
129            </th>
130<td>Gets the clamp values of the current clamp mode for the Circle Pad.</td>
131          </tr>
132          <tr>
133            <td width="100">  </td>
134            <th>
135<a href="../../../../nn/hid/CTR/PadReader/GetStickClampMode.html"><CODE>GetStickClampMode</CODE></a>
136            </th>
137<td>Gets the clamp mode for the Circle Pad.</td>
138          </tr>
139          <tr>
140            <td width="100">  </td>
141            <th>
142<a href="../../../../nn/hid/CTR/PadReader/SetStickClampMode.html"><CODE>SetStickClampMode</CODE></a>
143            </th>
144<td>Sets the clamp mode for the Circle Pad.</td>
145          </tr>
146          <tr>
147            <td width="100">  </td>
148            <th>
149<a href="../../../../nn/hid/CTR/PadReader/NormalizeStick.html"><CODE>NormalizeStick</CODE></a>
150            </th>
151<td>Normalizes and returns the Circle Pad values obtained by the <a href="../../../../nn/hid/CTR/PadReader/Read.html"><CODE>Read</CODE></a> and <a href="../../../../nn/hid/CTR/PadReader/ReadLatest.html"><CODE>ReadLatest</CODE></a> functions to floating-point values between <CODE>-1.0</CODE> and <CODE>1.0</CODE>.</td>
152          </tr>
153          <tr>
154            <td width="100">  </td>
155            <th>
156<a href="../../../../nn/hid/CTR/PadReader/NormalizeStickWithScale.html"><CODE>NormalizeStickWithScale</CODE></a>
157            </th>
158<td>Normalizes and returns the Circle Pad values obtained by the <a href="../../../../nn/hid/CTR/PadReader/Read.html"><CODE>Read</CODE></a> and <a href="../../../../nn/hid/CTR/PadReader/ReadLatest.html"><CODE>ReadLatest</CODE></a> functions to floating-point values between <CODE>-1.0</CODE> and <CODE>1.0</CODE>. Includes a sensitivity correction feature.</td>
159          </tr>
160          <tr>
161            <td width="100">  </td>
162            <th>
163<a href="../../../../nn/hid/CTR/PadReader/SetNormalizeStickScaleSettings.html"><CODE>SetNormalizeStickScaleSettings</CODE></a>
164            </th>
165<td>Configures the <a href="../../../../nn/hid/CTR/PadReader/NormalizeStickWithScale.html"><CODE>NormalizeStickWithScale</CODE></a> settings.</td>
166          </tr>
167          <tr>
168            <td width="100">  </td>
169            <th>
170<a href="../../../../nn/hid/CTR/PadReader/GetNormalizeStickScaleSettings.html"><CODE>GetNormalizeStickScaleSettings</CODE></a>
171            </th>
172<td>Gets the <a href="../../../../nn/hid/CTR/PadReader/NormalizeStickWithScale.html"><CODE>NormalizeStickWithScale</CODE></a> settings.</td>
173          </tr> </table>
174      </div>
175    </a>
176<h2>Class Hierarchy</h2>
177    <div class="section">
178<p class="hierarchy"><CODE><a href="../../../../nn/util/NonCopyable/Overview.html">nn::util::NonCopyable</a></CODE><br />&nbsp;&nbsp;<b><CODE>nn::hid::CTR::PadReader</CODE></b>
179      </p>
180    </div>
181<h2>Revision History</h2>
182    <div class="section">
183      <dl class="history">
184        <dt>2011/10/09</dt>
185<dd>Revised Japanese terminology for the Circle Pad.<br />
186        </dd>
187        <dt>2010/10/15</dt>
188<dd>Added <CODE>NormalizeStickWithScale</CODE>, <CODE>SetNormalizeStickScaleSettings</CODE>, <CODE>GetNormalizeStickScaleSettings</CODE>.
189        </dd>
190        <dt>2010/01/07</dt>
191<dd>Initial version.<br />
192        </dd>
193      </dl>
194    </div>
195  <hr><p>CONFIDENTIAL</p></body>
196</html>
197