diff options
| author | Marin Shalamanov <shalamanov@google.com> | 2021-04-27 15:56:08 +0000 |
|---|---|---|
| committer | Android (Google) Code Review <android-gerrit@google.com> | 2021-04-27 15:56:08 +0000 |
| commit | deb3ccf04832df259fba91c0a0bafa4ac8a7156e (patch) | |
| tree | e1aabcc5357f00c6abd8c942b2bd23a53c70aa50 /core/java/android/view/SurfaceControl.java | |
| parent | e2f08225e93556d86f16c4fedc18fd92314fc8b5 (diff) | |
| parent | c48e5da476d996617713556c618d47f56d7d49cd (diff) | |
Merge "Update javadoc for setFrameRate" into sc-dev
Diffstat (limited to 'core/java/android/view/SurfaceControl.java')
| -rw-r--r-- | core/java/android/view/SurfaceControl.java | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/core/java/android/view/SurfaceControl.java b/core/java/android/view/SurfaceControl.java index 3ff7a65b6c6a..ac70dff4f03e 100644 --- a/core/java/android/view/SurfaceControl.java +++ b/core/java/android/view/SurfaceControl.java @@ -3298,20 +3298,26 @@ public final class SurfaceControl implements Parcelable { * because the system may change the display refresh rate, calls to this function may result * in changes to Choreographer callback timings, and changes to the time interval at which * the system releases buffers back to the application. + * <p> + * Note that this only has an effect for surfaces presented on the display. If this + * surface is consumed by something other than the system compositor, e.g. a media + * codec, this call has no effect. * * @param sc The SurfaceControl to specify the frame rate of. * @param frameRate The intended frame rate for this surface, in frames per second. 0 is a * special value that indicates the app will accept the system's choice for * the display frame rate, which is the default behavior if this function - * isn't called. The frameRate param does <em>not</em> need to be a valid - * refresh rate for this device's display - e.g., it's fine to pass 30fps - * to a device that can only run the display at 60fps. + * isn't called. The <code>frameRate</code> param does <em>not</em> need + * to be a valid refresh rate for this device's display - e.g., it's fine + * to pass 30fps to a device that can only run the display at 60fps. * @param compatibility The frame rate compatibility of this surface. The compatibility * value may influence the system's choice of display frame rate. - * @param changeFrameRateStrategy Whether display refresh rate transitions should be - * seamless. A seamless transition is one that doesn't have - * any visual interruptions, such as a black screen for a - * second or two. + * This parameter is ignored when <code>frameRate</code> is 0. + * @param changeFrameRateStrategy Whether display refresh rate transitions caused by this + * surface should be seamless. A seamless transition is one + * that doesn't have any visual interruptions, such as a + * black screen for a second or two. This parameter is + * ignored when <code>frameRate</code> is 0. * @return This transaction object. */ @NonNull |