# RenderParameters.HighlightLayer

Artifact: [androidx.wear.watchface:watchface](https://developer.android.com/jetpack/androidx/releases/wear-watchface) [View Source](https://cs.android.com/search?q=file:androidx/wear/watchface/RenderParameters.kt+class:androidx.wear.watchface.RenderParameters.HighlightLayer) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

*** ** * ** ***

<br />

```
class RenderParameters.HighlightLayer
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

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 `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot`s 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 `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#(androidx.wear.watchface.RenderParameters.HighlightedElement,kotlin.Int,kotlin.Int)`. The solid or semi-transparent outline around `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightedElement()` should be rendered using the provided `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#(androidx.wear.watchface.RenderParameters.HighlightedElement,kotlin.Int,kotlin.Int)`. The highlighted element itself should be rendered as fully transparent (an alpha value of 0) to leave it unaffected.

## Summary

| ### Public constructors |
|---|
| `[HighlightLayer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#HighlightLayer(androidx.wear.watchface.RenderParameters.HighlightedElement,kotlin.Int,kotlin.Int))( highlightedElement: https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightedElement, highlightTint: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, backgroundTint: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `[equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#equals(kotlin.Any))(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `[hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#hashCode())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public properties |
|---|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#backgroundTint()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightTint()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightedElement` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightedElement()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Public constructors

### HighlightLayer

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
[HighlightLayer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#HighlightLayer(androidx.wear.watchface.RenderParameters.HighlightedElement,kotlin.Int,kotlin.Int))(
    highlightedElement: RenderParameters.HighlightedElement,
    highlightTint: @ColorInt Int,
    backgroundTint: @ColorInt Int
)
```

> [!CAUTION]
> **This function is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

| Parameters |
|---|---|
| `highlightedElement: https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightedElement` | The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightedElement` to draw highlighted with `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightTint()`. |
| `highlightTint: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The highlight tint to apply to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightedElement()`. |
| `backgroundTint: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The tint to apply to everything other than `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightedElement()`. Typically this will darken everything else to increase contrast. |

## Public functions

### equals

```
open operator fun [equals](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#equals(kotlin.Any))(other: Any?): Boolean
```

> [!CAUTION]
> **This function is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

### hashCode

```
open fun [hashCode](https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#hashCode())(): Int
```

> [!CAUTION]
> **This function is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

## Public properties

### backgroundTint

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val backgroundTint: @ColorInt Int
```

> [!CAUTION]
> **This property is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

The tint to apply to everything other than `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightedElement()`. Typically this will darken everything else to increase contrast.

### highlightTint

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val highlightTint: @ColorInt Int
```

> [!CAUTION]
> **This property is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

The highlight tint to apply to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightedElement()`.

### highlightedElement

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.0.0) Deprecated in [1.3.0-alpha07](https://developer.android.com/jetpack/androidx/releases/wear-watchface#1.3.0-alpha07)

```
val highlightedElement: RenderParameters.HighlightedElement
```

> [!CAUTION]
> **This property is deprecated.**   
> AndroidX watchface libraries are deprecated, use Watch Face Format instead. For more info see: https://developer.android.com/training/wearables/wff

The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightedElement` to draw highlighted with `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightTint()`.