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

Commit 15b6f9c8 authored by Steven Thomas's avatar Steven Thomas
Browse files

Clean up some formatting problems in the setFrameRate ndk docs 

Bug: 152413112

Test: Unfortunately there's no convenient way to build the ndk docs
locally, so we're just going to submit and see if the regenerated DAC
docs look correct. I talked with Dan Albert on the ndk team about this,
and he decided to reopen b/115644359 to see if we can get some easy way
to build the ndk docs locally again, so we can verify minor formatting
fixes like this.

Change-Id: Ie29a19a386887df6305ee9a4447702126fed7972
parent 75eec41f

include/android/surface_control.h

+4 −4
Original line number Diff line number Diff line
@@ -409,7 +409,7 @@ void ASurfaceTransaction_setHdrMetadata_cta861_3(ASurfaceTransaction* transactio 


#if __ANDROID_API__ >= 30



/*

/**

 * Sets the intended frame rate for |surface_control|.

 *

 * On devices that are capable of running the display at different refresh rates, the system may
@@ -421,9 +421,9 @@ void ASurfaceTransaction_setHdrMetadata_cta861_3(ASurfaceTransaction* transactio 
 *

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

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

 *

 * |compatibility| The frame rate compatibility of this surface. The compatibility value may

 * influence the system's choice of display frame rate. To specify a compatibility use the

libs/nativewindow/include/android/native_window.h

+6 −6
Original line number Diff line number Diff line
@@ -233,15 +233,15 @@ int32_t ANativeWindow_getBuffersDataSpace(ANativeWindow* window) __INTRODUCED_IN 


#if __ANDROID_API__ >= 30



/* Parameter for ANativeWindow_setFrameRate */

enum {

/** Compatibility value for ANativeWindow_setFrameRate. */

enum ANativeWindow_FrameRateCompatibility {

    /**

     * There are no inherent restrictions on the frame rate of this window.

     */

    ANATIVEWINDOW_FRAME_RATE_COMPATIBILITY_DEFAULT = 0,

    /**

     * This window is being used to display content with an inherently fixed

     * frame rate, e.g. a video that has a specific frame rate. When the system

     * frame rate, e.g.\ a video that has a specific frame rate. When the system

     * selects a frame rate other than what the app requested, the app will need

     * to do pull down or use some other technique to adapt to the system's

     * frame rate. The user experience is likely to be worse (e.g. more frame
@@ -272,9 +272,9 @@ enum { 
 * \param frameRate The intended frame rate of this window, 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.

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

 *

 * \param compatibility The frame rate compatibility of this window. The

 * compatibility value may influence the system's choice of display refresh