nn::camera::CTR Namespace

Description

The CTR's CAMERA namespace.
(This namespace can also be written without the ::CTR portion.)

Regardless of the sleep state, the camera operations now stop when the cover of the system is closed.
If the system is closed while images are being captured, image capture will resume when the system is re-opened. However, because an internal process equivalent to nn::camera::CTR::Activate(SELECT_NONE) is run when the system is closed, note that the images obtained immediately after the camera is started (as described in the Function Reference Manual for nn::camera::CTR::Activate) will be unstable for some time. In addition, depending on when the system is closed, the nn::camera::CTR::IsBusy function may enter a state in which it always returns true (as described in the Function Reference Manual for nn::camera::CTR::IsBusy). Although this state clears up when the system is opened, if you implement a process to transition to Sleep Mode when the system is closed, exercise caution to prevent the nn::camera::IsBusy function from polling in an infinite loop.

The camera functions are not all thread-safe, so they must not be called simultaneously from multiple threads, but also note that the camera functions must not be called during applet transitions.

Classes

nn::camera::CTR::ResultIsSleeping Indicates that the function attempted to be called cannot be used because the system cover is closed.
nn::camera::CTR::ResultFatalError Indicates that the camera failed to reboot. There may be something physically wrong with the camera.
nn::camera::CTR::ResultAlreadyInitialized Indicates that the Camera library has already been initialized.
nn::camera::CTR::ResultUsingOtherProcess Indicates that this process cannot use the cameras because another process is currently using them.

Structures

nn::camera::CTR::StereoCameraCalibrationData Structure that gives calibration information for the stereo cameras.
nn::camera::CTR::PackageParameterCameraSelect Structure for batch-configuring parameters without context but with cameras specified.
nn::camera::CTR::PackageParameterContext Structure used for batch-configuring parameters with context and with cameras specified. Use when specifying the size with SetDetailSize.
nn::camera::CTR::PackageParameterContextDetail Structure used for batch-configuring parameters with context and with cameras specified. Use when specifying the size with SetDetailSize.

Enumerated Types

CameraSelect Enumerated type that represents combinations of cameras.
Port Enumerated type that indicates a camera's connection target port.
Context Enumerated type that indicates the camera context.
Flip Enumerated type that indicates flipping types.
Size Enumerated type that indicates resolutions.
FrameRate Enumerated type that indicates framerates.
WhiteBalance Enumerated type that indicates white balance.
PhotoMode Enumerated type that indicates the photo mode.
Effect Enumerated type that indicates effects.
Contrast Enumerated type that indicates contrast (gamma curve) patterns.
LensCorrection Enumerated type that indicates the degree of lens correction to apply.
ShutterSoundType Enumerated type that indicates types of shutter sounds.

Functions

Other
Initialize Initializes the CAMERA library and makes the cameras available for use.
Finalize Finalizes the Camera library.
StartCapture Starts capturing.
StopCapture Stops capturing.
IsBusy Gets whether the camera is currently capturing image data.
ClearBuffer Clears the buffer and the error flags.
GetVsyncInterruptEvent Gets the event used to detect camera V-Sync interrupts.
GetBufferErrorInterruptEvent Gets the event used to detect camera buffer error interrupts and reboots.
SetReceiving Configures loading of image data. Only a single frame is received, so this must be set once per each camera frame.
IsFinishedReceiving Checks whether image data transfer has completed.
SetTransferLines Sets the number of lines to save in the buffer.
GetMaxLines Gets the maximum number of lines that can be saved in the buffer.
SetTransferBytes Sets the number of bytes to save in the buffer.
GetTransferBytes Gets the current setting for the number of bytes to save to the buffer.
GetMaxBytes Gets the maximum number of bytes that can be saved in the buffer.
GetLineBytes Gets the number of bytes in one line.
GetFrameBytes Gets the number of bytes in one frame.
SetTrimming Enables/disables trimming.
IsTrimming Checks whether trimming is enabled.
SetTrimmingParams Sets the positions to which to trim.
GetTrimmingParams Gets the positions to which to trim.
SetTrimmingParamsCenter Sets the trimming positions relative to the center of the camera image.
Activate Activates a camera.
SwitchContext Switches the camera settings context.
SetExposure Sets the exposure.
SetWhiteBalance Sets the white balance.
SetSharpness Sets the sharpness.
SetAutoExposure Enables/disables auto exposure.
IsAutoExposure Checks whether auto exposure is enabled.
SetAutoWhiteBalance Enables/disables automatic white balance.
IsAutoWhiteBalance Checks whether automatic white balance is enabled.
FlipImage Configures flipping of images.
SetDetailSize Sets the resolution (in pixels).
SetSize Sets the resolution.
SetFrameRate Sets the framerate.
SetPhotoMode Sets the photo mode.
SetEffect Sets an image effect.
SetContrast Sets the image contrast (gamma curve).
SetLensCorrection Sets the degree of lens correction.
SetAutoExposureWindow Sets the region within the view to use as the basis for calculating auto exposure (the response frame).
SetAutoWhiteBalanceWindow Sets the region within the view to use as the basis for calculating auto white balance.
SetNoiseFilter Sets the noise filter.
SynchronizeVsyncTiming Synchronizes the camera V-Sync signal timing. However, this can never perfectly synchronize timing so that there is absolutely no discrepancy.
GetLatestVsyncTiming Gets the timing history of camera V-Sync signal inputs.
GetStereoCameraCalibrationData Gets calibration data for the stereo camera positions.
GetParallaxOnChart Calculates the parallax in the measurement chart when the stereo cameras' calibration data is measured.
GetStereoCameraCalibrationMatrix Calculates a correction matrix used to make the left camera image match the right camera image in 3D space.
SetPackageParameterWithoutContext Batch-configures settings for a camera with no context specified.
SetPackageParameterWithContext Batch-configures settings for a camera with context specified. Use when configuring resolution with an enumerated type.
GetSuitableY2rStandardCoefficient Gets the Y2R conversion coefficient applied to the data output by the camera.
PlayShutterSound Plays back the shutter sound and temporarily illuminates the camera LED.

Revision History

2010/12/27
Added explanation about calling camera functions during applet transitions.
2010/11/01
Added an explanation about behavior when the cover is closed.
2010/10/04
Added an explanation about behavior when the camera recovers from sleep.
2010/01/07
Initial version.

CONFIDENTIAL