public class LruBitmapPool extends Object implements BitmapPool
BitmapPool implementation that uses an
LruPoolStrategy to bucket Bitmaps
and then uses an LRU eviction policy to evict Bitmaps from the least
recently used bucket in order to keep the pool below a given maximum size limit.| Constructor and Description |
|---|
LruBitmapPool(int maxSize)
Constructor for LruBitmapPool.
|
LruBitmapPool(int maxSize,
Set<Bitmap.Config> allowedConfigs)
Constructor for LruBitmapPool.
|
| Modifier and Type | Method and Description |
|---|---|
void |
clearMemory()
Removes all
Bitmaps from the pool. |
Bitmap |
get(int width,
int height,
Bitmap.Config config)
Returns a
Bitmap of exactly the given width, height, and
configuration, and containing only transparent pixels. |
Bitmap |
getDirty(int width,
int height,
Bitmap.Config config)
Identical to
BitmapPool.get(int, int, android.graphics.Bitmap.Config) except that any returned
Bitmap may not have been erased and may contain random data. |
int |
getMaxSize()
Returns the current maximum size of the pool in bytes.
|
void |
put(Bitmap bitmap)
Adds the given
Bitmap if it is eligible to be re-used and the pool
can fit it, or calls Bitmap.recycle() on the Bitmap and discards it. |
void |
setSizeMultiplier(float sizeMultiplier)
Multiplies the initial size of the pool by the given multiplier to dynamically and
synchronously allow users to adjust the size of the pool.
|
void |
trimMemory(int level)
Reduces the size of the cache by evicting items based on the given level.
|
public LruBitmapPool(int maxSize)
maxSize - The initial maximum size of the pool in bytes.public LruBitmapPool(int maxSize,
Set<Bitmap.Config> allowedConfigs)
maxSize - The initial maximum size of the pool in bytes.allowedConfigs - A white listed put of Bitmap.Config that are
allowed to be put into the pool. Configs not in the allowed put will be
rejected.public int getMaxSize()
BitmapPoolgetMaxSize in interface BitmapPoolpublic void setSizeMultiplier(float sizeMultiplier)
BitmapPool If the current total size of the pool is larger than the max size after the given
multiplier is applied, Bitmaps should be evicted until the pool is smaller than the new
max size.
setSizeMultiplier in interface BitmapPoolsizeMultiplier - The size multiplier to apply between 0 and 1.public void put(Bitmap bitmap)
BitmapPoolBitmap if it is eligible to be re-used and the pool
can fit it, or calls Bitmap.recycle() on the Bitmap and discards it.
Callers must not continue to use the Bitmap after calling this method.
put in interface BitmapPoolbitmap - The Bitmap to attempt to add.Bitmap.isMutable(),
Bitmap.recycle()@NonNull public Bitmap get(int width, int height, Bitmap.Config config)
BitmapPoolBitmap of exactly the given width, height, and
configuration, and containing only transparent pixels.
If no Bitmap with the requested attributes is present in the pool, a new one will be allocated.
Because this method erases all pixels in the Bitmap, this method is slightly slower
than BitmapPool.getDirty(int, int, android.graphics.Bitmap.Config). If the Bitmap is being obtained to be used in BitmapFactory
or in any other case where every pixel in the Bitmap will always be
overwritten or cleared, BitmapPool.getDirty(int, int, android.graphics.Bitmap.Config) will be
faster. When in doubt, use this method to ensure correctness.
Implementations can should clear out every returned Bitmap using the following:
bitmap.eraseColor(Color.TRANSPARENT);
get in interface BitmapPoolwidth - The width in pixels of the desired Bitmap.height - The height in pixels of the desired Bitmap.config - The Bitmap.Config of the desired Bitmap.BitmapPool.getDirty(int, int, android.graphics.Bitmap.Config)@NonNull public Bitmap getDirty(int width, int height, Bitmap.Config config)
BitmapPoolBitmapPool.get(int, int, android.graphics.Bitmap.Config) except that any returned
Bitmap may not have been erased and may contain random data.
If no Bitmap with the requested attributes is present in the pool, a new one will be allocated.
Although this method is slightly more efficient than BitmapPool.get(int, int,
android.graphics.Bitmap.Config) it should be used with caution and only when the caller is
sure that they are going to erase the Bitmap entirely before writing
new data to it.
getDirty in interface BitmapPoolwidth - The width in pixels of the desired Bitmap.height - The height in pixels of the desired Bitmap.config - The Bitmap.Config of the desired Bitmap.Bitmap with exactly the given width, height, and config
potentially containing random image data or null if no such Bitmap
could be obtained from the pool.BitmapPool.get(int, int, android.graphics.Bitmap.Config)public void clearMemory()
BitmapPoolBitmaps from the pool.clearMemory in interface BitmapPoolpublic void trimMemory(int level)
BitmapPooltrimMemory in interface BitmapPoollevel - The level from ComponentCallbacks2 to use to determine how
many Bitmaps to evict.ComponentCallbacks2