Jetpack Compose Image in Foundation

A composable that lays out and draws a given ImageBitmap. This will attempt to size the composable according to the ImageBitmap's given width and height. However, an optional Modifier parameter can be provided to adjust sizing or draw additional content (ex. background). Any unspecified dimension will leverage the ImageBitmap's size as a minimum constraint.

The following sample shows basic usage of an Image composable to position and draw an ImageBitmap on screen

Overloads

Image

@Composable
@Deprecated(
    "Consider usage of the Image composable that consumes an optional FilterQuality parameter",
    level = DeprecationLevel.HIDDEN,
    replaceWith = ReplaceWith(
        expression = "Image(bitmap, contentDescription, modifier, alignment, contentScale, " +
            "alpha, colorFilter, DefaultFilterQuality)",
        "androidx.compose.foundation",
        "androidx.compose.ui.graphics.DefaultAlpha",
        "androidx.compose.ui.Alignment",
        "androidx.compose.ui.graphics.drawscope.DrawScope.Companion.DefaultFilterQuality",
        "androidx.compose.ui.layout.ContentScale.Fit"
    )
)
@NonRestartableComposable
fun Image(
    bitmap: ImageBitmap,
    contentDescription: String?,
    modifier: Modifier = Modifier,
    alignment: Alignment = Alignment.Center,
    contentScale: ContentScale = ContentScale.Fit,
    alpha: Float = DefaultAlpha,
    colorFilter: ColorFilter? = null
)

Parameters

Name	Description
`bitmap`	The ImageBitmap to draw
`contentDescription`	text used by accessibility services to describe what this image represents. This should always be provided unless this image is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using androidx.compose.ui.res.stringResource or similar
`modifier`	Modifier used to adjust the layout algorithm or draw decoration content (ex. background)
`alignment`	Optional alignment parameter used to place the ImageBitmap in the given bounds defined by the width and height
`contentScale`	Optional scale parameter used to determine the aspect ratio scaling to be used if the bounds are a different size from the intrinsic size of the ImageBitmap
`alpha`	Optional opacity to be applied to the ImageBitmap when it is rendered onscreen
`colorFilter`	Optional ColorFilter to apply for the ImageBitmap when it is rendered onscree

Image

@Composable
@NonRestartableComposable
fun Image(
    bitmap: ImageBitmap,
    contentDescription: String?,
    modifier: Modifier = Modifier,
    alignment: Alignment = Alignment.Center,
    contentScale: ContentScale = ContentScale.Fit,
    alpha: Float = DefaultAlpha,
    colorFilter: ColorFilter? = null,
    filterQuality: FilterQuality = DefaultFilterQuality
)

Parameters

Name	Description
`bitmap`	The ImageBitmap to draw
`contentDescription`	text used by accessibility services to describe what this image represents. This should always be provided unless this image is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using androidx.compose.ui.res.stringResource or similar
`modifier`	Modifier used to adjust the layout algorithm or draw decoration content (ex. background)
`alignment`	Optional alignment parameter used to place the ImageBitmap in the given bounds defined by the width and height
`contentScale`	Optional scale parameter used to determine the aspect ratio scaling to be used if the bounds are a different size from the intrinsic size of the ImageBitmap
`alpha`	Optional opacity to be applied to the ImageBitmap when it is rendered onscreen
`colorFilter`	Optional ColorFilter to apply for the ImageBitmap when it is rendered onscreen
`filterQuality`	Sampling algorithm applied to the bitmap when it is scaled and drawn into the destination. The default is FilterQuality.Low which scales using a bilinear sampling algorith

Image

@Composable
@NonRestartableComposable
fun Image(
    imageVector: ImageVector,
    contentDescription: String?,
    modifier: Modifier = Modifier,
    alignment: Alignment = Alignment.Center,
    contentScale: ContentScale = ContentScale.Fit,
    alpha: Float = DefaultAlpha,
    colorFilter: ColorFilter? = null
)

Parameters

Name	Description
`imageVector`	The ImageVector to draw
`contentDescription`	text used by accessibility services to describe what this image represents. This should always be provided unless this image is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using androidx.compose.ui.res.stringResource or similar
`modifier`	Modifier used to adjust the layout algorithm or draw decoration content (ex. background)
`alignment`	Optional alignment parameter used to place the ImageVector in the given bounds defined by the width and height
`contentScale`	Optional scale parameter used to determine the aspect ratio scaling to be used if the bounds are a different size from the intrinsic size of the ImageVector
`alpha`	Optional opacity to be applied to the ImageVector when it is rendered onscreen
`colorFilter`	Optional ColorFilter to apply for the ImageVector when it is rendered onscree

Image

@Composable
fun Image(
    painter: Painter,
    contentDescription: String?,
    modifier: Modifier = Modifier,
    alignment: Alignment = Alignment.Center,
    contentScale: ContentScale = ContentScale.Fit,
    alpha: Float = DefaultAlpha,
    colorFilter: ColorFilter? = null
)

Parameters

Name	Description
`painter`	to draw
`contentDescription`	text used by accessibility services to describe what this image represents. This should always be provided unless this image is used for decorative purposes, and does not represent a meaningful action that a user can take. This text should be localized, such as by using androidx.compose.ui.res.stringResource or similar
`modifier`	Modifier used to adjust the layout algorithm or draw decoration content (ex. background)
`alignment`	Optional alignment parameter used to place the Painter in the given bounds defined by the width and height.
`contentScale`	Optional scale parameter used to determine the aspect ratio scaling to be used if the bounds are a different size from the intrinsic size of the Painter
`alpha`	Optional opacity to be applied to the Painter when it is rendered onscreen the default renders the Painter completely opaque
`colorFilter`	Optional colorFilter to apply for the Painter when it is rendered onscree