From 49ff2c615e53cd9c3e8b5e4792a68026fb079671 Mon Sep 17 00:00:00 2001 From: Mathias Agopian Date: Sun, 17 Mar 2013 01:05:21 -0700 Subject: [PATCH] improve SurfaceControl.screenshot documentation Change-Id: I7e17f69f74df8610b5b85fac0127727df973be42 --- core/java/android/view/SurfaceControl.java | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/core/java/android/view/SurfaceControl.java b/core/java/android/view/SurfaceControl.java index df07dcd1e0164..e869d09adaa70 100644 --- a/core/java/android/view/SurfaceControl.java +++ b/core/java/android/view/SurfaceControl.java @@ -574,7 +574,8 @@ public class SurfaceControl { * @param maxLayer The highest (top-most Z order) surface layer to * include in the screenshot. * @return Returns a Bitmap containing the screen contents, or null - * if an error occurs. + * if an error occurs. Make sure to call Bitmap.recycle() as soon as + * possible, once its content is not needed anymore. */ public static Bitmap screenshot(int width, int height, int minLayer, int maxLayer) { // TODO: should take the display as a parameter @@ -586,6 +587,14 @@ public class SurfaceControl { /** * Like {@link SurfaceControl#screenshot(int, int, int, int)} but includes all * Surfaces in the screenshot. + * + * @param width The desired width of the returned bitmap; the raw + * screen will be scaled down to this size. + * @param height The desired height of the returned bitmap; the raw + * screen will be scaled down to this size. + * @return Returns a Bitmap containing the screen contents, or null + * if an error occurs. Make sure to call Bitmap.recycle() as soon as + * possible, once its content is not needed anymore. */ public static Bitmap screenshot(int width, int height) { // TODO: should take the display as a parameter