package me.xiaopan.sketch.cache;
import android.graphics.Bitmap;
import me.xiaopan.sketch.Identifier;
/**
* Bitmap缓存池，用于缓存Bitmap，便于解码时直接利用，减少内存分配
*/
public interface BitmapPool extends Identifier {
/**
* Get max size
*/
int getMaxSize();
/**
* Get use size
*/
int getSize();
/**
* Multiplies the initial size of the pool by the given multipler to dynamically and synchronously allow users to
* adjust the size of the pool.
* <p>
* If the current total size of the pool is larger than the max size after the given multiplier is applied,
* {@link Bitmap}s should be evicted until the pool is smaller than the new max size.
*
* @param sizeMultiplier The size multiplier to apply between 0 and 1.
*/
@SuppressWarnings("unused")
void setSizeMultiplier(float sizeMultiplier);
/**
* Adds the given {@link android.graphics.Bitmap} and returns {@code true} if the {@link android.graphics.Bitmap}
* was eligible to be added and {@code false} otherwise.
* <p>
* <p>
* Note - If the {@link android.graphics.Bitmap} is rejected (this method returns false) then it is the caller's
* responsibility to call {@link android.graphics.Bitmap#recycle()}.
* </p>
* <p>
* <p>
* Note - This method will return {@code true} if the given {@link android.graphics.Bitmap} is synchronously
* evicted after being accepted. The only time this method will return {@code false} is if the
* {@link android.graphics.Bitmap} is not eligible to be added to the pool (either it is not mutable or it is
* larger than the max pool size).
* </p>
*
* @param bitmap The {@link android.graphics.Bitmap} to attempt to add.
* @see android.graphics.Bitmap#isMutable()
* @see android.graphics.Bitmap#recycle()
*/
boolean put(Bitmap bitmap);
/**
* Identical to {@link #get(int, int, android.graphics.Bitmap.Config)} except that any returned non-null
* {@link android.graphics.Bitmap} may <em>not</em> have been erased and may contain random data.
* <p>
* <p>
* Although this method is slightly more efficient than {@link #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
* {@link android.graphics.Bitmap} entirely before writing new data to it.
* </p>
*
* @param width The width in pixels of the desired {@link android.graphics.Bitmap}.
* @param height The height in pixels of the desired {@link android.graphics.Bitmap}.
* @param config The {@link android.graphics.Bitmap.Config} of the desired {@link android.graphics.Bitmap}.
* @return A {@link android.graphics.Bitmap} with exactly the given width, height, and config potentially containing
* random image data or null if no such {@link android.graphics.Bitmap} could be obtained from the pool.
* @see #get(int, int, android.graphics.Bitmap.Config)
*/
Bitmap getDirty(int width, int height, Bitmap.Config config);
/**
* Returns a {@link android.graphics.Bitmap} of exactly the given width, height, and configuration, and containing
* only transparent pixels or null if no such {@link android.graphics.Bitmap} could be obtained from the pool.
* <p>
* <p>
* Because this method erases all pixels in the {@link Bitmap}, this method is slightly slower than
* {@link #getDirty(int, int, android.graphics.Bitmap.Config)}. If the {@link android.graphics.Bitmap} is being
* obtained to be used in {@link android.graphics.BitmapFactory} or in any other case where every pixel in the
* {@link android.graphics.Bitmap} will always be overwritten or cleared,
* {@link #getDirty(int, int, android.graphics.Bitmap.Config)} will be faster. When in doubt, use this method
* to ensure correctness.
* </p>
* <p>
* <pre>
* Implementations can should clear out every returned Bitmap using the following:
*
* {@code
* bitmap.eraseColor(Color.TRANSPARENT);
* }
* </pre>
*
* @param width The width in pixels of the desired {@link android.graphics.Bitmap}.
* @param height The height in pixels of the desired {@link android.graphics.Bitmap}.
* @param config The {@link android.graphics.Bitmap.Config} of the desired {@link android.graphics.Bitmap}.
* @see #getDirty(int, int, android.graphics.Bitmap.Config)
*/
Bitmap get(int width, int height, Bitmap.Config config);
/**
* Returns a {@link android.graphics.Bitmap} of exactly the given width, height, and configuration, and containing
* only transparent pixels or null if no such {@link android.graphics.Bitmap} could be obtained from the pool.
* <p>
* <p>
* Because this method erases all pixels in the {@link Bitmap}, this method is slightly slower than
* {@link #getDirty(int, int, android.graphics.Bitmap.Config)}. If the {@link android.graphics.Bitmap} is being
* obtained to be used in {@link android.graphics.BitmapFactory} or in any other case where every pixel in the
* {@link android.graphics.Bitmap} will always be overwritten or cleared,
* {@link #getDirty(int, int, android.graphics.Bitmap.Config)} will be faster. When in doubt, use this method
* to ensure correctness.
* </p>
* <p>
* <pre>
* Implementations can should clear out every returned Bitmap using the following:
*
* {@code
* bitmap.eraseColor(Color.TRANSPARENT);
* }
* </pre>
* <p>
* If you can not find reusable to create a new bitmap
*
* @param width The width in pixels of the desired {@link android.graphics.Bitmap}.
* @param height The height in pixels of the desired {@link android.graphics.Bitmap}.
* @param config The {@link android.graphics.Bitmap.Config} of the desired {@link android.graphics.Bitmap}.
* @see #getDirty(int, int, android.graphics.Bitmap.Config)
*/
Bitmap getOrMake(int width, int height, Bitmap.Config config);
/**
* Disabled?
*/
@SuppressWarnings("unused")
boolean isDisabled();
/**
* Setup disabled
*
* @param disabled nonuse
*/
void setDisabled(boolean disabled);
/**
* Clean all
*/
void clear();
/**
* Trim memory
*
* @param level The context of the trim, giving a hint of the amount of
* trimming the application may like to perform. May be
* {@link android.content.ComponentCallbacks2#TRIM_MEMORY_COMPLETE}, {@link android.content.ComponentCallbacks2#TRIM_MEMORY_MODERATE},
* {@link android.content.ComponentCallbacks2#TRIM_MEMORY_BACKGROUND}, {@link android.content.ComponentCallbacks2#TRIM_MEMORY_UI_HIDDEN},
* {@link android.content.ComponentCallbacks2#TRIM_MEMORY_RUNNING_CRITICAL}, {@link android.content.ComponentCallbacks2#TRIM_MEMORY_RUNNING_LOW},
* or {@link android.content.ComponentCallbacks2#TRIM_MEMORY_RUNNING_MODERATE}.
*/
void trimMemory(int level);
/**
* Closed
*/
@SuppressWarnings("unused")
boolean isClosed();
/**
* Close
*/
void close();
}