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
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50<title>nn::hid::CTR::ExtraPad</title>
51  </head>
52  <body>
53<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>::ExtraPad</CODE> Class</h1>
54<h2>Syntax</h2>
55    <div class="section">
56      <pre class="definition">class ExtraPad</pre>
57    </div>
58<h2>Description</h2>
59    <div class="section">
60<p>Class that controls the Nintendo 3DS Circle Pad Pro.<br /></p><p>The Circle Pad Pro is an accessory for the CTR system that provides an additional input interface. It has a ZL Button, ZR Button, R Button, and the Right Circle Pad.</p><!-- write here --></div>
61    <a name="enum" id="enum">
62<h2>Enumerated Types</h2>
63      <div class="section">
64        <table class="members">
65          <tr>
66            <td width="100"> </td>
67            <th>
68<a href="../../../../nn/hid/CTR/ExtraPad/ConnectionState.html"><CODE>ConnectionState</CODE></a>
69            </th>
70<td>Enumerated type representing the connection states of the Circle Pad Pro.</td>
71          </tr> </table>
72      </div>
73    </a> <a name="function" id="function">
74<h2>Member Functions</h2>
75      <div class="section">
76        <table class="members">
77          <tr>
78<th class="category" colspan="3">Initialization and Shutdown</th>
79          </tr>
80          <tr>
81            <td width="100">
82<span class="static_style" title="static">S</span> </td>
83            <th>
84<a href="../../../../nn/hid/CTR/ExtraPad/Initialize.html"><CODE>Initialize</CODE></a>
85            </th>
86<td>Performs initialization for using the Circle Pad Pro.</td>
87          </tr>
88          <tr>
89            <td width="100">
90<span class="static_style" title="static">S</span> </td>
91            <th>
92<a href="../../../../nn/hid/CTR/ExtraPad/Finalize.html"><CODE>Finalize</CODE></a>
93            </th>
94<td>Finalizes the Circle Pad Pro.</td>
95          </tr>
96          <tr>
97<th class="category" colspan="3">Starting and Stopping Sampling</th>
98          </tr>
99          <tr>
100            <td width="100">
101<span class="static_style" title="static">S</span> </td>
102            <th>
103<a href="../../../../nn/hid/CTR/ExtraPad/StartSampling.html"><CODE>StartSampling</CODE></a>
104            </th>
105<td>Starts sampling the Nintendo 3DS Circle Pad Pro. When this function succeeds, a thread for sampling is created internally using application resources.</td>
106          </tr>
107          <tr>
108            <td width="100">
109<span class="static_style" title="static">S</span> </td>
110            <th>
111<a href="../../../../nn/hid/CTR/ExtraPad/StopSampling.html"><CODE>StopSampling</CODE></a>
112            </th>
113<td>Stops sampling the Nintendo 3DS Circle Pad Pro. When this function succeeds, it releases the thread that was created when the <a href="../../../../nn/hid/CTR/ExtraPad/StartSampling.html"><CODE>StartSampling</CODE></a> function was run.</td>
114          </tr>
115          <tr>
116<th class="category" colspan="3">State Changes</th>
117          </tr>
118          <tr>
119            <td width="100">
120<span class="static_style" title="static">S</span> </td>
121            <th>
122<a href="../../../../nn/hid/CTR/ExtraPad/IsSampling.html"><CODE>IsSampling</CODE></a>
123            </th>
124<td>Returns whether the Nintendo 3DS Circle Pad Pro is currently being sampled.</td>
125          </tr>
126          <tr>
127            <td width="100">
128<span class="static_style" title="static">S</span> </td>
129            <th>
130<a href="../../../../nn/hid/CTR/ExtraPad/GetConnectionState.html"><CODE>GetConnectionState</CODE></a>
131            </th>
132<td>Returns the connection state of the Nintendo 3DS Circle Pad Pro.</td>
133          </tr>
134          <tr>
135            <td width="100">
136<span class="static_style" title="static">S</span> </td>
137            <th>
138<a href="../../../../nn/hid/CTR/ExtraPad/RegisterConnectionEvent.html"><CODE>RegisterConnectionEvent</CODE></a>
139            </th>
140<td>Registers the <a href="../../../../nn/os/LightEvent/Overview.html"><CODE>nn::os::LightEvent</CODE></a> for which notifications are sent when the Circle Pad Pro connection state changes.</td>
141          </tr>
142          <tr>
143            <td width="100">
144<span class="static_style" title="static">S</span> </td>
145            <th>
146<a href="../../../../nn/hid/CTR/ExtraPad/UnregisterConnectionEvent.html"><CODE>UnregisterConnectionEvent</CODE></a>
147            </th>
148<td>Unregisters the event that was registered by the <a href="../../../../nn/hid/CTR/ExtraPad/RegisterConnectionEvent.html"><CODE>RegisterConnectionEvent</CODE></a> function.</td>
149          </tr>
150          <tr>
151            <td width="100">
152<span class="static_style" title="static">S</span> </td>
153            <th>
154<a href="../../../../nn/hid/CTR/ExtraPad/RegisterSamplingEvent.html"><CODE>RegisterSamplingEvent</CODE></a>
155            </th>
156<td>Registers the <a href="../../../../nn/os/LightEvent/Overview.html"><CODE>nn::os::LightEvent</CODE></a> for which notifications are sent when the Circle Pad Pro is sampled.</td>
157          </tr>
158          <tr>
159            <td width="100">
160<span class="static_style" title="static">S</span> </td>
161            <th>
162<a href="../../../../nn/hid/CTR/ExtraPad/UnregisterSamplingEvent.html"><CODE>UnregisterSamplingEvent</CODE></a>
163            </th>
164<td>Unregisters the event that was registered by the <a href="../../../../nn/hid/CTR/ExtraPad/RegisterSamplingEvent.html"><CODE>RegisterSamplingEvent</CODE></a> function.</td>
165          </tr> </table>
166      </div>
167    </a>
168<h2>Revision History</h2>
169    <div class="section">
170      <dl class="history">
171        <dt>2011/10/06</dt>
172<dd>Initial version.<br />
173        </dd>
174      </dl>
175    </div>
176  <hr><p>CONFIDENTIAL</p></body>
177</html>