Package coil.decode

Types

AssetMetadata

@ExperimentalCoilApi()

class AssetMetadata(fileName: String) : ImageSource.Metadata

Metadata containing the fileName of an Android asset.

BitmapFactoryDecoder

class BitmapFactoryDecoder(source: ImageSource, options: Options, parallelismLock: Semaphore, exifOrientationPolicy: ExifOrientationPolicy) : Decoder

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

ContentMetadata

@ExperimentalCoilApi()

class ContentMetadata(uri: Uri) : ImageSource.Metadata

Metadata containing the uri of a content URI.

DataSource

enum DataSource : Enum<DataSource>

Represents the source that an image was loaded from.

Decoder

fun fun interface Decoder

A Decoder converts a SourceResult into a Drawable.

DecodeResult

class DecodeResult(drawable: Drawable, isSampled: Boolean)

The result of Decoder.decode.

DecodeUtils

object DecodeUtils

A collection of useful utility methods for decoding images.

ExifOrientationPolicy

enum ExifOrientationPolicy : Enum<ExifOrientationPolicy>

Specifies the policy for handling the EXIF orientation flag.

ImageSource

sealed class ImageSource : Closeable

Provides access to the image data to be decoded.

ResourceMetadata

@ExperimentalCoilApi()

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

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

Functions

ImageSource

@JvmName(name = create)

fun ImageSource(source: BufferedSource, context: Context): ImageSource

Create a new ImageSource backed by a BufferedSource.

@JvmName(name = create)

fun ImageSource(source: BufferedSource, cacheDirectory: File): ImageSource

Create a new ImageSource backed by a BufferedSource.

@ExperimentalCoilApi()

@JvmName(name = create)

fun ImageSource(source: BufferedSource, context: Context, metadata: ImageSource.Metadata? = null): ImageSource

Create a new ImageSource backed by a BufferedSource.

@ExperimentalCoilApi()

@JvmName(name = create)

fun ImageSource(source: BufferedSource, cacheDirectory: File, metadata: ImageSource.Metadata? = null): ImageSource

Create a new ImageSource backed by a BufferedSource.

@JvmName(name = create)

fun ImageSource(file: Path, fileSystem: FileSystem = FileSystem.SYSTEM, diskCacheKey: String? = null, closeable: Closeable? = null): ImageSource

Create a new ImageSource backed by a File.

@ExperimentalCoilApi()

@JvmName(name = create)

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

Create a new ImageSource backed by a File.