RenderParameters.HighlightLayer

class RenderParameters.HighlightLayer

The definition of what to include in the highlight layer.

The highlight layer is used by editors to show the parts of the watch face affected by a setting. E.g. a set of ComplicationSlots or a user style setting.

The highlight layer is composited on top of the watch face with an alpha blend. It should be cleared with backgroundTint. The solid or semi-transparent outline around highlightedElement should be rendered using the provided highlightTint. The highlighted element itself should be rendered as fully transparent (an alpha value of 0) to leave it unaffected.

Summary

Public constructors
HighlightLayer(
    highlightedElement: RenderParameters.HighlightedElement,
    highlightTint: @ColorInt Int,
    backgroundTint: @ColorInt Int
)

This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public functions
open operator Boolean
equals(other: Any?)

This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
open Int

This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public properties
Int

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
Int

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.
RenderParameters.HighlightedElement

This property is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead.

Public constructors

HighlightLayer

Added in 1.0.0
Deprecated in 1.3.0-alpha06
HighlightLayer(
    highlightedElement: RenderParameters.HighlightedElement,
    highlightTint: @ColorInt Int,
    backgroundTint: @ColorInt Int
)
Parameters
highlightedElement: RenderParameters.HighlightedElement

The HighlightedElement to draw highlighted with highlightTint.
highlightTint: @ColorInt Int

The highlight tint to apply to highlightedElement.
backgroundTint: @ColorInt Int

The tint to apply to everything other than highlightedElement. Typically this will darken everything else to increase contrast.

Public functions

equals

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

hashCode

open fun hashCode(): Int

Public properties

backgroundTint

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val backgroundTint: Int

The tint to apply to everything other than highlightedElement. Typically this will darken everything else to increase contrast.

highlightTint

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val highlightTint: Int

The highlight tint to apply to highlightedElement.

highlightedElement

Added in 1.0.0
Deprecated in 1.3.0-alpha06
val highlightedElement: RenderParameters.HighlightedElement

The HighlightedElement to draw highlighted with highlightTint.