summaryrefslogtreecommitdiffstats
path: root/graphics/java/android
diff options
context:
space:
mode:
authorPatrick Dubroy <dubroy@google.com>2011-01-20 16:48:59 -0800
committerPatrick Dubroy <dubroy@google.com>2011-01-21 12:08:51 -0800
commita383b3f646cbc1fd870f2694d4fac24340834916 (patch)
tree806d82277546477ac09faec763533b675fd67910 /graphics/java/android
parent0512d080a5ae7eccb154be4302aaf4b5fb8aa5a6 (diff)
downloadframeworks_base-a383b3f646cbc1fd870f2694d4fac24340834916.zip
frameworks_base-a383b3f646cbc1fd870f2694d4fac24340834916.tar.gz
frameworks_base-a383b3f646cbc1fd870f2694d4fac24340834916.tar.bz2
Update Bitmap.recycle() doc for heap-allocated pixel data
Diffstat (limited to 'graphics/java/android')
-rw-r--r--graphics/java/android/graphics/Bitmap.java10
1 files changed, 6 insertions, 4 deletions
diff --git a/graphics/java/android/graphics/Bitmap.java b/graphics/java/android/graphics/Bitmap.java
index e67ceed..2b4a410 100644
--- a/graphics/java/android/graphics/Bitmap.java
+++ b/graphics/java/android/graphics/Bitmap.java
@@ -165,10 +165,12 @@ public final class Bitmap implements Parcelable {
}
/**
- * Free up the memory associated with this bitmap's pixels, and mark the
- * bitmap as "dead", meaning it will throw an exception if getPixels() or
- * setPixels() is called, and will draw nothing. This operation cannot be
- * reversed, so it should only be called if you are sure there are no
+ * Free the native object associated with this bitmap, and clear the
+ * reference to the pixel data. This will not free the pixel data synchronously;
+ * it simply allows it to be garbage collected if there are no other references.
+ * The bitmap is marked as "dead", meaning it will throw an exception if
+ * getPixels() or setPixels() is called, and will draw nothing. This operation
+ * cannot be reversed, so it should only be called if you are sure there are no
* further uses for the bitmap. This is an advanced call, and normally need
* not be called, since the normal GC process will free up this memory when
* there are no more references to this bitmap.