diff options
| author | 2023-04-19 14:35:44 -0400 | |
|---|---|---|
| committer | 2023-04-19 15:42:12 -0400 | |
| commit | e77e0eb06be61ccb75c838ec41d63d6574265296 (patch) | |
| tree | 02ac4a1591e00f507cfb929f7fc7195c8aad5826 | |
| parent | 269c2879760de630bfbef53d9527ff51150cf6ab (diff) | |
Tweak SC#setExtendedRangeBrightness docs
Bug: 278780207
Test: make offline-sdk-docs
Change-Id: I7bc1292676d036de24c7aacc838e5afb2010ef95
| -rw-r--r-- | core/java/android/view/SurfaceControl.java | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/core/java/android/view/SurfaceControl.java b/core/java/android/view/SurfaceControl.java index bc6a3b540ce7..738c8d431640 100644 --- a/core/java/android/view/SurfaceControl.java +++ b/core/java/android/view/SurfaceControl.java @@ -3846,14 +3846,14 @@ public final class SurfaceControl implements Parcelable { * 100 nits and a max display brightness of 200 nits, this should * be set to 2.0f. * - * Default value is 1.0f. + * <p>Default value is 1.0f. * - * Transfer functions that encode their own brightness ranges, + * <p>Transfer functions that encode their own brightness ranges, * such as HLG or PQ, should also set this to 1.0f and instead * communicate extended content brightness information via * metadata such as CTA861_3 or SMPTE2086. * - * Must be finite && >= 1.0f + * <p>Must be finite && >= 1.0f * * @param desiredRatio The desired hdr/sdr ratio. This can be used to communicate the max * desired brightness range. This is similar to the "max luminance" @@ -3862,13 +3862,17 @@ public final class SurfaceControl implements Parcelable { * may not be able to, or may choose not to, deliver the * requested range. * - * If unspecified, the system will attempt to provide the best range - * it can for the given ambient conditions & device state. However, - * voluntarily reducing the requested range can help improve battery - * life as well as can improve quality by ensuring greater bit depth - * is allocated to the luminance range in use. + * <p>While requesting a large desired ratio will result in the most + * dynamic range, voluntarily reducing the requested range can help + * improve battery life as well as can improve quality by ensuring + * greater bit depth is allocated to the luminance range in use. * - * Must be finite && >= 1.0f + * <p>Default value is 1.0f and indicates that extended range brightness + * is not being used, so the resulting SDR or HDR behavior will be + * determined entirely by the dataspace being used (ie, typically SDR + * however PQ or HLG transfer functions will still result in HDR) + * + * <p>Must be finite && >= 1.0f * @return this **/ public @NonNull Transaction setExtendedRangeBrightness(@NonNull SurfaceControl sc, |