From 64ad7d61507070bb0afa67b9b65de793ed19f0a1 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 16 Dec 2023 09:03:19 +0000 Subject: [PATCH] Deployed f7c7cdff9 with MkDocs version: 1.5.3 --- .../remember-async-image-painter.html | 2 +- sitemap.xml.gz | Bin 394 -> 394 bytes 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/api/coil-compose-base/coil.compose/remember-async-image-painter.html b/api/coil-compose-base/coil.compose/remember-async-image-painter.html index a3fff1f1c0..8d3da612b3 100644 --- a/api/coil-compose-base/coil.compose/remember-async-image-painter.html +++ b/api/coil-compose-base/coil.compose/remember-async-image-painter.html @@ -63,7 +63,7 @@

rememberAsyncImagePainter

-
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.

** This is a lower-level API than AsyncImage and may not work as expected in all situations. **

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.


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.

** This is a lower-level API than AsyncImage and may not work as expected in all situations. **

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.

+
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.

** This is a lower-level API than AsyncImage and may not work as expected in all situations. **

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.


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.

** This is a lower-level API than AsyncImage and may not work as expected in all situations. **

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.