Add *Async variants of capture*ToBitmap methods.

This is a precursor change to modifying the captureToBitmap functions to be suspend functions.

PiperOrigin-RevId: 614867086

Author: brettchabot

core/CHANGELOG.md

@@ -14,6 +14,7 @@
 
 * Added ApplicationInfoBuilder.setFlags(int)
 * Make Bitmap.writeToTestStorage use the registered PlatformTestStorage instead of hardcoding TestStorage
+* Add *Async variants of capture*ToBitmap methods
 
 **Breaking API Changes**
 

core/java/androidx/test/core/view/ViewCapture.kt

@@ -57,6 +57,9 @@ import java.util.function.Consumer
  * bitmap will be a 5x5 bitmap that spans (15, 15 - 20, 20). This is particularly useful for
  * Compose, which only has a singular view that contains a hierarchy of nodes.
  *
+ * Note: This API will likely change in the future to a kotlin suspend function. If you want a
+ * method that returns a ListenableFuture instead, use [captureToBitmapAsync].
+ *
  * This API is currently experimental and subject to change or removal.
  */
 @ExperimentalTestApi
@@ -82,6 +85,15 @@ fun View.captureToBitmap(rect: Rect? = null): ListenableFuture<Bitmap> {
   return bitmapFuture
 }
 
+/**
+ * Equivalent to [captureToBitmap] for now. In the future [captureToBitmap] will be changed to a
+ * suspend function.
+ */
+@ExperimentalTestApi
+fun View.captureToBitmapAsync(rect: Rect? = null): ListenableFuture<Bitmap> {
+  return captureToBitmap(rect)
+}
+
 /**
  * Trigger a redraw of the given view.
  *
@@ -195,7 +207,7 @@ private fun View.generateBitmapFromPixelCopy(
         bounds.left + rect.left,
         bounds.top + rect.top,
         bounds.left + rect.right,
-        bounds.top + rect.bottom
+        bounds.top + rect.bottom,
       )
   }
   PixelCopy.request(surface, bounds, destBitmap, onCopyFinished, Handler(Looper.getMainLooper()))
@@ -256,7 +268,7 @@ private fun View.reflectivelyGetLocationInSurface(locationInSurface: IntArray) {
     // ART restrictions introduced in API 29 disallow reflective access to mWindowAttributes
     Log.w(
       "ViewCapture",
-      "Could not calculate offset of view in surface on API 28, resulting image may have incorrect positioning"
+      "Could not calculate offset of view in surface on API 28, resulting image may have incorrect positioning",
     )
   }
 }

core/java/androidx/test/core/view/WindowCapture.kt

@@ -41,6 +41,9 @@ import com.google.common.util.concurrent.ListenableFuture
  * This API is primarily intended for use in lower layer libraries or frameworks. For test authors,
  * its recommended to use espresso or compose's captureToImage.
  *
+ * Note: This API will likely change in the future to a kotlin suspend function. If you want a
+ * method that returns a ListenableFuture instead, use [captureRegionToBitmapAsync].
+ *
  * This API is currently experimental and subject to change or removal.
  */
 @ExperimentalTestApi
@@ -62,15 +65,24 @@ fun Window.captureRegionToBitmap(boundsInWindow: Rect? = null): ListenableFuture
   return bitmapFuture
 }
 
+/**
+ * Equivalent to [captureRegionToBitmap] for now. In the future [captureRegionToBitmap] will be
+ * changed to a suspend function.
+ */
+@ExperimentalTestApi
+fun Window.captureRegionToBitmapAsync(boundsInWindow: Rect? = null): ListenableFuture<Bitmap> {
+  return captureRegionToBitmap(boundsInWindow)
+}
+
 internal fun Window.generateBitmap(
   boundsInWindow: Rect? = null,
-  bitmapFuture: ResolvableFuture<Bitmap>
+  bitmapFuture: ResolvableFuture<Bitmap>,
 ) {
   val destBitmap =
     Bitmap.createBitmap(
       boundsInWindow?.width() ?: decorView.width,
       boundsInWindow?.height() ?: decorView.height,
-      Bitmap.Config.ARGB_8888
+      Bitmap.Config.ARGB_8888,
     )
   when {
     Build.VERSION.SDK_INT < 26 ->
@@ -84,7 +96,7 @@ internal fun Window.generateBitmap(
 internal fun Window.generateBitmapFromPixelCopy(
   boundsInWindow: Rect? = null,
   destBitmap: Bitmap,
-  bitmapFuture: ResolvableFuture<Bitmap>
+  bitmapFuture: ResolvableFuture<Bitmap>,
 ) {
   val onCopyFinished =
     PixelCopy.OnPixelCopyFinishedListener { result ->
@@ -99,6 +111,6 @@ internal fun Window.generateBitmapFromPixelCopy(
     boundsInWindow,
     destBitmap,
     onCopyFinished,
-    Handler(Looper.getMainLooper())
+    Handler(Looper.getMainLooper()),
   )
 }