summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author ramindani <ramindani@google.com> 2024-12-02 16:24:29 -0800
committer ramindani <ramindani@google.com> 2024-12-02 16:25:34 -0800
commit1cb0eb01a0e6af10b0cf6e11a68c916df8c05c72 (patch)
tree20425461b80334505e13855f80ebb0439b6e3a7c
parente5c2529795c82c06c9ec83d831718d815c3b0e40 (diff)
Update documentation for the getSuggestedFrameRate
Now that FrameRateParams is rolled back we need to update the documentation to not mention it. Test: m BUG: 361433796 Flag: EXEMPT update javadoc Change-Id: I0301898e71fce4b5d4543e39f0d694e8e0942793
-rw-r--r--core/java/android/view/Display.java9
1 files changed, 2 insertions, 7 deletions
diff --git a/core/java/android/view/Display.java b/core/java/android/view/Display.java
index c9d560c3424b..ef040d55e7ea 100644
--- a/core/java/android/view/Display.java
+++ b/core/java/android/view/Display.java
@@ -1332,22 +1332,17 @@ public final class Display {
*
* <p> For example, an animation that does not require fast render rates can use
* the {@link #FRAME_RATE_CATEGORY_NORMAL} to get the suggested frame rate.
- * The suggested frame rate then can be used in the
- * {@link Surface.FrameRateParams.Builder#setDesiredRateRange} for desiredMinRate.
*
* <pre>{@code
* float desiredMinRate = display.getSuggestedFrameRate(FRAME_RATE_CATEGORY_NORMAL);
- * Surface.FrameRateParams params = new Surface.FrameRateParams.Builder().
- * setDesiredRateRange(desiredMinRate, Float.MAX).build();
- * surface.setFrameRate(params);
+ * surface.setFrameRate(desiredMinRate, Surface.FRAME_RATE_COMPATIBILITY_DEFAULT);
* }</pre>
* </p>
*
* @param category either {@link #FRAME_RATE_CATEGORY_NORMAL}
* or {@link #FRAME_RATE_CATEGORY_HIGH}
*
- * @see Surface#setFrameRate(Surface.FrameRateParams)
- * @see SurfaceControl.Transaction#setFrameRate(SurfaceControl, Surface.FrameRateParams)
+ * @see Surface#setFrameRate(float, int)
* @throws IllegalArgumentException when category is not {@link #FRAME_RATE_CATEGORY_NORMAL}
* or {@link #FRAME_RATE_CATEGORY_HIGH}
*/