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::camera::CTR</title> 51 </head> 52 <body> 53<h1><CODE>nn::camera::CTR</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>The CTR's CAMERA namespace. <br />(This namespace 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/camera/CTR/ResultIsSleeping/Overview.html"><CODE>nn::camera::CTR::ResultIsSleeping</CODE></a> 64 </th> 65<td>Indicates that the cameras cannot be used because the system is sleeping.</td> 66 </tr> 67 <tr> 68 <th> 69<a href="../../../nn/camera/CTR/ResultFatalError/Overview.html"><CODE>nn::camera::CTR::ResultFatalError</CODE></a> 70 </th> 71<td>Indicates that the camera failed to reboot. There may be something physically wrong with the camera.</td> 72 </tr> 73 </table> 74 </div> 75 </a> <a name="struct" id="struct"> 76<h2>Structures</h2> 77 <div class="section"> 78 <table class="members"> 79 <tr> 80 <th> 81<a href="../../../nn/camera/CTR/StereoCameraCalibrationData/Overview.html"><CODE>nn::camera::CTR::StereoCameraCalibrationData</CODE></a> 82 </th> 83<td>Structure that gives calibration information for the stereo cameras.</td> 84 </tr> 85 <tr> 86 <th> 87<a href="../../../nn/camera/CTR/PackageParameterCameraSelect/Overview.html"><CODE>nn::camera::CTR::PackageParameterCameraSelect</CODE></a> 88 </th> 89<td>Structure for batch-configuring parameters without context but with cameras specified.</td> 90 </tr> 91 <tr> 92 <th> 93<a href="../../../nn/camera/CTR/PackageParameterContext/Overview.html"><CODE>nn::camera::CTR::PackageParameterContext</CODE></a> 94 </th> 95<td>Structure used for batch-configuring parameters with context and with cameras specified. Use when specifying the size with <CODE>SetDetailSize</CODE>.</td> 96 </tr> 97 <tr> 98 <th> 99<a href="../../../nn/camera/CTR/PackageParameterContextDetail/Overview.html"><CODE>nn::camera::CTR::PackageParameterContextDetail</CODE></a> 100 </th> 101<td>Structure used for batch-configuring parameters with context and with cameras specified. Use when specifying the size with <CODE>SetDetailSize</CODE>.</td> 102 </tr> 103 </table> 104 </div> 105 </a> <a name="enum" id="enum"> 106<h2>Enumerated Types</h2> 107 <div class="section"> 108 <table class="members"> 109 <tr> 110 <td width="100"> </td> 111 <th> 112<a href="../../../nn/camera/CTR/CameraSelect.html"><CODE>CameraSelect</CODE></a> 113 </th> 114<td>Enumerated type that represents combinations of cameras.</td> 115 </tr> 116 <tr> 117 <td width="100"> </td> 118 <th> 119<a href="../../../nn/camera/CTR/Port.html"><CODE>Port</CODE></a> 120 </th> 121<td>Enumerated type that indicates a camera's connection target port.</td> 122 </tr> 123 <tr> 124 <td width="100"> </td> 125 <th> 126<a href="../../../nn/camera/CTR/Context.html"><CODE>Context</CODE></a> 127 </th> 128<td>Enumerated type that indicates the camera context.</td> 129 </tr> 130 <tr> 131 <td width="100"> </td> 132 <th> 133<a href="../../../nn/camera/CTR/Flip.html"><CODE>Flip</CODE></a> 134 </th> 135<td>Enumerated type that indicates flipping types.</td> 136 </tr> 137 <tr> 138 <td width="100"> </td> 139 <th> 140<a href="../../../nn/camera/CTR/Size.html"><CODE>Size</CODE></a> 141 </th> 142<td>Enumerated type that indicates resolutions.</td> 143 </tr> 144 <tr> 145 <td width="100"> </td> 146 <th> 147<a href="../../../nn/camera/CTR/FrameRate.html"><CODE>FrameRate</CODE></a> 148 </th> 149<td>Enumerated type that indicates framerates.</td> 150 </tr> 151 <tr> 152 <td width="100"> </td> 153 <th> 154<a href="../../../nn/camera/CTR/WhiteBalance.html"><CODE>WhiteBalance</CODE></a> 155 </th> 156<td>Enumerated type that indicates white balance.</td> 157 </tr> 158 <tr> 159 <td width="100"> </td> 160 <th> 161<a href="../../../nn/camera/CTR/PhotoMode.html"><CODE>PhotoMode</CODE></a> 162 </th> 163<td>Enumerated type that indicates the photo mode.</td> 164 </tr> 165 <tr> 166 <td width="100"> </td> 167 <th> 168<a href="../../../nn/camera/CTR/Effect.html"><CODE>Effect</CODE></a> 169 </th> 170<td>Enumerated type that indicates effects.</td> 171 </tr> 172 <tr> 173 <td width="100"> </td> 174 <th> 175<a href="../../../nn/camera/CTR/Contrast.html"><CODE>Contrast</CODE></a> 176 </th> 177<td>Enumerated type that indicates contrast (gamma curve) patterns.</td> 178 </tr> 179 <tr> 180 <td width="100"> </td> 181 <th> 182<a href="../../../nn/camera/CTR/LensCorrection.html"><CODE>LensCorrection</CODE></a> 183 </th> 184<td>Enumerated type that indicates the degree of lens correction to apply.</td> 185 </tr> 186 <tr> 187 <td width="100"> </td> 188 <th> 189<a href="../../../nn/camera/CTR/ShutterSoundType.html"><CODE>ShutterSoundType</CODE></a> 190 </th> 191<td>Enumerated type that indicates types of shutter sounds.</td> 192 </tr> </table> 193 </div> 194 </a> <a name="function" id="function"> 195<h2>Functions</h2> 196 <div class="section"> 197 <table class="members"> 198 <tr> 199<th class="category" colspan="3">Other</th> 200 </tr> 201 <tr> 202 <td width="100"> </td> 203 <th> 204<a href="../../../nn/camera/CTR/Initialize.html"><CODE>Initialize</CODE></a> 205 </th> 206<td>Initializes the CAMERA library and makes the cameras available for use.</td> 207 </tr> 208 <tr> 209 <td width="100"> </td> 210 <th> 211<a href="../../../nn/camera/CTR/Finalize.html"><CODE>Finalize</CODE></a> 212 </th> 213<td>Finalizes the Camera library.</td> 214 </tr> 215 <tr> 216 <td width="100"> </td> 217 <th> 218<a href="../../../nn/camera/CTR/StartCapture.html"><CODE>StartCapture</CODE></a> 219 </th> 220<td>Starts capturing.</td> 221 </tr> 222 <tr> 223 <td width="100"> </td> 224 <th> 225<a href="../../../nn/camera/CTR/StopCapture.html"><CODE>StopCapture</CODE></a> 226 </th> 227<td>Stops capturing.</td> 228 </tr> 229 <tr> 230 <td width="100"> </td> 231 <th> 232<a href="../../../nn/camera/CTR/IsBusy.html"><CODE>IsBusy</CODE></a> 233 </th> 234<td>Gets whether the camera is currently capturing image data.</td> 235 </tr> 236 <tr> 237 <td width="100"> </td> 238 <th> 239<a href="../../../nn/camera/CTR/ClearBuffer.html"><CODE>ClearBuffer</CODE></a> 240 </th> 241<td>Clears the buffer and the error flags.</td> 242 </tr> 243 <tr> 244 <td width="100"> </td> 245 <th> 246<a href="../../../nn/camera/CTR/GetVsyncInterruptEvent.html"><CODE>GetVsyncInterruptEvent</CODE></a> 247 </th> 248<td>Gets the event used to detect camera V-Sync interrupts.</td> 249 </tr> 250 <tr> 251 <td width="100"> </td> 252 <th> 253<a href="../../../nn/camera/CTR/GetBufferErrorInterruptEvent.html"><CODE>GetBufferErrorInterruptEvent</CODE></a> 254 </th> 255<td>Gets the event used to detect camera buffer error interrupts and reboots.</td> 256 </tr> 257 <tr> 258 <td width="100"> </td> 259 <th> 260<a href="../../../nn/camera/CTR/SetReceiving.html"><CODE>SetReceiving</CODE></a> 261 </th> 262<td>Configures loading of image data. Only a single frame is received, so this must be set per each camera frame.</td> 263 </tr> 264 <tr> 265 <td width="100"> </td> 266 <th> 267<a href="../../../nn/camera/CTR/IsFinishedReceiving.html"><CODE>IsFinishedReceiving</CODE></a> 268 </th> 269<td>Checks whether image data transfer has completed.</td> 270 </tr> 271 <tr> 272 <td width="100"> </td> 273 <th> 274<a href="../../../nn/camera/CTR/SetTransferLines.html"><CODE>SetTransferLines</CODE></a> 275 </th> 276<td>Sets the number of lines to save in the buffer.</td> 277 </tr> 278 <tr> 279 <td width="100"> </td> 280 <th> 281<a href="../../../nn/camera/CTR/GetMaxLines.html"><CODE>GetMaxLines</CODE></a> 282 </th> 283<td>Gets the maximum number of lines that can be saved in the buffer.</td> 284 </tr> 285 <tr> 286 <td width="100"> </td> 287 <th> 288<a href="../../../nn/camera/CTR/SetTransferBytes.html"><CODE>SetTransferBytes</CODE></a> 289 </th> 290<td>Sets the number of bytes to save in the buffer.</td> 291 </tr> 292 <tr> 293 <td width="100"> </td> 294 <th> 295<a href="../../../nn/camera/CTR/GetTransferBytes.html"><CODE>GetTransferBytes</CODE></a> 296 </th> 297<td>Gets the current setting for the number of bytes to save to the buffer.</td> 298 </tr> 299 <tr> 300 <td width="100"> </td> 301 <th> 302<a href="../../../nn/camera/CTR/GetMaxBytes.html"><CODE>GetMaxBytes</CODE></a> 303 </th> 304<td>Gets the maximum number of bytes that can be saved in the buffer.</td> 305 </tr> 306 <tr> 307 <td width="100"> </td> 308 <th> 309<a href="../../../nn/camera/CTR/GetLineBytes.html"><CODE>GetLineBytes</CODE></a> 310 </th> 311<td>Gets the number of bytes in one line.</td> 312 </tr> 313 <tr> 314 <td width="100"> </td> 315 <th> 316<a href="../../../nn/camera/CTR/GetFrameBytes.html"><CODE>GetFrameBytes</CODE></a> 317 </th> 318<td>Gets the number of bytes in one frame.</td> 319 </tr> 320 <tr> 321 <td width="100"> </td> 322 <th> 323<a href="../../../nn/camera/CTR/SetTrimming.html"><CODE>SetTrimming</CODE></a> 324 </th> 325<td>Enables/disables trimming.</td> 326 </tr> 327 <tr> 328 <td width="100"> </td> 329 <th> 330<a href="../../../nn/camera/CTR/IsTrimming.html"><CODE>IsTrimming</CODE></a> 331 </th> 332<td>Checks whether trimming is enabled.</td> 333 </tr> 334 <tr> 335 <td width="100"> </td> 336 <th> 337<a href="../../../nn/camera/CTR/SetTrimmingParams.html"><CODE>SetTrimmingParams</CODE></a> 338 </th> 339<td>Sets the positions to which to trim.</td> 340 </tr> 341 <tr> 342 <td width="100"> </td> 343 <th> 344<a href="../../../nn/camera/CTR/GetTrimmingParams.html"><CODE>GetTrimmingParams</CODE></a> 345 </th> 346<td>Gets the positions to which to trim.</td> 347 </tr> 348 <tr> 349 <td width="100"> </td> 350 <th> 351<a href="../../../nn/camera/CTR/SetTrimmingParamsCenter.html"><CODE>SetTrimmingParamsCenter</CODE></a> 352 </th> 353<td>Sets the trimming positions relative to the center of the camera image.</td> 354 </tr> 355 <tr> 356 <td width="100"> </td> 357 <th> 358<a href="../../../nn/camera/CTR/Activate.html"><CODE>Activate</CODE></a> 359 </th> 360<td>Activates a camera.</td> 361 </tr> 362 <tr> 363 <td width="100"> </td> 364 <th> 365<a href="../../../nn/camera/CTR/SwitchContext.html"><CODE>SwitchContext</CODE></a> 366 </th> 367<td>Switches the camera settings context.</td> 368 </tr> 369 <tr> 370 <td width="100"> </td> 371 <th> 372<a href="../../../nn/camera/CTR/SetExposure.html"><CODE>SetExposure</CODE></a> 373 </th> 374<td>Sets the exposure.</td> 375 </tr> 376 <tr> 377 <td width="100"> </td> 378 <th> 379<a href="../../../nn/camera/CTR/SetWhiteBalance.html"><CODE>SetWhiteBalance</CODE></a> 380 </th> 381<td>Sets the white balance.</td> 382 </tr> 383 <tr> 384 <td width="100"> </td> 385 <th> 386<a href="../../../nn/camera/CTR/SetSharpness.html"><CODE>SetSharpness</CODE></a> 387 </th> 388<td>Sets the sharpness.</td> 389 </tr> 390 <tr> 391 <td width="100"> </td> 392 <th> 393<a href="../../../nn/camera/CTR/SetAutoExposure.html"><CODE>SetAutoExposure</CODE></a> 394 </th> 395<td>Enables/disables auto exposure.</td> 396 </tr> 397 <tr> 398 <td width="100"> </td> 399 <th> 400<a href="../../../nn/camera/CTR/IsAutoExposure.html"><CODE>IsAutoExposure</CODE></a> 401 </th> 402<td>Checks whether auto exposure is enabled.</td> 403 </tr> 404 <tr> 405 <td width="100"> </td> 406 <th> 407<a href="../../../nn/camera/CTR/SetAutoWhiteBalance.html"><CODE>SetAutoWhiteBalance</CODE></a> 408 </th> 409<td>Enables/disables automatic white balance.</td> 410 </tr> 411 <tr> 412 <td width="100"> </td> 413 <th> 414<a href="../../../nn/camera/CTR/IsAutoWhiteBalance.html"><CODE>IsAutoWhiteBalance</CODE></a> 415 </th> 416<td>Checks whether automatic white balance is enabled.</td> 417 </tr> 418 <tr> 419 <td width="100"> </td> 420 <th> 421<a href="../../../nn/camera/CTR/FlipImage.html"><CODE>FlipImage</CODE></a> 422 </th> 423<td>Configures flipping of images.</td> 424 </tr> 425 <tr> 426 <td width="100"> </td> 427 <th> 428<a href="../../../nn/camera/CTR/SetDetailSize.html"><CODE>SetDetailSize</CODE></a> 429 </th> 430<td>Sets the resolution (in pixels).</td> 431 </tr> 432 <tr> 433 <td width="100"> </td> 434 <th> 435<a href="../../../nn/camera/CTR/SetSize.html"><CODE>SetSize</CODE></a> 436 </th> 437<td>Sets the resolution.</td> 438 </tr> 439 <tr> 440 <td width="100"> </td> 441 <th> 442<a href="../../../nn/camera/CTR/SetFrameRate.html"><CODE>SetFrameRate</CODE></a> 443 </th> 444<td>Sets the framerate.</td> 445 </tr> 446 <tr> 447 <td width="100"> </td> 448 <th> 449<a href="../../../nn/camera/CTR/SetPhotoMode.html"><CODE>SetPhotoMode</CODE></a> 450 </th> 451<td>Sets the photo mode.</td> 452 </tr> 453 <tr> 454 <td width="100"> </td> 455 <th> 456<a href="../../../nn/camera/CTR/SetEffect.html"><CODE>SetEffect</CODE></a> 457 </th> 458<td>Sets an image effect.</td> 459 </tr> 460 <tr> 461 <td width="100"> </td> 462 <th> 463<a href="../../../nn/camera/CTR/SetContrast.html"><CODE>SetContrast</CODE></a> 464 </th> 465<td>Sets the image contrast (gamma curve).</td> 466 </tr> 467 <tr> 468 <td width="100"> </td> 469 <th> 470<a href="../../../nn/camera/CTR/SetLensCorrection.html"><CODE>SetLensCorrection</CODE></a> 471 </th> 472<td>Sets the degree of lens correction.</td> 473 </tr> 474 <tr> 475 <td width="100"> </td> 476 <th> 477<a href="../../../nn/camera/CTR/SetAutoExposureWindow.html"><CODE>SetAutoExposureWindow</CODE></a> 478 </th> 479<td>Sets the region within the view to use as the basis for calculating auto exposure.</td> 480 </tr> 481 <tr> 482 <td width="100"> </td> 483 <th> 484<a href="../../../nn/camera/CTR/SetAutoWhiteBalanceWindow.html"><CODE>SetAutoWhiteBalanceWindow</CODE></a> 485 </th> 486<td>Sets the region within the view to use as the basis for calculating auto white balance.</td> 487 </tr> 488 <tr> 489 <td width="100"> </td> 490 <th> 491<a href="../../../nn/camera/CTR/SetNoiseFilter.html"><CODE>SetNoiseFilter</CODE></a> 492 </th> 493<td>Sets the noise filter.</td> 494 </tr> 495 <tr> 496 <td width="100"> </td> 497 <th> 498<a href="../../../nn/camera/CTR/SynchronizeVsyncTiming.html"><CODE>SynchronizeVsyncTiming</CODE></a> 499 </th> 500<td>Synchronizes the camera V-Sync signal timing. However, this can never perfectly synchronize timing so that there is absolutely no discrepancy.</td> 501 </tr> 502 <tr> 503 <td width="100"> </td> 504 <th> 505<a href="../../../nn/camera/CTR/GetLatestVsyncTiming.html"><CODE>GetLatestVsyncTiming</CODE></a> 506 </th> 507<td>Gets the timing history of camera V-Sync signal inputs.</td> 508 </tr> 509 <tr> 510 <td width="100"> </td> 511 <th> 512<a href="../../../nn/camera/CTR/GetStereoCameraCalibrationData.html"><CODE>GetStereoCameraCalibrationData</CODE></a> 513 </th> 514<td>Gets calibration data for the stereo camera positions.</td> 515 </tr> 516 <tr> 517 <td width="100"> </td> 518 <th> 519<a href="../../../nn/camera/CTR/GetParallaxOnChart.html"><CODE>GetParallaxOnChart</CODE></a> 520 </th> 521<td>Calculates the parallax in the measurement chart when the stereo cameras' calibration data is measured.</td> 522 </tr> 523 <tr> 524 <td width="100"> </td> 525 <th> 526<a href="../../../nn/camera/CTR/GetStereoCameraCalibrationMatrix.html"><CODE>GetStereoCameraCalibrationMatrix</CODE></a> 527 </th> 528<td>Calculates a correction matrix used to make the left camera image match the right camera image in 3D space.</td> 529 </tr> 530 <tr> 531 <td width="100"> </td> 532 <th> 533<a href="../../../nn/camera/CTR/SetPackageParameterWithoutContext.html"><CODE>SetPackageParameterWithoutContext</CODE></a> 534 </th> 535<td>Batch-configures settings for a camera with no context specified.</td> 536 </tr> 537 <tr> 538 <td width="100"> </td> 539 <th> 540<a href="../../../nn/camera/CTR/SetPackageParameterWithContext.html"><CODE>SetPackageParameterWithContext</CODE></a> 541 </th> 542<td>Batch-configures settings for a camera with context specified. Use when configuring resolution with an enumerated type.</td> 543 </tr> 544 <tr> 545 <td width="100"> </td> 546 <th> 547<a href="../../../nn/camera/CTR/GetSuitableY2rStandardCoefficient.html"><CODE>GetSuitableY2rStandardCoefficient</CODE></a> 548 </th> 549<td>Gets the Y2R conversion coefficient applied to the data output by the camera.</td> 550 </tr> 551 <tr> 552 <td width="100"> </td> 553 <th> 554<a href="../../../nn/camera/CTR/PlayShutterSound.html"><CODE>PlayShutterSound</CODE></a> 555 </th> 556<td>Plays back the shutter sound and temporarily illuminates the camera LED.</td> 557 </tr> </table> 558 </div> 559 </a> 560<h2>Revision History</h2> 561 <div class="section"> 562 <dl class="history"> 563 <dt>2010/01/07</dt> 564<dd>Initial version.<br /> 565 </dd> 566 </dl> 567 </div> 568 <hr><p>CONFIDENTIAL</p></body> 569</html>