RenderParameters

class RenderParameters

Used to parameterize watch face rendering.

Watch face rendering is split up in a number of layers: the base layer WatchFaceLayer.BASE, the ComplicationSlots layer WatchFaceLayer.COMPLICATIONS, and the layer above the complicationSlots WatchFaceLayer.COMPLICATIONS_OVERLAY. These layers are always drawn in this order, one on top of the previous one. These are the layers that are used to render the watch face itself.

An additional layer, the highlight layer, can be drawn during editing the watch face to highlight different elements of the watch face, namely a set of ComplicationSlots (which may be a single ComplicationSlot) or the area of the watch face that is affected by a single user style setting.

The watch face should provide a way to highlight any of the above combinations so that its own editor, or the one provided by the Wear OS companion phone app is able to highlight the editable part of the watch face to the user. If an individual user style setting is meant to affect the entire watch face (e.g. an overall color setting),then the entire watch face should be highlighted.

The watch face layers and highlight layer can be configured independently, so that it is possible to draw only the highlight layer by passing an empty set of watchFaceLayers.

The semantics of rendering different layers is such that if each individual layer is rendered independently and the resulting images are composited with alpha blending, the result is identical to rendering all of the layers in a single request.

Summary

val DEFAULT_INTERACTIVE: RenderParameters

RenderParameters(
    drawMode: DrawMode,
    watchFaceLayers: Set<WatchFaceLayer>,
    highlightLayer: RenderParameters.HighlightLayer? = null,
    lastComplicationTapDownEvents: Map<Int, TapEvent> = emptyMap()
)

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

open fun hashCode(): Int

val drawMode: DrawMode

val highlightLayer: RenderParameters.HighlightLayer?

val isForScreenshot: Boolean

val lastComplicationTapDownEvents: Map<Int, TapEvent>

val watchFaceLayers: Set<WatchFaceLayer>