SmallImage.Builder

public final class SmallImage.Builder


Builder for MonochromaticImage.

Summary

Public constructors

Builder(Icon image, SmallImageType type)

Public methods

final @NonNull SmallImage

Builds a SmallImage.

final @NonNull SmallImage.Builder
setAmbientImage(Icon ambientImage)

Sets a different image for when the device is ambient mode to save power and prevent burn in.

Public constructors

Builder

public final Builder(Icon image, SmallImageType type)
Parameters
Icon image

the Icon representing the image

SmallImageType type

the style of the image provided, to guide how it should be displayed

Public methods

build

public final @NonNull SmallImage build()

Builds a SmallImage.

setAmbientImage

public final @NonNull SmallImage.Builder setAmbientImage(Icon ambientImage)

Sets a different image for when the device is ambient mode to save power and prevent burn in. If no ambient variant is provided, the watch face may not show anything while in ambient mode.