MonochromaticImage

Artifact: androidx.wear.watchface:watchface-complications-data

View Source

Added in 1.0.0

---

Kotlin |Java

class MonochromaticImage

---

A simple, monochromatic image that can be tinted by the watch face.

A monochromatic image doesn't have to be black and white, it can have a single color associated with the provider / brand with the expectation that the watch face may recolor it (typically using a SRC_IN filter).

An ambient alternative is provided that may be shown instead of the regular image while the watch is not active.

Summary

Nested types
class MonochromaticImage.Builder Builder for MonochromaticImage.

Public companion properties
MonochromaticImage	PLACEHOLDER For use when the real data isn't available yet, this MonochromaticImage should be rendered as a placeholder.

Public functions
open operator Boolean	equals(other: Any?)
open Int	hashCode()
open String	toString()

Public properties
Icon?	ambientImage The image to be shown when the device is in ambient mode to save power or avoid burn in
Icon	image The image itself

Public companion properties

PLACEHOLDER

val PLACEHOLDER: MonochromaticImage

For use when the real data isn't available yet, this MonochromaticImage should be rendered as a placeholder. It is suggested that it should be rendered with a light grey box.

Note a placeholder may only be used in the context of NoDataComplicationData.placeholder.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

Public properties

ambientImage

Added in 1.0.0

val ambientImage: Icon?

The image to be shown when the device is in ambient mode to save power or avoid burn in

image

Added in 1.0.0

val image: Icon

The image itself