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

Commit 1fd28036 authored by Ying Wei's avatar Ying Wei
Browse files

Update documentation for WindowManager.LayoutParams#preferredRefreshRate 

Bug: 257071505
Test: N/A, doc change only
Change-Id: If07b8120ca74bd88652eacea2d16cabd12389440
parent 48bba8ef

core/java/android/view/WindowManager.java

+13 −2
Original line number Diff line number Diff line
@@ -3635,9 +3635,20 @@ public interface WindowManager extends ViewManager { 
        /**

         * The preferred refresh rate for the window.

         * <p>

         * 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.

         * <p>

         * 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}.

         * <p>

         * 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).