Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 252fa531 authored by Shuzhen Wang's avatar Shuzhen Wang
Browse files

Camera: Improve doc for postRawSensitivityBoost 

Mention postRawSensitivityBoost together with sensitivity for better
developer visibility.

Test: Read docs
Bug: 119755308
Change-Id: If22a67d94dae27a56f4cd33a38a0e9433e51ad1d
parent 55012a0d

core/java/android/hardware/camera2/CaptureRequest.java

+8 −0
Original line number Diff line number Diff line
@@ -2790,6 +2790,12 @@ public final class CaptureRequest extends CameraMetadata<CaptureRequest.Key<?>> 
     * output capture result.</p>

     * <p>This control is only effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} is set to

     * OFF; otherwise the auto-exposure algorithm will override this value.</p>

     * <p>Note that for devices supporting postRawSensitivityBoost, the total sensitivity applied

     * to the final processed image is the combination of {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} and

     * {@link CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST android.control.postRawSensitivityBoost}. In case the application uses the sensor

     * sensitivity from last capture result of an auto request for a manual request, in order

     * to achieve the same brightness in the output image, the application should also

     * set postRawSensitivityBoost.</p>

     * <p><b>Units</b>: ISO arithmetic units</p>

     * <p><b>Range of valid values:</b><br>

     * {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</p>
@@ -2800,9 +2806,11 @@ public final class CaptureRequest extends CameraMetadata<CaptureRequest.Key<?>> 
     *

     * @see CaptureRequest#CONTROL_AE_MODE

     * @see CaptureRequest#CONTROL_MODE

     * @see CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST

     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL

     * @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE

     * @see CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY

     * @see CaptureRequest#SENSOR_SENSITIVITY

     */

    @PublicKey

    @NonNull

core/java/android/hardware/camera2/CaptureResult.java

+8 −0
Original line number Diff line number Diff line
@@ -3428,6 +3428,12 @@ public class CaptureResult extends CameraMetadata<CaptureResult.Key<?>> { 
     * output capture result.</p>

     * <p>This control is only effective if {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} or {@link CaptureRequest#CONTROL_MODE android.control.mode} is set to

     * OFF; otherwise the auto-exposure algorithm will override this value.</p>

     * <p>Note that for devices supporting postRawSensitivityBoost, the total sensitivity applied

     * to the final processed image is the combination of {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} and

     * {@link CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST android.control.postRawSensitivityBoost}. In case the application uses the sensor

     * sensitivity from last capture result of an auto request for a manual request, in order

     * to achieve the same brightness in the output image, the application should also

     * set postRawSensitivityBoost.</p>

     * <p><b>Units</b>: ISO arithmetic units</p>

     * <p><b>Range of valid values:</b><br>

     * {@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</p>
@@ -3438,9 +3444,11 @@ public class CaptureResult extends CameraMetadata<CaptureResult.Key<?>> { 
     *

     * @see CaptureRequest#CONTROL_AE_MODE

     * @see CaptureRequest#CONTROL_MODE

     * @see CaptureRequest#CONTROL_POST_RAW_SENSITIVITY_BOOST

     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL

     * @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE

     * @see CameraCharacteristics#SENSOR_MAX_ANALOG_SENSITIVITY

     * @see CaptureRequest#SENSOR_SENSITIVITY

     */

    @PublicKey

    @NonNull