diff options
| author | David Plowman <david.plowman@raspberrypi.com> | 2020-12-01 17:55:35 +0000 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2020-12-01 20:44:18 +0200 |
| commit | 6e2bbe2e2c33cab4d069d2983cceb5541440764c (patch) | |
| tree | 07c3830f23e0997994ce030779855c3a508dc4bb /src/libcamera/control_ids.yaml | |
| parent | 472d3d3cdb04388b4ada7c7c4cee71fe1145b663 (diff) | |
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 <david.plowman@raspberrypi.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'src/libcamera/control_ids.yaml')
| -rw-r--r-- | src/libcamera/control_ids.yaml | 20 |
1 files changed, 20 insertions, 0 deletions
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: | |