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