SmallImage.Builder

public final class SmallImage.Builder


Builder for MonochromaticImage.

Summary

Public constructors

Public methods

final @NonNull SmallImage

Builds a SmallImage.

final @NonNull SmallImage.Builder
setAmbientImage(@Nullable 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(@NonNull Icon image, @NonNull SmallImageType type)
Parameters
@NonNull Icon image

the Icon representing the image

@NonNull SmallImageType type

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

Public methods

build

@NonNull
public final SmallImage build()

Builds a SmallImage.

setAmbientImage

@NonNull
public final SmallImage.Builder setAmbientImage(@Nullable 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.