Package-level declarations

Types

class AssetMetadata(val filePath: String) : ImageSource.Metadata

Metadata containing the filePath of an Android asset.

class BitmapFactoryDecoder(source: ImageSource, options: Options, parallelismLock: Semaphore = Semaphore(Int.MAX_VALUE), exifOrientationStrategy: ExifOrientationStrategy = RESPECT_PERFORMANCE) : Decoder

The base Decoder that uses BitmapFactory to decode a given ImageSource.

BlackholeDecoder

@ExperimentalCoilApi

class BlackholeDecoder(imageFactory: () -> Image) : Decoder

A Decoder that ignores the SourceFetchResult and always returns the Image returned by imageFactory.

ByteBufferMetadata

@ExperimentalCoilApi

class ByteBufferMetadata(val byteBuffer: ByteBuffer) : ImageSource.Metadata

Metadata containing the underlying ByteBuffer of the ImageSource.

ContentMetadata

class ContentMetadata(val uri: Uri, val assetFileDescriptor: AssetFileDescriptor) : ImageSource.Metadata

Metadata containing the uri and associated assetFileDescriptor of a content URI.

DataSource

enum DataSource : Enum<DataSource>

Represents the source that an image was loaded from.

Decoder

fun interface Decoder

A Decoder converts a SourceFetchResult into a DecodeResult.

DecodeResult

@Poko

class DecodeResult(val image: Image, val isSampled: Boolean)

The result of Decoder.decode.

DecodeUtils

object DecodeUtils

A collection of useful utility methods for decoding images.

ExifOrientationStrategy

fun interface ExifOrientationStrategy

Specifies the strategy for handling the EXIF orientation flag.

ImageSource

sealed interface ImageSource : AutoCloseable

Provides access to the image data to be decoded.

ResourceMetadata

class ResourceMetadata(val packageName: String, @DrawableRes val resId: Int, val density: Int) : ImageSource.Metadata

Metadata containing the packageName, resId, and density of an Android resource.

SkiaImageDecoder

class SkiaImageDecoder(source: ImageSource, options: Options) : Decoder

StaticImageDecoder

@RequiresApi(value = 29)

class StaticImageDecoder(source: ImageDecoder.Source, closeable: AutoCloseable, options: Options, parallelismLock: Semaphore) : Decoder

Functions

ImageSource

fun ImageSource(source: BufferedSource, fileSystem: FileSystem, metadata: ImageSource.Metadata? = null): ImageSource

Create a new ImageSource backed by a BufferedSource.

fun ImageSource(file: Path, fileSystem: FileSystem, diskCacheKey: String? = null, closeable: AutoCloseable? = null, metadata: ImageSource.Metadata? = null): ImageSource

Create a new ImageSource backed by a Path.

toImageDecoderSourceOrNull

@InternalCoilApi

@RequiresApi(value = 28)

fun ImageSource.toImageDecoderSourceOrNull(options: Options, animated: Boolean): ImageDecoder.Source?