A service class that loads images by executing ImageRequests. Image loaders handle caching, data fetching, image decoding, request management, memory management, and more.

PlatformContext

actual typealias PlatformContext = Context

typealias PlatformContext = Context

Represents a platform-specific context that acts as an interface to global information about an application environment.

expect abstract class PlatformContext

Represents a platform-specific context that acts as an interface to global information about an application environment.

actual abstract class PlatformContext

Represents a platform-specific context that acts as an interface to global information about an application environment.

Uri

class Uri

A uniform resource locator. See RFC 3986.

Properties

filePath

val Uri.filePath: String?

Returns the URI's Uri.path formatted according to the URI's native Uri.separator.

pathSegments

val Uri.pathSegments: List<String>

Return the separate segments of the Uri.path.

Functions

asDrawable

fun Image.asDrawable(resources: Resources): Drawable

asImage

fun Drawable.asImage(): Image

fun Drawable.asImage(shareable: Boolean): Image

@JvmOverloads

actual fun Bitmap.asImage(shareable: Boolean): BitmapImage

Convert a Bitmap into an Image.

@JvmOverloads

expect fun Bitmap.asImage(shareable: Boolean = true): BitmapImage

Convert a Bitmap into an Image.

@JvmOverloads

actual fun Bitmap.asImage(shareable: Boolean): BitmapImage

Convert a Bitmap into an Image.

bitmapFactoryExifOrientationStrategy

fun ImageLoader.Builder.bitmapFactoryExifOrientationStrategy(strategy: ExifOrientationStrategy): ImageLoader.Builder

Sets the strategy for handling the EXIF orientation flag for images decoded by BitmapFactoryDecoder.

bitmapFactoryMaxParallelism

fun ImageLoader.Builder.bitmapFactoryMaxParallelism(maxParallelism: Int): ImageLoader.Builder

Sets the maximum number of parallel BitmapFactory or ImageDecoder decode operations at once.

executeBlocking

@WorkerThread

fun ImageLoader.executeBlocking(request: ImageRequest): ImageResult

Execute the request and block the current thread until it completes.

getExtra

fun <T> ImageRequest.getExtra(key: Extras.Key<T>): T

fun <T> Options.getExtra(key: Extras.Key<T>): T

getOrDefault

fun <T> Extras.getOrDefault(key: Extras.Key<T>): T

imageDecoderEnabled

fun ImageLoader.Builder.imageDecoderEnabled(enabled: Boolean): ImageLoader.Builder

Enables using ImageDecoder as this image loader's main Decoder on API 29 and above. If false, BitmapFactory is used on all API levels.

ImageLoader

fun ImageLoader(context: PlatformContext): ImageLoader

Create a new ImageLoader without configuration.

memoryCacheMaxSizePercentWhileInBackground

@ExperimentalCoilApi

fun ImageLoader.Builder.memoryCacheMaxSizePercentWhileInBackground(percent: Double): ImageLoader.Builder

Reduces the memory cache's MemoryCache.maxSize to a percent of MemoryCache.initialMaxSize while the app is in the background (i.e. while its process lifecycle state is not at least Lifecycle.State.STARTED).

orEmpty

fun Extras?.orEmpty(): Extras

plus

operator fun Extras.plus(other: Extras): Extras

serviceLoaderEnabled

fun ImageLoader.Builder.serviceLoaderEnabled(enable: Boolean): ImageLoader.Builder

Enables adding all components (fetchers and decoders) that are supported by the service locator to this ImageLoader's ComponentRegistry. All of Coil's first party decoders and fetchers are supported.

toAndroidUri

fun Uri.toAndroidUri(): Uri

toBitmap

@JvmOverloads

actual fun Image.toBitmap(width: Int, height: Int): Bitmap

Convert an Image into a Bitmap.

fun Image.toBitmap(width: Int, height: Int, config: Bitmap.Config): Bitmap

@JvmOverloads

expect fun Image.toBitmap(width: Int = this.width, height: Int = this.height): Bitmap

Convert an Image into a Bitmap.

@JvmOverloads

actual fun Image.toBitmap(width: Int, height: Int): Bitmap

Convert an Image into a Bitmap.

fun Image.toBitmap(width: Int, height: Int, colorType: ColorType, colorAlphaType: ColorAlphaType, colorSpace: ColorSpace?): Bitmap

toCoilUri

fun Uri.toCoilUri(): Uri

toUri

@JvmOverloads

fun String.toUri(separator: String = Path.DIRECTORY_SEPARATOR): Uri

Parse this String into a Uri. This method will not throw if the URI is malformed.

Uri

fun Uri(scheme: String? = null, authority: String? = null, path: String? = null, query: String? = null, fragment: String? = null, separator: String = Path.DIRECTORY_SEPARATOR): Uri

Create a Uri from parts without parsing.