summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author TreeHugger Robot <treehugger-gerrit@google.com> 2020-01-25 01:43:31 +0000
committer Android (Google) Code Review <android-gerrit@google.com> 2020-01-25 01:43:31 +0000
commitf3d1ce018d43dc8a39dd932cce7a7cd4e87a42a1 (patch)
treec231ae2ba4eff2a076bcbd91955bae19c54c9c2c
parent5d2d5718f6eebebe51e7e823aebffb76979798ce (diff)
parentadd6be19c033803305773b820e86bbacdb617452 (diff)
Merge "Clarify frame rate as frames per second"
-rw-r--r--core/java/android/view/Surface.java11
-rw-r--r--core/java/android/view/SurfaceControl.java12
2 files changed, 12 insertions, 11 deletions
diff --git a/core/java/android/view/Surface.java b/core/java/android/view/Surface.java
index a6b7c33de3d9..78a080de20e5 100644
--- a/core/java/android/view/Surface.java
+++ b/core/java/android/view/Surface.java
@@ -858,11 +858,12 @@ public class Surface implements Parcelable {
* surface is consumed by something other than the system compositor, e.g. a media
* codec, this call has no effect.
*
- * @param frameRate The intended frame rate of this surface. 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
- * *not* 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 frameRate The intended frame rate of 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 *not* 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.
*/
public void setFrameRate(@FloatRange(from = 0.0) float frameRate) {
int error = nativeSetFrameRate(mNativeObject, frameRate);
diff --git a/core/java/android/view/SurfaceControl.java b/core/java/android/view/SurfaceControl.java
index 811b0637db98..bee05a9a57d0 100644
--- a/core/java/android/view/SurfaceControl.java
+++ b/core/java/android/view/SurfaceControl.java
@@ -2801,12 +2801,12 @@ public final class SurfaceControl implements Parcelable {
* the system releases buffers back to the application.
*
* @param sc The SurfaceControl to specify the frame rate of.
- * @param frameRate The intended frame rate for this surface. 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 *not* 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 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 *not* 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.
* @return This transaction object.
*/
@NonNull