# 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 />

```
public final 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/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/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/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightedElement()` should be rendered using the provided `https://developer.android.com/reference/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/androidx/wear/watchface/RenderParameters.HighlightLayer#HighlightLayer(androidx.wear.watchface.RenderParameters.HighlightedElement,kotlin.Int,kotlin.Int))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightedElement highlightedElement, @https://developer.android.com/reference/androidx/annotation/ColorInt int highlightTint, @https://developer.android.com/reference/androidx/annotation/ColorInt int backgroundTint )` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public methods |
|---|---|
| `boolean` | `[equals](https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#equals(kotlin.Any))(https://developer.android.com/reference/java/lang/Object.html other)` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final @https://developer.android.com/reference/androidx/annotation/ColorInt int` | `[getBackgroundTint](https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#getBackgroundTint())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final @https://developer.android.com/reference/androidx/annotation/ColorInt int` | `[getHighlightTint](https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#getHighlightTint())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightedElement` | `[getHighlightedElement](https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#getHighlightedElement())()` **This method is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `int` | `[hashCode](https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#hashCode())()` **This method 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)

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

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

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

## Public methods

### equals

```
public boolean [equals](https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#equals(kotlin.Any))(Object other)
```

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

### getBackgroundTint

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)

```
public final @ColorInt int [getBackgroundTint](https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#getBackgroundTint())()
```

> [!CAUTION]
> **This method 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/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightedElement()`. Typically this will darken everything else to increase contrast.

### getHighlightTint

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)

```
public final @ColorInt int [getHighlightTint](https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#getHighlightTint())()
```

> [!CAUTION]
> **This method 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/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightedElement()`.

### getHighlightedElement

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)

```
public final @NonNull RenderParameters.HighlightedElement [getHighlightedElement](https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#getHighlightedElement())()
```

> [!CAUTION]
> **This method 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/androidx/wear/watchface/RenderParameters.HighlightedElement` to draw highlighted with `https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#highlightTint()`.

### hashCode

```
public int [hashCode](https://developer.android.com/reference/androidx/wear/watchface/RenderParameters.HighlightLayer#hashCode())()
```

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