nn::camera::CTR::SetAutoWhiteBalance Function

Syntax

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

Arguments

Name Description
in select Specifies which camera to change settings for.
in on Specify true to enable or false to disable.

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

Enables/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 the automatic adjustment feature 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.

A camera's exposure value is unstable immediately after the camera is started with the Activate function.

Calling the SetWhiteBalance function resets the value set by this function and enables automatic white balancing.

The default value is true for all cameras.

Note that this function may block for an extended period if a camera is restarting.

Revision History

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.

CONFIDENTIAL