public interface

PlatformDecoder

com.facebook.imagepipeline.platform.PlatformDecoder
Known Indirect Subclasses

Summary

Public Methods
abstract CloseableReference<Bitmap> decodeFromEncodedImage(EncodedImage encodedImage, Bitmap.Config bitmapConfig, Rect regionToDecode)
Creates a bitmap from encoded bytes.
abstract CloseableReference<Bitmap> decodeFromEncodedImageWithColorSpace(EncodedImage encodedImage, Bitmap.Config bitmapConfig, Rect regionToDecode, ColorSpace colorSpace)
Creates a bitmap from encoded bytes.
abstract CloseableReference<Bitmap> decodeJPEGFromEncodedImage(EncodedImage encodedImage, Bitmap.Config bitmapConfig, Rect regionToDecode, int length)
Creates a bitmap from encoded JPEG bytes.
abstract CloseableReference<Bitmap> decodeJPEGFromEncodedImageWithColorSpace(EncodedImage encodedImage, Bitmap.Config bitmapConfig, Rect regionToDecode, int length, ColorSpace colorSpace)
Creates a bitmap from encoded JPEG bytes.

Public Methods

public abstract CloseableReference<Bitmap> decodeFromEncodedImage (EncodedImage encodedImage, Bitmap.Config bitmapConfig, Rect regionToDecode)

Creates a bitmap from encoded bytes. Supports JPEG but callers should use decodeJPEGFromEncodedImage(EncodedImage, Bitmap.Config, Rect, int) for partial JPEGs. In addition, a region to decode can be supplied in order to minimize memory usage. NOTE: Not all platform decoders necessarily support supplying specific regions.

Note: This needs to be kept because of dependencies issues.

Parameters
encodedImage the reference to the encoded image with the reference to the encoded bytes
bitmapConfig the android.graphics.Bitmap.Config used to create the decoded Bitmap
regionToDecode optional image region to decode or null to decode the whole image
Returns
  • the bitmap
Throws
if the pool is full
OutOfMemoryError if the Bitmap cannot be allocated

public abstract CloseableReference<Bitmap> decodeFromEncodedImageWithColorSpace (EncodedImage encodedImage, Bitmap.Config bitmapConfig, Rect regionToDecode, ColorSpace colorSpace)

Creates a bitmap from encoded bytes. Supports JPEG but callers should use decodeJPEGFromEncodedImage(EncodedImage, Bitmap.Config, Rect, int) for partial JPEGs. In addition, a region to decode can be supplied in order to minimize memory usage. NOTE: Not all platform decoders necessarily support supplying specific regions.

Parameters
encodedImage the reference to the encoded image with the reference to the encoded bytes
bitmapConfig the android.graphics.Bitmap.Config used to create the decoded Bitmap
regionToDecode optional image region to decode or null to decode the whole image
colorSpace the target color space of the decoded bitmap, must be one of the named color space in android.graphics.ColorSpace.Named. If null, then SRGB color space is assumed if the SDK version >= 26.
Returns
  • the bitmap
Throws
if the pool is full
OutOfMemoryError if the Bitmap cannot be allocated

public abstract CloseableReference<Bitmap> decodeJPEGFromEncodedImage (EncodedImage encodedImage, Bitmap.Config bitmapConfig, Rect regionToDecode, int length)

Creates a bitmap from encoded JPEG bytes. Supports a partial JPEG image. In addition, a region to decode can be supplied in order to minimize memory usage. NOTE: Not all platform decoders necessarily support supplying specific regions.

Note: This needs to be kept because of dependencies issues.

Parameters
encodedImage the reference to the encoded image with the reference to the encoded bytes
bitmapConfig the android.graphics.Bitmap.Config used to create the decoded Bitmap
regionToDecode optional image region to decode or null to decode the whole image.
length the number of encoded bytes in the buffer
Returns
  • the bitmap
Throws
if the pool is full
OutOfMemoryError if the Bitmap cannot be allocated

public abstract CloseableReference<Bitmap> decodeJPEGFromEncodedImageWithColorSpace (EncodedImage encodedImage, Bitmap.Config bitmapConfig, Rect regionToDecode, int length, ColorSpace colorSpace)

Creates a bitmap from encoded JPEG bytes. Supports a partial JPEG image. In addition, a region to decode can be supplied in order to minimize memory usage. NOTE: Not all platform decoders necessarily support supplying specific regions.

Parameters
encodedImage the reference to the encoded image with the reference to the encoded bytes
bitmapConfig the android.graphics.Bitmap.Config used to create the decoded Bitmap
regionToDecode optional image region to decode or null to decode the whole image.
length the number of encoded bytes in the buffer
colorSpace the target color space of the decoded bitmap, must be one of the named color space in android.graphics.ColorSpace.Named. If null, then SRGB color space is assumed if the SDK version >= 26.
Returns
  • the bitmap
Throws
if the pool is full
OutOfMemoryError if the Bitmap cannot be allocated