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

Commit 4528b333 authored by Steven Thomas's avatar Steven Thomas
Browse files

Clean up some formatting problems in the setFrameRate sdk docs 

Bug: 152413112
Test: Built the sdk docs locally, confirmed they look correct.
Change-Id: Ia7286958b582e6d0eb776c4ebeff6072dabc723e
parent 2279fd5f

core/java/android/view/Surface.java

+8 −8
Original line number Diff line number Diff line
@@ -871,24 +871,24 @@ public class Surface implements Parcelable { 
    /**

     * Sets the intended frame rate for this surface.

     *

     * On devices that are capable of running the display at different refresh rates, the

     * system may choose a display refresh rate to better match this surface's frame

     * <p>On devices that are capable of running the display at different refresh rates,

     * the system may choose a display refresh rate to better match this surface's frame

     * rate. Usage of this API won't introduce frame rate throttling, or affect other

     * aspects of the application's frame production pipeline. However, 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.

     * system releases buffers back to the application.</p>

     *

     * Note that this only has an effect for surfaces presented on the display. If this

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

     * codec, this call has no effect.</p>

     *

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

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

     *

     * @param compatibility The frame rate compatibility of this surface. The

     * compatibility value may influence the system's choice of display frame rate. See

core/java/android/view/SurfaceControl.java

+4 −4
Original line number Diff line number Diff line
@@ -2738,7 +2738,7 @@ public final class SurfaceControl implements Parcelable { 


        /**

         * Sets the intended frame rate for the surface {@link SurfaceControl}.

         *

         * <p>

         * On devices that are capable of running the display at different refresh rates, the system

         * may choose a display refresh rate to better match this surface's frame rate. Usage of

         * this API won't directly affect the application's frame production pipeline. However,
@@ -2750,9 +2750,9 @@ public final class SurfaceControl implements Parcelable { 
         * @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.

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

         * @param compatibility The frame rate compatibility of this surface. The compatibility

         *                      value may influence the system's choice of display frame rate. See

         *                      the Surface.FRAME_RATE_COMPATIBILITY_* values for more info.