nn::camera::CTR::SetAutoWhiteBalance Function

nn::Result SetAutoWhiteBalance(
     CameraSelect select,
     bool on
);

	Name	Description
in	select	Specifies which camera to change settings for.
in	on	Specify TRUE to enable this function. Specify FALSE to disable this function.

Returns the function's execution result. Returns one of the Result values listed below.

Value	Description
Result::IsSuccess	Process was successful.
ResultIsSleeping	This function is unusable because the system cover is closed.
ResultFatalError	There may be something physically wrong with the camera.

Enables or disables automatic white balance.

If the camera's white balance is set to "automatic" and WHITE_BALANCE_NORMAL, this function enables or disables automatic white balancing. When automatic white balancing is disabled, the white balance setting is locked to its value at that time. If the setting is not WHITE_BALANCE_NORMAL, this function fails.

If synchronization with the stereo camera's brightness was enabled via the nn::camera::CTR::SetBrightnessSynchronization function, it will not be possible to disable automatic adjustment in the left external camera (SELECT_OUT2). Function execution will fail.

White balance will be unset immediately after the camera is activated via the nn::camera::CTR::Activate function.

Calling the nn::camera::CTR::SetWhiteBalance function resets the value set by this function and enables automatic white balancing.

The default value is true for all cameras.

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

2011/03/22

Added information about failure conditions when brightness synchronization is enabled.

2010/09/24

Added explanation about disabling the automatic adjustment feature.

2010/07/17

Added explanation about operation during restart.

2010/07/14

Deleted related text following deletion of SynchronizeWhiteBalance function.

2010/06/18

Added information about this function's relationship with the SynchronizeWhiteBalance function.

2010/04/14

Added a description of the default values.

2010/04/09

Added description text.

2010/02/02

Initial version.