From 6e2bbe2e2c33cab4d069d2983cceb5541440764c Mon Sep 17 00:00:00 2001 From: David Plowman Date: Tue, 1 Dec 2020 17:55:35 +0000 Subject: libcamera: controls: Improve documentation for ExposureTime and AnalogueGain Setting these controls "fixes" them and the AE may not change them; setting them back to zero returns them to the control of the AE algorithm. Signed-off-by: David Plowman Reviewed-by: Laurent Pinchart Signed-off-by: Laurent Pinchart --- src/libcamera/control_ids.yaml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'src/libcamera/control_ids.yaml') diff --git a/src/libcamera/control_ids.yaml b/src/libcamera/control_ids.yaml index a883e27e..6d6f0fee 100644 --- a/src/libcamera/control_ids.yaml +++ b/src/libcamera/control_ids.yaml @@ -125,8 +125,18 @@ controls: Exposure time (shutter speed) for the frame applied in the sensor device. This value is specified in micro-seconds. + Setting this value means that it is now fixed and the AE algorithm may + not change it. Setting it back to zero returns it to the control of the + AE algorithm. + \sa AnalogueGain AeEnable + \todo Document the interactions between AeEnable and setting a fixed + value for this control. Consider interactions with other AE features, + such as aperture and aperture/shutter priority mode, and decide if + control of which features should be automatically adjusted shouldn't + better be handled through a separate AE mode control. + - AnalogueGain: type: float description: | @@ -134,8 +144,18 @@ controls: The value of the control specifies the gain multiplier applied to all colour channels. This value cannot be lower than 1.0. + Setting this value means that it is now fixed and the AE algorithm may + not change it. Setting it back to zero returns it to the control of the + AE algorithm. + \sa ExposureTime AeEnable + \todo Document the interactions between AeEnable and setting a fixed + value for this control. Consider interactions with other AE features, + such as aperture and aperture/shutter priority mode, and decide if + control of which features should be automatically adjusted shouldn't + better be handled through a separate AE mode control. + - Brightness: type: float description: | -- cgit v1.2.1