1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
5<META http-equiv="Content-Style-Type" content="text/css">
6<LINK rel="stylesheet" type="text/css" href="../CSS/revolution.css">
7<BASE target="main">
8<TITLE>KPAD Function List</TITLE>
9</HEAD>
10<BODY>
11<H1>Standard Controller High-Level Library (KPAD) API Function List</H1>
12
13<H2><a name="Kpad">Controller Functions</a></H2>
14<TABLE class="api_list" border="1">
15  <TBODY>
16    <TR>
17      <TH><A href="./KPADInit.html">KPADInit</A></TH>
18      <TD>Initializes the KPAD library.</TD>
19    </TR>
20    <TR>
21      <TH><A href="./KPADInitEx.html">KPADInitEx</A></TH>
22      <TD>Initializes the KPAD library. Configures the ring buffer used for internal processing.</TD>
23    </TR>
24    <TR>
25      <TH><A href="./KPADShutdown.html">KPADShutdown</A></TH>
26      <TD>Stops the KPAD library.</TD>
27    </TR>
28    <TR>
29      <TH><A href="./KPADReset.html">KPADReset</A></TH>
30      <TD>Returns to the initial state.</TD>
31    </TR>
32    <TR>
33      <TH><A href="./KPADRead.html">KPADRead</A></TH>
34      <TD>Gets data.</TD>
35    </TR>
36    <TR>
37      <TH><A href="./KPADReadEx.html">KPADReadEx</A></TH>
38      <TD>Obtains data and error code.</TD>
39    </TR>
40    <TR>
41      <TH><A href="./KPADGetPosParam.html">KPADGetPosParam</A></TH>
42      <TD>Gets the play radius and sensitivity for the set coordinate values.</TD>
43    </TR>
44    <TR>
45      <TH><A href="./KPADSetPosParam.html">KPADSetPosParam</A></TH>
46      <TD>Adjusts the play radius and sensitivity for the coordinate values.</TD>
47    </TR>
48    <TR>
49      <TH><A href="./KPADGetPosPlayMode.html">KPADGetPosPlayMode</A></TH>
50      <TD>Gets the play mode for the set coordinate values.</TD>
51    </TR>
52    <TR>
53      <TH><A href="./KPADSetPosPlayMode.html">KPADSetPosPlayMode</A></TH>
54      <TD>Sets the play mode for the coordinate values.</TD>
55    </TR>
56    <TR>
57      <TH><A href="./KPADGetHoriParam.html">KPADGetHoriParam</A></TH>
58      <TD>Gets the play radius and sensitivity for the set horizontal parameters.</TD>
59    </TR>
60    <TR>
61      <TH><A href="./KPADSetHoriParam.html">KPADSetHoriParam</A></TH>
62      <TD>Adjusts the play radius and sensitivity for the horizontal parameters.</TD>
63    </TR>
64    <TR>
65      <TH><A href="./KPADGetHoriPlayMode.html">KPADGetHoriPlayMode</A></TH>
66      <TD>Gets the play mode for the set horizontal parameters.</TD>
67    </TR>
68    <TR>
69      <TH><A href="./KPADSetHoriPlayMode.html">KPADSetHoriPlayMode</A></TH>
70      <TD>Sets the play mode for the horizontal parameters.</TD>
71    </TR>
72    <TR>
73      <TH><A href="./KPADGetDistParam.html">KPADGetDistParam</A></TH>
74      <TD>Gets the play radius and sensitivity for the set distance.</TD>
75    </TR>
76    <TR>
77      <TH><A href="./KPADSetDistParam.html">KPADSetDistParam</A></TH>
78      <TD>Adjusts the play radius and sensitivity for the distance.</TD>
79    </TR>
80    <TR>
81      <TH><A href="./KPADGetDistPlayMode.html">KPADGetDistPlayMode</A></TH>
82      <TD>Gets the play mode for the set distance.</TD>
83    </TR>
84    <TR>
85      <TH><A href="./KPADSetDistPlayMode.html">KPADSetDistPlayMode</A></TH>
86      <TD>Sets the play mode for the distance.</TD>
87    </TR>
88    <TR>
89      <TH><A href="./KPADGetAccParam.html">KPADGetAccParam</A></TH>
90      <TD>Gets the play radius and sensitivity for the set acceleration sensor.</TD>
91    </TR>
92    <TR>
93      <TH><A href="./KPADSetAccParam.html">KPADSetAccParam</A></TH>
94      <TD>Adjusts the play radius and sensitivity for the acceleration sensor.</TD>
95    </TR>
96    <TR>
97      <TH><A href="./KPADGetAccPlayMode.html">KPADGetAccPlayMode</A></TH>
98      <TD>Gets the play mode for the set acceleration sensor.</TD>
99    </TR>
100    <TR>
101      <TH><A href="./KPADSetAccPlayMode.html">KPADSetAccPlayMode</A></TH>
102      <TD>Sets the play mode for the acceleration sensor.</TD>
103    </TR>
104    <TR>
105      <TH><A href="./KPADSetBtnRepeat.html">KPADSetBtnRepeat</A></TH>
106      <TD>Sets the digital button repeat functionality.</TD>
107    </TR>
108    <TR>
109      <TH><A href="./KPADSetSensorHeight.html">KPADSetSensorHeight</A></TH>
110      <TD>Sets the height for the Sensor Bar location.</TD>
111    </TR>
112    <TR>
113      <TH><A href="./KPADCalibrateDPD.html">KPADCalibrateDPD</A></TH>
114      <TD>Performs calibration.</TD>
115    </TR>
116    <TR>
117      <TH><A href="./KPADSetFSStickClamp.html">KPADSetFSStickClamp</A></TH>
118      <TD>Clamps control stick information for the Nunchuk.</TD>
119    </TR>
120    <TR>
121      <TH><A href="./KPADEnableDPD.html">KPADEnableDPD</A></TH>
122      <TD>Issues a request to turn the Wii Remote DPD module on.</TD>
123    </TR>
124    <TR>
125      <TH><A href="./KPADDisableDPD.html">KPADDisableDPD</A></TH>
126      <TD>Issues a request to turn the Wii Remote DPD module off.</TD>
127    </TR>
128    <TR>
129      <TH><A href="./KPADSetControlDpdCallback.html">KPADSetControlDpdCallback</A></TH>
130      <TD>Registers the callback to use for notification when making DPD settings for the Wii Remote.</TD>
131    </TR>
132    <TR>
133      <TH><A href="./KPADEnableAimingMode.html">KPADEnableAimingMode</A></TH>
134      <TD>Sets the mode for getting the nearest coordinate to the spot on the TV screen actually being pointed to by the Wii Remote.</TD>
135    </TR>
136    <TR>
137      <TH><A href="./KPADDisableAimingMode.html">KPADDisableAimingMode</A></TH>
138      <TD>Sets the mode for getting the coordinate with the center of the Sensor Bar used as the reference (default).</TD>
139    </TR>
140    <TR>
141      <TH><A href="./KPADGetProjectionPos.html">KPADGetProjectionPos</A></TH>
142      <TD>Converts the normalized coordinate values into projection coordinates.</TD>
143    </TR>
144    <TR>
145      <TH><A href="./KPADGetUnifiedWpadStatus.html">KPADGetUnifiedWpadStatus</A></TH>
146      <TD>Gets controller data such as <code>WPADStatus</code>, including the data format for each element.</TD>
147    </TR>
148    <TR>
149      <TH><A href="./KPADEnableStickCrossClamp.html">KPADEnableStickCrossClamp</A></TH>
150      <TD>Sets the stick's clamping method to cross clamping.</TD>
151    </TR>
152    <TR>
153      <TH><A href="./KPADDisableStickCrossClamp.html">KPADDisableStickCrossClamp</A></TH>
154      <TD>Sets the stick's clamping method to circular clamping.</TD>
155    </TR>
156    <TR>
157      <TH><A href="./KPADSetSamplingCallback.html">KPADSetSamplingCallback</A></TH>
158      <TD>Registers the sampling callback for the application.</TD>
159    </TR>
160    <TR>
161      <TH><A href="./KPADSetConnectCallback.html">KPADSetConnectCallback</A></TH>
162      <TD>Registers the connection notification callback for the application.</TD>
163    </TR>
164    <TR>
165      <TH><A href="./KPADSetReviseMode.html">KPADSetReviseMode</A></TH>
166      <TD>Sets whether to apply angular correction in advance to the values returned from the Nunchuk Motion Sensor.</TD>
167    </TR>
168    <TR>
169      <TH><A href="./KPADReviseAcc.html">KPADReviseAcc</A></TH>
170      <TD>Corrects any user-specified vector in the same manner as the correction performed when <a href="./KPADSetReviseMode.html"><code>KPADSetReviseMode</code></a> is set to ON.</TD>
171    </TR>
172    <TR>
173      <TH><A href="./KPADGetReviseAngle.html">KPADGetReviseAngle</A></TH>
174      <TD>Gets the angle of rotation, in degrees, of the angular correction performed by <A href="./KPADReviseAcc.html"><code>KPADReviseAcc</code></a>.</TD>
175    </TR>
176    <TR>
177      <TH><A href="./KPADGetBtnProcMode.html">KPADGetButtonProcMode</A></TH>
178      <TD>Gets the button processing method used inside <A href="./KPADRead.html"><code>KPADRead</code></a>.</TD>
179    </TR>
180    <TR>
181      <TH><A href="./KPADSetBtnProcMode.html">KPADSetButtonProcMode</A></TH>
182      <TD>Sets the button processing method used inside <A href="./KPADRead.html"><code>KPADRead</code></a>.</TD>
183    </TR>
184    <TR>
185      <TH><A href="./KPADResetWbcZeroPoint.html">KPADResetWbcZeroPoint</A></TH>
186      <TD>Resets the zero point for the Wii Balance Board.</TD>
187    </TR>
188  </TBODY>
189</TABLE>
190
191<H2><a name="struct">Structures and Unions</a></H2>
192<TABLE class="api_list" border="1">
193  <TBODY>
194    <TR>
195      <TH><A href="./KPADStatus.html">KPADStatus</A></TH>
196      <TD>This structure stores controller data in the KPAD library.</TD>
197    </TR>
198    <TR>
199      <TH><A href="./KPADEXStatus.html">KPADEXStatus</A></TH>
200      <TD>This union stores the data for the extended unit in the KPAD library.</TD>
201    </TR>
202    <TR>
203      <TH><A href="./KPADUnifiedWpadStatus.html">KPADUnifiedWpadStatus</A></TH>
204      <TD>This structure stores controller data such as <code>WPADStatus</code>, including the data format for each element.</TD>
205    </TR>
206  </TBODY>
207</TABLE>
208
209<H2><a name="obsolete">Deprecated Functions</a></H2>
210<TABLE class="api_list" border="1">
211  <TBODY>
212    <TR>
213      <TH><A href="./KPADSetObjInterval.html"><s>KPADSetObjInterval</s></A> (obsolete)</TH>
214      <TD>Deprecated.</TD>
215    </TR>
216    <TR>
217      <TH><A href="./KPADGetWPADRingBuffer.html"><s>KPADGetWPADRingBuffer</s></A> (obsolete)</TH>
218      <TD>Deprecated.</TD>
219    </TR>
220    <TR>
221      <TH><A href="./KPADGetWPADFSRingBuffer.html"><s>KPADGetWPADFSRingBuffer</s></A> (obsolete)</TH>
222      <TD>Deprecated.</TD>
223    </TR>
224    <TR>
225      <TH><A href="./KPADGetWPADCLRingBuffer.html"><s>KPADGetWPADCLRingBuffer</s></A> (obsolete)</TH>
226      <TD>Deprecated.</TD>
227    </TR>
228  </TBODY>
229</TABLE>
230
231<BR><BR>
232
233<hr><p>CONFIDENTIAL</p></body>
234</HTML>
235