coil-core/coil3.request

Package-level declarations

Types

Link copied to clipboard
enum CachePolicy : Enum<CachePolicy>

Represents the read/write policy for a cache source.

Link copied to clipboard
interface Disposable

Represents the work of an ImageRequest that has been executed by an ImageLoader.

Link copied to clipboard
@Poko
class ErrorResult(val image: Image?, val request: ImageRequest, val throwable: Throwable) : ImageResult

Indicates that an error occurred while executing the request.

Link copied to clipboard
@Poko
class ImageRequest

An immutable value object that represents a request for an image.

Link copied to clipboard
sealed interface ImageResult

Represents the result of an executed ImageRequest.

Link copied to clipboard
data object NullRequestData

The value for ImageRequest.data if the request's data was not set or was set to null.

Link copied to clipboard
class NullRequestDataException : RuntimeException

Exception thrown when an ImageRequest with empty/null data is executed by an ImageLoader.

Link copied to clipboard
@Poko
class Options(val context: PlatformContext, val size: Size = Size.ORIGINAL, val scale: Scale = Scale.FIT, val precision: Precision = Precision.EXACT, val diskCacheKey: String? = null, val fileSystem: FileSystem = defaultFileSystem(), val memoryCachePolicy: CachePolicy = CachePolicy.ENABLED, val diskCachePolicy: CachePolicy = CachePolicy.ENABLED, val networkCachePolicy: CachePolicy = CachePolicy.ENABLED, val extras: Extras = Extras.EMPTY)

A set of configuration options for fetching and decoding an image.

Link copied to clipboard
@Poko
class SuccessResult(val image: Image, val request: ImageRequest, val dataSource: DataSource = DataSource.MEMORY, val memoryCacheKey: MemoryCache.Key? = null, val diskCacheKey: String? = null, val isSampled: Boolean = false, val isPlaceholderCached: Boolean = false) : ImageResult

Indicates that the request completed successfully.

Properties

Link copied to clipboard
Link copied to clipboard
val <Error class: unknown class>.allowConversionToBitmap: <Error class: unknown class><Boolean>
val <Error class: unknown class>.allowConversionToBitmap: Boolean
val <Error class: unknown class>.allowConversionToBitmap: Boolean
Link copied to clipboard
val <Error class: unknown class>.allowHardware: <Error class: unknown class><Boolean>
val <Error class: unknown class>.allowHardware: Boolean
val <Error class: unknown class>.allowHardware: Boolean
Link copied to clipboard
val <Error class: unknown class>.allowRgb565: <Error class: unknown class><Boolean>
val <Error class: unknown class>.allowRgb565: Boolean
val <Error class: unknown class>.allowRgb565: Boolean
Link copied to clipboard
val <Error class: unknown class>.bitmapConfig: <Error class: unknown class><Bitmap.Config>
val <Error class: unknown class>.bitmapConfig: Bitmap.Config
val <Error class: unknown class>.bitmapConfig: Bitmap.Config
Link copied to clipboard
@get:RequiresApi(value = 26)
val <Error class: unknown class>.colorSpace: <Error class: unknown class><ColorSpace?>
@get:RequiresApi(value = 26)
val <Error class: unknown class>.colorSpace: ColorSpace?
@get:RequiresApi(value = 26)
val <Error class: unknown class>.colorSpace: ColorSpace?
Link copied to clipboard
expect val ImageRequest.crossfadeMillis: Int
actual val ImageRequest.crossfadeMillis: Int
Link copied to clipboard
val <Error class: unknown class>.lifecycle: <Error class: unknown class><Lifecycle?>
val <Error class: unknown class>.lifecycle: Lifecycle?
val <Error class: unknown class>.lifecycle: Lifecycle?
Link copied to clipboard
Link copied to clipboard
val <Error class: unknown class>.premultipliedAlpha: <Error class: unknown class><Boolean>
val <Error class: unknown class>.premultipliedAlpha: Boolean
val <Error class: unknown class>.premultipliedAlpha: Boolean
Link copied to clipboard
val <Error class: unknown class>.transformations: <Error class: unknown class><List<Transformation>>
val <Error class: unknown class>.transformations: List<Transformation>
val <Error class: unknown class>.transformations: List<Transformation>
Link copied to clipboard
val <Error class: unknown class>.transitionFactory: <Error class: unknown class><Transition.Factory>
val <Error class: unknown class>.transitionFactory: Transition.Factory

Functions

