summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--core/java/android/view/SurfaceControl.java22
1 files changed, 13 insertions, 9 deletions
diff --git a/core/java/android/view/SurfaceControl.java b/core/java/android/view/SurfaceControl.java
index 2fa03c5ba92e..99deac4c8cf4 100644
--- a/core/java/android/view/SurfaceControl.java
+++ b/core/java/android/view/SurfaceControl.java
@@ -3864,14 +3864,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"
@@ -3880,13 +3880,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,