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

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

Uri

class Uri

A uniform resource locator (https://www.w3.org/Addressing/URL/url-spec.html).

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 <Error class: unknown class>.asDrawable(resources: Resources): Drawable

asImage

fun Drawable.asImage(): <Error class: unknown class>

fun Drawable.asImage(shareable: Boolean): <Error class: unknown class>

@JvmOverloads

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

Convert a Bitmap into an Image.

bitmapFactoryExifOrientationStrategy

fun <Error class: unknown class>.bitmapFactoryExifOrientationStrategy(strategy: ExifOrientationStrategy): <Error class: unknown class>

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

bitmapFactoryMaxParallelism

fun <Error class: unknown class>.bitmapFactoryMaxParallelism(maxParallelism: Int): <Error class: unknown class>

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

ImageLoader

fun ImageLoader(context: PlatformContext): ImageLoader

Create a new ImageLoader without configuration.

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 <Error class: unknown class>.toAndroidUri(): Uri

toBitmap

fun <Error class: unknown class>.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

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

toCoilUri

fun Uri.toCoilUri(): <Error class: unknown class>

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.