Link copied to clipboard
fun ImageLoader.Builder.addLastModifiedToFileCacheKey(enable: Boolean): ImageLoader.Builder

fun ImageRequest.Builder.addLastModifiedToFileCacheKey(enable: Boolean): ImageRequest.Builder

Enables adding a file's last modified timestamp to the memory cache key when loading an image from a file.

Link copied to clipboard
fun <Error class: unknown class>.allowConversionToBitmap(enable: Boolean): <Error class: unknown class>

fun <Error class: unknown class>.allowConversionToBitmap(enable: Boolean): <Error class: unknown class>

Allow converting the result drawable to a bitmap to apply any transformations.

Link copied to clipboard
fun <Error class: unknown class>.allowHardware(enable: Boolean): <Error class: unknown class>

fun <Error class: unknown class>.allowHardware(enable: Boolean): <Error class: unknown class>

Allow the use of Bitmap.Config.HARDWARE.

Link copied to clipboard
fun <Error class: unknown class>.allowRgb565(enable: Boolean): <Error class: unknown class>

fun <Error class: unknown class>.allowRgb565(enable: Boolean): <Error class: unknown class>

Allow automatically using Bitmap.Config.RGB_565 when an image is guaranteed to not have alpha.

Link copied to clipboard
fun <Error class: unknown class>.bitmapConfig(config: Bitmap.Config): <Error class: unknown class>

fun <Error class: unknown class>.bitmapConfig(config: Bitmap.Config): <Error class: unknown class>

Set the preferred Bitmap.Config.

Link copied to clipboard
@RequiresApi(value = 26)
fun <Error class: unknown class>.colorSpace(colorSpace: ColorSpace): <Error class: unknown class>

@RequiresApi(value = 26)
fun <Error class: unknown class>.colorSpace(colorSpace: ColorSpace): <Error class: unknown class>

Set the preferred ColorSpace.

Link copied to clipboard
fun ImageLoader.Builder.crossfade(enable: Boolean): ImageLoader.Builder
expect fun ImageLoader.Builder.crossfade(durationMillis: Int): ImageLoader.Builder
expect fun ImageRequest.Builder.crossfade(durationMillis: Int): ImageRequest.Builder

fun ImageRequest.Builder.crossfade(enable: Boolean): ImageRequest.Builder

Enable a crossfade animation when a request completes successfully.

actual fun ImageLoader.Builder.crossfade(durationMillis: Int): ImageLoader.Builder

actual fun ImageRequest.Builder.crossfade(durationMillis: Int): ImageRequest.Builder

Enable a crossfade animation when a request completes successfully.

Link copied to clipboard
fun <Error class: unknown class>.error(drawable: Drawable?): <Error class: unknown class>
fun <Error class: unknown class>.error(@DrawableRes drawableResId: Int): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class>.fallback(drawable: Drawable?): <Error class: unknown class>
fun <Error class: unknown class>.fallback(@DrawableRes drawableResId: Int): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class>.lifecycle(lifecycle: Lifecycle?): <Error class: unknown class>

fun <Error class: unknown class>.lifecycle(owner: LifecycleOwner?): <Error class: unknown class>

Set the Lifecycle for this request.

Link copied to clipboard
fun ImageLoader.Builder.maxBitmapSize(size: Size): ImageLoader.Builder

fun ImageRequest.Builder.maxBitmapSize(size: Size): ImageRequest.Builder

Set the maximum width and height for a bitmap.

Link copied to clipboard
fun <Error class: unknown class>.placeholder(drawable: Drawable?): <Error class: unknown class>
fun <Error class: unknown class>.placeholder(@DrawableRes drawableResId: Int): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class>.premultipliedAlpha(enable: Boolean): <Error class: unknown class>

fun <Error class: unknown class>.premultipliedAlpha(enable: Boolean): <Error class: unknown class>

Enable/disable pre-multiplication of the color (RGB) channels of the decoded image by the alpha channel.

Link copied to clipboard
fun <Error class: unknown class>.target(imageView: ImageView): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class>.transformations(vararg transformations: Transformation): <Error class: unknown class>

Set Transformations to be applied to the output image.

fun <Error class: unknown class>.transformations(transformations: List<Transformation>): <Error class: unknown class>
Link copied to clipboard
fun <Error class: unknown class>.transitionFactory(factory: Transition.Factory): <Error class: unknown class>

fun <Error class: unknown class>.transitionFactory(factory: Transition.Factory): <Error class: unknown class>

Set the Transition.Factory that's started when an image result is applied to a target.