coil-compose-core/coil3.compose/rememberAsyncImagePainter

rememberAsyncImagePainter

@Composable
fun rememberAsyncImagePainter(model: Any?, imageLoader: ImageLoader, placeholder: Painter? = null, error: Painter? = null, fallback: Painter? = error, onLoading: (AsyncImagePainter.State.Loading) -> Unit? = null, onSuccess: (AsyncImagePainter.State.Success) -> Unit? = null, onError: (AsyncImagePainter.State.Error) -> Unit? = null, contentScale: ContentScale = ContentScale.Fit, filterQuality: FilterQuality = DefaultFilterQuality): AsyncImagePainter

Return an AsyncImagePainter that executes an ImageRequest asynchronously and renders the result.

Parameters

model

Either an ImageRequest or the ImageRequest.data value.

imageLoader

The ImageLoader that will be used to execute the request.

placeholder

A Painter that is displayed while the image is loading.

error

A Painter that is displayed when the image request is unsuccessful.

fallback

A Painter that is displayed when the request's ImageRequest.data is null.

onLoading

Called when the image request begins loading.

onSuccess

Called when the image request completes successfully.

onError

Called when the image request completes unsuccessfully.

contentScale

Used to determine the aspect ratio scaling to be used if the canvas bounds are a different size from the intrinsic size of the image loaded by model. This should be set to the same value that's passed to Image.

filterQuality

Sampling algorithm applied to a bitmap when it is scaled and drawn into the destination.

@Composable
fun rememberAsyncImagePainter(model: Any?, imageLoader: ImageLoader, transform: (AsyncImagePainter.State) -> AsyncImagePainter.State = DefaultTransform, onState: (AsyncImagePainter.State) -> Unit? = null, contentScale: ContentScale = ContentScale.Fit, filterQuality: FilterQuality = DefaultFilterQuality): AsyncImagePainter

Return an AsyncImagePainter that executes an ImageRequest asynchronously and renders the result.

Parameters

model

Either an ImageRequest or the ImageRequest.data value.

imageLoader

The ImageLoader that will be used to execute the request.

transform

A callback to transform a new State before it's applied to the AsyncImagePainter. Typically this is used to overwrite the state's Painter.

onState

Called when the state of this painter changes.

contentScale

Used to determine the aspect ratio scaling to be used if the canvas bounds are a different size from the intrinsic size of the image loaded by model. This should be set to the same value that's passed to Image.

filterQuality

Sampling algorithm applied to a bitmap when it is scaled and drawn into the destination.