CircularRevealedImage

@Composable()

fun CircularRevealedImage(bitmap: ImageBitmap, modifier: Modifier = Modifier, bitmapPainter: Painter = BitmapPainter(bitmap), alignment: Alignment = Alignment.Center, contentScale: ContentScale = ContentScale.Crop, contentDescription: String?, alpha: Float = DefaultAlpha, colorFilter: ColorFilter? = null, circularRevealedEnabled: Boolean = false, circularRevealedDuration: Int = DefaultCircularRevealedDuration)

CircularRevealedImage is an image composable for animating a clipping circle to reveal when loading an image.

Parameters

bitmap

an image bitmap for loading for the content.

modifier

adjust the drawing image layout or drawing decoration of the content.

bitmapPainter

an image painter to draw an BitmapPainter into the provided canvas.

alignment

alignment parameter used to place the loaded ImageBitmap in the given bounds defined by the width and height.

contentScale

parameter used to determine the aspect ratio scaling to be used if the bounds are a different size from the intrinsic size of the loaded ImageBitmap.

contentDescription

The content description used to provide accessibility to describe the image.

alpha

an alpha value to apply for the image when it is rendered onscreen.

colorFilter

colorFilter to apply for the image when it is rendered onscreen.

circularRevealedEnabled

a conditional value for enabling or not the circular revealing animation.

circularRevealedDuration

milli-second times from start to finish animation.