Camera Library Referencecamera_3a.h Parent topic: camera_3a.h

camera_set_manual_white_balance_rb_gain()

Updated: April 19, 2023

Change the manual white balance red and blue gains

Synopsis:

#include <camera/camera_3a.h>
camera_error_t camera_set_manual_white_balance_rb_gain(camera_handle_t handle,
                                                       unsigned red_gain,
                                                       unsigned blue_gain)

Arguments:

handle
The handle returned by a call to the camera_open() function.
red_gain
The white balance red gain value. Use camera_get_supported_manual_white_balance_rb_gain() to determine the white balance red gain values that can be set.
blue_gain
The white balance blue gain value. Use camera_get_supported_manual_white_balance_rb_gain() to determine the white balance blue gain values that can be set.

Library:

libcamapi

Description:

Use this function to set the white balance red and blue gain values. The red and blue gains alter the amount of red and blue colors in the image. The values that you set using this function are only applied when the white balance mode has been set to manual, using the camera_set_whitebalance_mode() function with the CAMERA_WHITEBALANCEMODE_MANUAL_RB_GAIN property.

For more information regarding these manual settings, see the Manual camera settings section, and camera_whitebalancemode_t.

Returns:

CAMERA_EOK when the function successfully completes, otherwise another camera_error_t value that provides the reason that the call failed.

Parent topic: camera_3a.h