Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation for WindowManager.LayoutParams#preferredRefreshRate

Browse Source 
Bug: 257071505
Test: N/A, doc change only
Change-Id: If07b8120ca74bd88652eacea2d16cabd12389440
This commit is contained in:
Ying Wei
2023-02-14 20:19:02 +00:00
parent 48bba8ef90
commit 1fd2803616
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
core/java/android/view/WindowManager.java
View File

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