nn::camera::CTR::SetAutoWhiteBalanceWindow Function

Syntax

nn::Result SetAutoWhiteBalanceWindow(
     CameraSelect select,
     s16 startX,
     s16 startY,
     s16 width ,
     s16 height
);

Arguments

Name Description
in select Specifies which camera to change settings for.
in startX Specifies the x-coordinate of the region's upper-left corner. If the x-coordinate of the image's upper-left corner is defined as 0, this argument can be specified in 40-pixel increments in the range [0, 600].
in startY Specifies the y-coordinate of the region's upper-left corner. If the y-coordinate of the image's upper-left corner is defined as 0, this argument can be specified in 30-pixel increments in the range [0, 450].
in width Specifies the region's width. This can be specified in 40-pixel increments in the range [40, 640]. The sum of this value and startX must be no larger than 640.
in height Specifies the region's height. This can be specified in 30-pixel increments in the range [30, 480]. The sum of this value and startY must be no larger than 480.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
ResultSuccess Process was successful.
ResultIsSleeping Unusable because the system is closed.
ResultFatalError There may be something physically wrong with the camera.

Description

Sets the region within the view to use as the basis for calculating auto white balance (the response frame).

The rectangular region specified by startX, startY, width, and height must be no larger than 640x480.

All cameras share the following default values.

startX0
startY0
width640
height480

Although the cameras only use the response frame that can be set by this function when auto white balance is enabled, you can set the response frame with this function even when auto white balance is disabled. You must therefore specify appropriate values when you call this function even if auto white balance is disabled.

Note: This function may block for an extended period if a camera is restarting.

Revision History

2010/12/13
Mentioned that this function can set values even when auto white balance is disabled.
2010/12/07
Fixed errors in the description of the range for the width and height values.
2010/09/13
Initial version.

CONFIDENTIAL