Package-level declarations

Types

class AnimatedImageDecoder(source: ImageSource, options: Options, enforceMinimumFrameDelay: Boolean = SDK_INT < 34) : Decoder

A Decoder that uses ImageDecoder to decode GIFs, animated WebPs, and animated HEIFs.

AnimatedTransformation

@ExperimentalCoilApi

fun interface AnimatedTransformation

An interface for making transformations to an animated image's pixel data.

GifDecoder

class GifDecoder(source: ImageSource, options: Options, enforceMinimumFrameDelay: Boolean = true) : Decoder

A Decoder that uses Movie to decode GIFs.

MovieDrawable

class MovieDrawable @JvmOverloads constructor(movie: Movie, val config: Bitmap.Config = Bitmap.Config.ARGB_8888, val scale: Scale = Scale.FIT) : Drawable, Animatable2Compat

A Drawable that supports rendering Movies (i.e. GIFs).

PixelOpacity

@ExperimentalCoilApi

enum PixelOpacity : Enum<PixelOpacity>

Represents the opacity of an image's pixels after applying an AnimatedTransformation.

Properties

animatedTransformation

val Extras.Key.Companion.animatedTransformation: Extras.Key<AnimatedTransformation?>

val ImageRequest.animatedTransformation: AnimatedTransformation?

val Options.animatedTransformation: AnimatedTransformation?

animationEndCallback

val Extras.Key.Companion.animationEndCallback: Extras.Key<() -> Unit?>

val ImageRequest.animationEndCallback: () -> Unit?

val Options.animationEndCallback: () -> Unit?

animationStartCallback

val Extras.Key.Companion.animationStartCallback: Extras.Key<() -> Unit?>

val ImageRequest.animationStartCallback: () -> Unit?

val Options.animationStartCallback: () -> Unit?

repeatCount

val Extras.Key.Companion.repeatCount: Extras.Key<Int>

val ImageRequest.repeatCount: Int

val Options.repeatCount: Int

Functions

animatedTransformation

@ExperimentalCoilApi

fun ImageRequest.Builder.animatedTransformation(animatedTransformation: AnimatedTransformation?): ImageRequest.Builder

Set the AnimatedTransformation that will be applied to the result if it is an animated Drawable.

isAnimatedHeif

fun DecodeUtils.isAnimatedHeif(source: BufferedSource): Boolean

Return 'true' if the source contains an animated HEIF image sequence. The source is not consumed.

isAnimatedWebP

fun DecodeUtils.isAnimatedWebP(source: BufferedSource): Boolean

Return 'true' if the source contains an animated WebP image. The source is not consumed.

isGif

fun DecodeUtils.isGif(source: BufferedSource): Boolean

Return 'true' if the source contains a GIF image. The source is not consumed.

isHeif

fun DecodeUtils.isHeif(source: BufferedSource): Boolean

Return 'true' if the source contains an HEIF image. The source is not consumed.

isWebP

fun DecodeUtils.isWebP(source: BufferedSource): Boolean

Return 'true' if the source contains a WebP image. The source is not consumed.

onAnimationEnd

fun ImageRequest.Builder.onAnimationEnd(callback: () -> Unit?): ImageRequest.Builder

Set the callback to be invoked at the end of the animation if the result is an animated Drawable.

onAnimationStart

fun ImageRequest.Builder.onAnimationStart(callback: () -> Unit?): ImageRequest.Builder

Set the callback to be invoked at the start of the animation if the result is an animated Drawable.

repeatCount

fun ImageRequest.Builder.repeatCount(repeatCount: Int): ImageRequest.Builder

Set the number of times to repeat the animation if the result is an animated Drawable.