diff options
| author | Steven Thomas <steventhomas@google.com> | 2020-01-23 16:35:32 -0800 |
|---|---|---|
| committer | Steven Thomas <steventhomas@google.com> | 2020-01-23 16:35:32 -0800 |
| commit | add6be19c033803305773b820e86bbacdb617452 (patch) | |
| tree | 8c0a5677055048dc4d31074e252370dd69709ac2 /core/java/android/view/Surface.java | |
| parent | 37009349f0ff180f20b3a7fad820a0902d54fde6 (diff) | |
Clarify frame rate as frames per second
Bug: 137287430
Test: n/a
Change-Id: Ibc2327fde50cbd86025842c4bebf4e26ffe42aa3
Diffstat (limited to 'core/java/android/view/Surface.java')
| -rw-r--r-- | core/java/android/view/Surface.java | 11 |
1 files changed, 6 insertions, 5 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); |