camera_whitebalancemode_t

Updated: April 19, 2023

The white balance mode of the camera

Synopsis:

#include <camera/camera_3a.h>
typedef enum {
    CAMERA_WHITEBALANCEMODE_DEFAULT,
    CAMERA_WHITEBALANCEMODE_OFF,
    CAMERA_WHITEBALANCEMODE_AUTO,
    CAMERA_WHITEBALANCEMODE_MANUAL,
    CAMERA_WHITEBALANCEMODE_MANUAL_RB_GAIN,
    CAMERA_WHITEBALANCEMODE_AUTO_ONCE,
    CAMERA_WHITEBALANCEMODE_NUMWHITEBALANCEMODES
} camera_whitebalancemode_t;

Data:

CAMERA_WHITEBALANCEMODE_DEFAULT
The default white balance mode.

Because not every camera supports all available white balance modes, CAMERA_WHITEBALANCEMODE_DEFAULT can be used as an alias to select a valid white balance mode.

CAMERA_WHITEBALANCEMODE_OFF
Auto white balance is disabled.
CAMERA_WHITEBALANCEMODE_AUTO
Auto white balance is enabled and the white balance will be automatically adjusted by the camera.
CAMERA_WHITEBALANCEMODE_MANUAL
White balance must be manually set in terms of color temperature.
CAMERA_WHITEBALANCEMODE_MANUAL_RB_GAIN
White balance must be manually set in terms of red and blue gains.
CAMERA_WHITEBALANCEMODE_AUTO_ONCE
Auto white balance is run once on the camera to adjust the white balance based on current lighting conditions.

After the adjustments are made, the same white balance settings are used for the camera. You can set this mode multiple times to re-run this one-time adjustment.

CAMERA_WHITEBALANCEMODE_NUMWHITEBALANCEMODES
The total number of white balance modes.

Library:

libcamapi

Description:

You can use the camera_get_whitebalance_modes() function to determine which modes are supported by the current platform and camera.