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</title> 51 </head> 52 <body> 53<h1><CODE>nn::hid::CTR</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>Namespace for the CTR's HID (Human Interface Device) functionality. <br />(This can also be written without the "<CODE>::CTR</CODE>" portion.)</p><!-- write here --></div> 57 <a name="class" id="class"> 58<h2>Classes</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62 <th> 63<a href="../../../nn/hid/CTR/Accelerometer/Overview.html"><CODE>nn::hid::CTR::Accelerometer</CODE></a> 64 </th> 65<td>Class that contains the resources required for getting sampling data from the accelerometers. Use the <CODE>nn::hid::CTR::GetAccelerometer</CODE> function to get a reference to a valid instance.</td> 66 </tr> 67 <tr> 68 <th> 69<a href="../../../nn/hid/CTR/AccelerometerReader/Overview.html"><CODE>nn::hid::CTR::AccelerometerReader</CODE></a> 70 </th> 71<td>Class for loading sampling data from the accelerometers.</td> 72 </tr> 73 <tr> 74 <th> 75<a href="../../../nn/hid/CTR/DebugPad/Overview.html"><CODE>nn::hid::CTR::DebugPad</CODE></a> 76 </th> 77<td>A class that has the resources necessary to get sampling data from the <I>debug pad</I> (a game controller used for debugging). Call <CODE>nn::hid::CTR::GetDebugPad</CODE> to get a reference to a valid instance.</td> 78 </tr> 79 <tr> 80 <th> 81<a href="../../../nn/hid/CTR/DebugPadReader/Overview.html"><CODE>nn::hid::CTR::DebugPadReader</CODE></a> 82 </th> 83<td>Class for loading sampling data from the game controller used for debugging (the <I>debug pad</I>).</td> 84 </tr> 85 <tr> 86 <th> 87<a href="../../../nn/hid/CTR/Gyroscope/Overview.html">nn::hid::CTR::Gyroscope</a> 88 </th> 89<td>The class with the resources necessary to get sampling data from the gyro sensor. Use the <CODE>nn::hid::CTR::GetGyroscope</CODE> function to get a reference to a valid instance of this class.</td> 90 </tr> 91 <tr> 92 <th> 93<a href="../../../nn/hid/CTR/GyroscopeReader/Overview.html">nn::hid::CTR::GyroscopeReader</a> 94 </th> 95<td>Class for loading sampling data from the gyro sensor.</td> 96 </tr> 97 <tr> 98 <th> 99<a href="../../../nn/hid/CTR/HidBase/Overview.html"><CODE>nn::hid::CTR::HidBase</CODE></a> 100 </th> 101<td>Base HID class.</td> 102 </tr> 103 <tr> 104 <th> 105<a href="../../../nn/hid/CTR/Pad/Overview.html"><CODE>nn::hid::CTR::Pad</CODE></a> 106 </th> 107<td>Class that contains the resources required for getting sampling data from the buttons and the analog stick. Use the <CODE>nn::hid::CTR::GetPad</CODE> function to get a reference to a valid instance.</td> 108 </tr> 109 <tr> 110 <th> 111<a href="../../../nn/hid/CTR/PadReader/Overview.html"><CODE>nn::hid::CTR::PadReader</CODE></a> 112 </th> 113<td>Class for loading sampling data from the gamepad (the buttons and the analog stick).</td> 114 </tr> 115 <tr> 116 <th> 117<a href="../../../nn/hid/CTR/TouchPanel/Overview.html"><CODE>nn::hid::CTR::TouchPanel</CODE></a> 118 </th> 119<td>Class that contains the resources required for getting sampling data from the Touch Screen. Use the <CODE>nn::hid::CTR::GetTouchPanel</CODE> function to get a reference to a valid instance.</td> 120 </tr> 121 <tr> 122 <th> 123<a href="../../../nn/hid/CTR/TouchPanelReader/Overview.html"><CODE>nn::hid::CTR::TouchPanelReader</CODE></a> 124 </th> 125<td>Class for loading sampling data from the Touch Screen.</td> 126 </tr> 127 </table> 128 </div> 129 </a> <a name="struct" id="struct"> 130<h2>Structures</h2> 131 <div class="section"> 132 <table class="members"> 133 <tr> 134 <th> 135<a href="../../../nn/hid/CTR/AnalogStickStatus/Overview.html"><CODE>nn::hid::CTR::AnalogStickStatus</CODE></a> 136 </th> 137<td>Structure used to store sampling data from the analog stick.</td> 138 </tr> 139 <tr> 140 <th> 141<a href="../../../nn/hid/CTR/PadStatus/Overview.html"><CODE>nn::hid::CTR::PadStatus</CODE></a> 142 </th> 143<td>Structure used to store sampling data from the buttons and the analog stick.</td> 144 </tr> 145 <tr> 146 <th> 147<a href="../../../nn/hid/CTR/TouchPanelStatus/Overview.html"><CODE>nn::hid::CTR::TouchPanelStatus</CODE></a> 148 </th> 149<td>Structure used to store sampling data from the Touch Screen.</td> 150 </tr> 151 <tr> 152 <th> 153<a href="../../../nn/hid/CTR/AccelerometerStatus/Overview.html"><CODE>nn::hid::CTR::AccelerometerStatus</CODE></a> 154 </th> 155<td>Structure used to store sampling data from the accelerometers.</td> 156 </tr> 157 <tr> 158 <th> 159<a href="../../../nn/hid/CTR/AccelerationFloat/Overview.html"><CODE>nn::hid::CTR::AccelerationFloat</CODE></a> 160 </th> 161<td>Structure used to store the acceleration (in g's) from the accelerometers.</td> 162 </tr> 163 <tr> 164 <th> 165<a href="../../../nn/hid/CTR/Direction/Overview.html">nn::hid::CTR::Direction</a> 166 </th> 167<td>Structure storing the 3D attitude.</td> 168 </tr> 169 <tr> 170 <th> 171<a href="../../../nn/hid/CTR/GyroscopeStatus/Overview.html">nn::hid::CTR::GyroscopeStatus</a> 172 </th> 173<td>Structure for storing the gyro information.</td> 174 </tr> 175 <tr> 176 <th> 177<a href="../../../nn/hid/CTR/DebugPadStatus/Overview.html"><CODE>nn::hid::CTR::DebugPadStatus</CODE></a> 178 </th> 179<td>Structure used to store sampling data from the buttons and analog sticks on the debug pad.</td> 180 </tr> 181 </table> 182 </div> 183 </a> <a name="enum" id="enum"> 184<h2>Enumerated Types</h2> 185 <div class="section"> 186 <table class="members"> 187 <tr> 188 <td width="100"> </td> 189 <th> 190<a href="../../../nn/hid/CTR/ZeroDriftMode.html">ZeroDriftMode</a> 191 </th> 192<td>Enumerated type for setting the strength of the correction for zero-point drift.</td> 193 </tr> </table> 194 </div> 195 </a> <a name="constant" id="constant"> 196<h2>Constants</h2> 197 <div class="section"> 198 <table class="members"> 199 <tr> 200 <td width="100"> </td> 201 <th> 202<span class="argument"><a href="./MAX_OF_ACCELEROMETER_VALUE.html"><CODE>MAX_OF_ACCELEROMETER_VALUE</CODE></a></span> 203 </th> 204<td>Absolute value of the maximum value that the accelerometers can detect.</td> 205 </tr> 206 <tr> 207 <td width="100"> </td> 208 <th> 209<span class="argument"><a href="./ACCELEROMETER_VALUE_PER_1G.html"><CODE>ACCELEROMETER_VALUE_PER_1G</CODE></a></span> 210 </th> 211<td>Accelerometer value equivalent to 1 g of acceleration.</td> 212 </tr> 213 <tr> 214 <td width="100"> </td> 215 <th> 216<span class="argument"><a href="./MAX_OF_ACCELEROMETER_PLAY.html"><CODE>MAX_OF_ACCELEROMETER_PLAY</CODE></a></span> 217 </th> 218<td>Maximum value for the play range of the accelerometers.</td> 219 </tr> 220 <tr> 221 <td width="100"> </td> 222 <th> 223<span class="argument"><a href="./MAX_OF_ACCELEROMETER_SENSITIVITY.html"><CODE>MAX_OF_ACCELEROMETER_SENSITIVITY</CODE></a></span> 224 </th> 225<td>Maximum value for the accelerometer sensitivity.</td> 226 </tr> 227 <tr> 228 <td width="100"> </td> 229 <th> 230<span class="argument"><a href="./BUTTON_A.html"><CODE>BUTTON_A</CODE></a></span> 231 </th> 232<td>A Button.</td> 233 </tr> 234 <tr> 235 <td width="100"> </td> 236 <th> 237<span class="argument"><a href="./BUTTON_B.html"><CODE>BUTTON_B</CODE></a></span> 238 </th> 239<td>B Button.</td> 240 </tr> 241 <tr> 242 <td width="100"> </td> 243 <th> 244<span class="argument"><a href="./BUTTON_START.html"><CODE>BUTTON_START</CODE></a></span> 245 </th> 246<td>START Button</td> 247 </tr> 248 <tr> 249 <td width="100"> </td> 250 <th> 251<span class="argument"><a href="./BUTTON_RIGHT.html"><CODE>BUTTON_RIGHT</CODE></a></span> 252 </th> 253<td>Right on the +Control Pad.</td> 254 </tr> 255 <tr> 256 <td width="100"> </td> 257 <th> 258<span class="argument"><a href="./BUTTON_LEFT.html"><CODE>BUTTON_LEFT</CODE></a></span> 259 </th> 260<td>Left on the +Control Pad.</td> 261 </tr> 262 <tr> 263 <td width="100"> </td> 264 <th> 265<span class="argument"><a href="./BUTTON_UP.html"><CODE>BUTTON_UP</CODE></a></span> 266 </th> 267<td>Up on the +Control Pad.</td> 268 </tr> 269 <tr> 270 <td width="100"> </td> 271 <th> 272<span class="argument"><a href="./BUTTON_DOWN.html"><CODE>BUTTON_DOWN</CODE></a></span> 273 </th> 274<td>Down on the +Control Pad.</td> 275 </tr> 276 <tr> 277 <td width="100"> </td> 278 <th> 279<span class="argument"><a href="./BUTTON_R.html"><CODE>BUTTON_R</CODE></a></span> 280 </th> 281<td>R Button.</td> 282 </tr> 283 <tr> 284 <td width="100"> </td> 285 <th> 286<span class="argument"><a href="./BUTTON_L.html"><CODE>BUTTON_L</CODE></a></span> 287 </th> 288<td>L Button.</td> 289 </tr> 290 <tr> 291 <td width="100"> </td> 292 <th> 293<span class="argument"><a href="./BUTTON_X.html"><CODE>BUTTON_X</CODE></a></span> 294 </th> 295<td>X Button.</td> 296 </tr> 297 <tr> 298 <td width="100"> </td> 299 <th> 300<span class="argument"><a href="./BUTTON_Y.html"><CODE>BUTTON_Y</CODE></a></span> 301 </th> 302<td>Y Button.</td> 303 </tr> 304 <tr> 305 <td width="100"> </td> 306 <th> 307<span class="argument"><a href="./BUTTON_DEBUG.html"><CODE>BUTTON_DEBUG</CODE></a></span> 308 </th> 309<td>DEBUG Button.</td> 310 </tr> 311 <tr> 312 <td width="100"> </td> 313 <th> 314<span class="argument"><a href="./BUTTON_EMULATION_RIGHT.html"><CODE>BUTTON_EMULATION_RIGHT</CODE></a></span> 315 </th> 316<td>Right on the emulated +Control Pad, using the analog stick input.</td> 317 </tr> 318 <tr> 319 <td width="100"> </td> 320 <th> 321<span class="argument"><a href="./BUTTON_EMULATION_LEFT.html"><CODE>BUTTON_EMULATION_LEFT</CODE></a></span> 322 </th> 323<td>Left on the emulated +Control Pad, using the analog stick input.</td> 324 </tr> 325 <tr> 326 <td width="100"> </td> 327 <th> 328<span class="argument"><a href="./BUTTON_EMULATION_UP.html"><CODE>BUTTON_EMULATION_UP</CODE></a></span> 329 </th> 330<td>Up on the emulated +Control Pad, using the analog stick input.</td> 331 </tr> 332 <tr> 333 <td width="100"> </td> 334 <th> 335<span class="argument"><a href="./BUTTON_EMULATION_DOWN.html"><CODE>BUTTON_EMULATION_DOWN</CODE></a></span> 336 </th> 337<td>Down on the emulated +Control Pad, using the analog stick input.</td> 338 </tr> 339 <tr> 340 <td width="100"> </td> 341 <th> 342<span class="argument"><a href="./BUTTON_MASK.html"><CODE>BUTTON_MASK</CODE></a></span> 343 </th> 344<td>Input mask that includes everything other than the +Control Pad (the +Control Pad includes emulation).</td> 345 </tr> 346 <tr> 347 <td width="100"> </td> 348 <th> 349<span class="argument"><a href="./PLUS_BUTTON_MASK.html"><CODE>PLUS_BUTTON_MASK</CODE></a></span> 350 </th> 351<td>Input mask for the +Control Pad (excluding emulation).</td> 352 </tr> 353 <tr> 354 <td width="100"> </td> 355 <th> 356<span class="argument"><a href="./PLUS_BUTTON_EMULATION_MASK.html"><CODE>PLUS_BUTTON_EMULATION_MASK</CODE></a></span> 357 </th> 358<td>Input mask for +Control Pad emulation.</td> 359 </tr> 360 <tr> 361 <td width="100"> </td> 362 <th> 363<span class="argument"><a href="./ALL_MASK.html"><CODE>ALL_MASK</CODE></a></span> 364 </th> 365<td>All input.</td> 366 </tr> 367 <tr> 368 <td width="100"> </td> 369 <th> 370<span class="argument"><a href="./DEBUG_PAD_BUTTON_UP.html"><CODE>DEBUG_PAD_BUTTON_UP</CODE></a></span> 371 </th> 372<td>Up on the +Control Pad of the debug pad.</td> 373 </tr> 374 <tr> 375 <td width="100"> </td> 376 <th> 377<span class="argument"><a href="./DEBUG_PAD_BUTTON_LEFT.html"><CODE>DEBUG_PAD_BUTTON_LEFT</CODE></a></span> 378 </th> 379<td>Left on the +Control Pad of the debug pad.</td> 380 </tr> 381 <tr> 382 <td width="100"> </td> 383 <th> 384<span class="argument"><a href="./DEBUG_PAD_TRIGGER_ZR.html"><CODE>DEBUG_PAD_TRIGGER_ZR</CODE></a></span> 385 </th> 386<td>The ZR Button on the debug pad.</td> 387 </tr> 388 <tr> 389 <td width="100"> </td> 390 <th> 391<span class="argument"><a href="./DEBUG_PAD_BUTTON_X.html"><CODE>DEBUG_PAD_BUTTON_X</CODE></a></span> 392 </th> 393<td>The X Button on the debug pad.</td> 394 </tr> 395 <tr> 396 <td width="100"> </td> 397 <th> 398<span class="argument"><a href="./DEBUG_PAD_BUTTON_A.html"><CODE>DEBUG_PAD_BUTTON_A</CODE></a></span> 399 </th> 400<td>The A Button on the debug pad.</td> 401 </tr> 402 <tr> 403 <td width="100"> </td> 404 <th> 405<span class="argument"><a href="./DEBUG_PAD_BUTTON_Y.html"><CODE>DEBUG_PAD_BUTTON_Y</CODE></a></span> 406 </th> 407<td>The Y Button on the debug pad.</td> 408 </tr> 409 <tr> 410 <td width="100"> </td> 411 <th> 412<span class="argument"><a href="./DEBUG_PAD_BUTTON_B.html"><CODE>DEBUG_PAD_BUTTON_B</CODE></a></span> 413 </th> 414<td>The B Button on the debug pad.</td> 415 </tr> 416 <tr> 417 <td width="100"> </td> 418 <th> 419<span class="argument"><a href="./DEBUG_PAD_TRIGGER_ZL.html"><CODE>DEBUG_PAD_TRIGGER_ZL</CODE></a></span> 420 </th> 421<td>The ZL Button on the debug pad.</td> 422 </tr> 423 <tr> 424 <td width="100"> </td> 425 <th> 426<span class="argument"><a href="./DEBUG_PAD_TRIGGER_R.html"><CODE>DEBUG_PAD_TRIGGER_R</CODE></a></span> 427 </th> 428<td>The R Button on the debug pad.</td> 429 </tr> 430 <tr> 431 <td width="100"> </td> 432 <th> 433<span class="argument"><a href="./DEBUG_PAD_BUTTON_PLUS.html"><CODE>DEBUG_PAD_BUTTON_PLUS</CODE></a></span> 434 </th> 435<td>The + Button on the debug pad.</td> 436 </tr> 437 <tr> 438 <td width="100"> </td> 439 <th> 440<span class="argument"><a href="./DEBUG_PAD_BUTTON_HOME.html"><CODE>DEBUG_PAD_BUTTON_HOME</CODE></a></span> 441 </th> 442<td>The HOME Button on the debug pad.</td> 443 </tr> 444 <tr> 445 <td width="100"> </td> 446 <th> 447<span class="argument"><a href="./DEBUG_PAD_BUTTON_MINUS.html"><CODE>DEBUG_PAD_BUTTON_MINUS</CODE></a></span> 448 </th> 449<td>The - Button on the debug pad.</td> 450 </tr> 451 <tr> 452 <td width="100"> </td> 453 <th> 454<span class="argument"><a href="./DEBUG_PAD_TRIGGER_L.html"><CODE>DEBUG_PAD_TRIGGER_L</CODE></a></span> 455 </th> 456<td>The L Button on the debug pad.</td> 457 </tr> 458 <tr> 459 <td width="100"> </td> 460 <th> 461<span class="argument"><a href="./DEBUG_PAD_BUTTON_DOWN.html"><CODE>DEBUG_PAD_BUTTON_DOWN</CODE></a></span> 462 </th> 463<td>Down on the +Control Pad of the debug pad.</td> 464 </tr> 465 <tr> 466 <td width="100"> </td> 467 <th> 468<span class="argument"><a href="./DEBUG_PAD_BUTTON_RIGHT.html"><CODE>DEBUG_PAD_BUTTON_RIGHT</CODE></a></span> 469 </th> 470<td>Right on the +Control Pad of the debug pad.</td> 471 </tr> 472 <tr> 473 <td width="100"> </td> 474 <th> 475<span class="argument"><a href="./MIN_OF_STICK_CLAMP_MODE_CIRCLE.html"><CODE>MIN_OF_STICK_CLAMP_MODE_CIRCLE</CODE></a></span> 476 </th> 477<td>The minimum play that is appropriate for circular clamping of the Slide Pad. </td> 478 </tr> 479 <tr> 480 <td width="100"> </td> 481 <th> 482<span class="argument"><a href="./MIN_OF_STICK_CLAMP_MODE_CROSS.html"><CODE>MIN_OF_STICK_CLAMP_MODE_CROSS</CODE></a></span> 483 </th> 484<td>The minimum play that is appropriate for cross-shaped (+Control Pad-shaped) clamping of the Slide Pad.</td> 485 </tr> 486 <tr> 487 <td width="100"> </td> 488 <th> 489<span class="argument"><a href="./LIMIT_OF_STICK_CLAMP_MAX.html"><CODE>LIMIT_OF_STICK_CLAMP_MAX</CODE></a></span> 490 </th> 491<td>Maximum value for analog stick clamping.</td> 492 </tr> </table> 493 </div> 494 </a> <a name="function" id="function"> 495<h2>Functions</h2> 496 <div class="section"> 497 <table class="members"> 498 <tr> 499<th class="category" colspan="3">Initialize/Finalize</th> 500 </tr> 501 <tr> 502 <td width="100"> </td> 503 <th> 504<a href="../../../nn/hid/CTR/Initialize.html"><CODE>Initialize</CODE></a> 505 </th> 506<td>Initializes the HID library and enables loading of the sampling data.</td> 507 </tr> 508 <tr> 509 <td width="100"> </td> 510 <th> 511<a href="../../../nn/hid/CTR/Finalize.html"><CODE>Finalize</CODE></a> 512 </th> 513<td>Finalizes the HID library.</td> 514 </tr> 515 <tr> 516<th class="category" colspan="3">Other</th> 517 </tr> 518 <tr> 519 <td width="100"> </td> 520 <th> 521<a href="../../../nn/hid/CTR/GetPad.html"><CODE>GetPad</CODE></a> 522 </th> 523<td>Gets a reference to an instance of the <CODE><a href="../../../nn/hid/CTR/Pad/Overview.html">Pad</a></CODE> class.</td> 524 </tr> 525 <tr> 526 <td width="100"> </td> 527 <th> 528<a href="../../../nn/hid/CTR/GetTouchPanel.html"><CODE>GetTouchPanel</CODE></a> 529 </th> 530<td>Gets a reference to an instance of the <CODE><a href="../../../nn/hid/CTR/TouchPanel/Overview.html">TouchPanel</a></CODE> class.</td> 531 </tr> 532 <tr> 533 <td width="100"> </td> 534 <th> 535<a href="../../../nn/hid/CTR/GetAccelerometer.html"><CODE>GetAccelerometer</CODE></a> 536 </th> 537<td>Gets a reference to an instance of the <CODE><a href="../../../nn/hid/CTR/Accelerometer/Overview.html">Accelerometer</a></CODE> class.</td> 538 </tr> 539 <tr> 540 <td width="100"> </td> 541 <th> 542<a href="../../../nn/hid/CTR/GetGyroscope.html">GetGyroscope</a> 543 </th> 544<td>Gets a reference to the <CODE><a href="../../../nn/hid/CTR/Gyroscope/Overview.html">Gyroscope</a></CODE> class.</td> 545 </tr> 546 <tr> 547 <td width="100"> </td> 548 <th> 549<a href="../../../nn/hid/CTR/GetDebugPad.html"><CODE>GetDebugPad</CODE></a> 550 </th> 551<td>Gets a reference to an instance of the <a href="../../../nn/hid/CTR/DebugPad/Overview.html"><CODE>DebugPad</CODE></a> class.</td> 552 </tr> </table> 553 </div> 554 </a> 555<h2>Revision History</h2> 556 <div class="section"> 557 <dl class="history"> 558 <dt>2010/01/07</dt> 559<dd>Initial version.<br /> 560 </dd> 561 </dl> 562 </div> 563 <hr><p>CONFIDENTIAL</p></body> 564</html>