From ea7b8656a226b5ee8f3b1feab4c66823d00ac811 Mon Sep 17 00:00:00 2001 From: Ying Wei Date: Tue, 14 Feb 2023 20:19:02 +0000 Subject: Update documentation for WindowManager.LayoutParams#preferredRefreshRate Bug: 257071505 Test: N/A, doc change only Change-Id: If07b8120ca74bd88652eacea2d16cabd12389440 (cherry picked from commit 1fd2803616b650982990827140def5b8061ebcfc) Merged-In: If07b8120ca74bd88652eacea2d16cabd12389440 --- core/java/android/view/WindowManager.java | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/core/java/android/view/WindowManager.java b/core/java/android/view/WindowManager.java index cc846e3537e1..cda1f3adb9a4 100644 --- a/core/java/android/view/WindowManager.java +++ b/core/java/android/view/WindowManager.java @@ -3616,9 +3616,20 @@ public interface WindowManager extends ViewManager { /** * The preferred refresh rate for the window. *

- * This must be one of the supported refresh rates obtained for the display(s) the window - * is on. The selected refresh rate will be applied to the display's default mode. + * Before API 34, this must be one of the supported refresh rates obtained + * for the display(s) the window is on. The selected refresh rate will be + * applied to the display's default mode. *

+ * Starting API 34, this value is not limited to the supported refresh rates + * obtained from the display(s) for the window: it can be any refresh rate + * the window intends to run at. Any refresh rate can be provided as the + * preferred window refresh rate. The OS will select the refresh rate that + * best matches the {@link #preferredRefreshRate}. + *

+ * Setting this value is the equivalent of calling {@link Surface#setFrameRate} with ( + * preferred_frame_rate, + * {@link Surface#FRAME_RATE_COMPATIBILITY_DEFAULT}, + * {@link Surface#CHANGE_FRAME_RATE_ONLY_IF_SEAMLESS}). * This should be used in favor of {@link LayoutParams#preferredDisplayModeId} for * applications that want to specify the refresh rate, but do not want to specify a * preference for any other displayMode properties (e.g., resolution). -- cgit v1.2.3-59-g8ed1b