Composable Function

RemoteBackgroundImage

A remote composable that displays a RemoteBitmap as a background.

RemoteBackgroundImage

Source set: Android
@Composable
@RemoteComposable
public fun RemoteBackgroundImage(
    background: RemoteBitmap,
    contentDescription: RemoteString?,
    modifier: RemoteModifier = RemoteModifier,
    contentScale: ContentScale = ContentScale.FillBounds,
    overlayColor: RemoteColor? = ImageDefaults.backgroundOverlayColor(),
)

A remote composable that displays a RemoteBitmap as a background.

Parameters

background The RemoteBitmap to be displayed as the background.
contentDescription A text description for accessibility.
modifier The RemoteModifier to be applied to this composable.
contentScale The ContentScale to be applied to the image.
overlayColor Optional RemoteColor to be displayed on top of background for contrast.

Last updated: