# Renderer

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/Renderer.kt+class:androidx.wear.watchface.Renderer) 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 />

```
sealed class Renderer
```

<br />

Known direct subclasses [Renderer.CanvasRenderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer), [Renderer.GlesRenderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer` | **This class is deprecated.** CanvasRenderer is deprecated |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer` | **This class is deprecated.** GlesRenderer is deprecated |

Known indirect subclasses [ListenableCanvasRenderer2](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2), [ListenableCanvasRenderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer), [ListenableGlesRenderer2](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableGlesRenderer2), [ListenableGlesRenderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableGlesRenderer), [Renderer.CanvasRenderer2](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2), [Renderer.GlesRenderer2](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer2)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer` | **This class is deprecated.** Use ListenableCanvasRenderer2 instead |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableGlesRenderer2` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableGlesRenderer` | **This class is deprecated.** Use ListenableGlesRenderer2 instead |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer2` | **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

*** ** * ** ***

> [!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 base class for `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer`, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2`, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer`, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer2`. Where possible it is recommended to use `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2` or `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer2` which allow memory to be saved during editing because there can be more than one watchface instance during editing.

Renderers are constructed on a background thread but all rendering is done on the UiThread. There is a memory barrier between construction and rendering so no special threading primitives are required.

It is recommended to set `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#watchfaceColors()` with representative `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFaceColors` this is used by compatible systems to influence the system's color scheme.

Please note `https://developer.android.com/reference/android/graphics/drawable/AnimatedImageDrawable.html` and similar classes which rely on `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback.html` do not animate properly out of the box unless you register an implementation with `https://developer.android.com/reference/android/graphics/drawable/Drawable.html#setCallback(android.graphics.drawable.Drawable.Callback)` that calls `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#invalidate()`. Even then these classes are not recommend because the `https://developer.android.com/reference/java/time/ZonedDateTime.html` passed to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime)` or `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer#render(java.time.ZonedDateTime)` is not guaranteed to match the system time (e.g. for taking screenshots). In addition care is needed when implementing `https://developer.android.com/reference/android/graphics/drawable/Drawable.Callback.html` to ensure it does not animate in ambient mode which could lead to a significant power regression.

use Watch Face Format instead

## Summary

| ### Nested types |
|---|
| `abstract class https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer : https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer` **This class is deprecated.** CanvasRenderer is deprecated |
| `abstract class https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2<SharedAssetsT : https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.SharedAssets> : https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract class https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer : https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer` **This class is deprecated.** GlesRenderer is deprecated |
| `class https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer.GlesException : https://developer.android.com/reference/java/lang/Exception.html` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract class https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer2<SharedAssetsT : https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.SharedAssets> : https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer` **This class is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `interface https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.SharedAssets` **This interface is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Protected constructors |
|---|
| `@https://developer.android.com/reference/kotlin/androidx/annotation/WorkerThread [Renderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#Renderer(android.view.SurfaceHolder,androidx.wear.watchface.style.CurrentUserStyleRepository,androidx.wear.watchface.WatchState,kotlin.Long))( surfaceHolder: https://developer.android.com/reference/android/view/SurfaceHolder.html, currentUserStyleRepository: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/CurrentUserStyleRepository, watchState: https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState, interactiveDrawModeUpdateDelayMillis: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0, to = 60000) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public functions |
|---|---|
| `open https://developer.android.com/reference/android/graphics/Rect.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/UiThread [getMainClockElementBounds](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#getMainClockElementBounds())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/UiThread [invalidate](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#invalidate())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/UiThread [onDestroy](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#onDestroy())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `abstract https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/UiThread [onDump](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#onDump(java.io.PrintWriter))(writer: https://developer.android.com/reference/java/io/PrintWriter.html)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[postInvalidate](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#postInvalidate())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[sendPreviewImageNeedsUpdateRequest](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#sendPreviewImageNeedsUpdateRequest())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/UiThread [shouldAnimate](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#shouldAnimate())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Protected functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/annotation/UiThread [onRenderParametersChanged](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#onRenderParametersChanged(androidx.wear.watchface.RenderParameters))(renderParameters: https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters)` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-collection/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-pair/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, https://developer.android.com/reference/kotlin/androidx/wear/watchface/ContentDescriptionLabel>>` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#additionalContentDescriptionLabels()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#centerX()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/Px https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#centerY()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `@https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0, to = 60000) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#interactiveDrawModeUpdateDelayMillis()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#renderParameters()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/android/graphics/Rect.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#screenBounds()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/android/view/SurfaceHolder.html` | `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#surfaceHolder()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFaceColors?` | `@https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFaceExperimental https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#watchfaceColors()` **This property is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

## Protected constructors

### Renderer

```
@WorkerThread
protected [Renderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#Renderer(android.view.SurfaceHolder,androidx.wear.watchface.style.CurrentUserStyleRepository,androidx.wear.watchface.WatchState,kotlin.Long))(
    surfaceHolder: SurfaceHolder,
    currentUserStyleRepository: CurrentUserStyleRepository,
    watchState: WatchState,
    interactiveDrawModeUpdateDelayMillis: @IntRange(from = 0, to = 60000) Long
)
```

> [!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 |
|---|---|
| `surfaceHolder: https://developer.android.com/reference/android/view/SurfaceHolder.html` | The `https://developer.android.com/reference/android/view/SurfaceHolder.html` that `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#renderInternal(java.time.ZonedDateTime)` will draw into. |
| `currentUserStyleRepository: https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/CurrentUserStyleRepository` | The associated `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/CurrentUserStyleRepository`. |
| `watchState: https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState` | The associated `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchState`. |
| `interactiveDrawModeUpdateDelayMillis: @https://developer.android.com/reference/kotlin/androidx/annotation/IntRange(from = 0, to = 60000) https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html` | The interval in milliseconds between frames in interactive `https://developer.android.com/reference/kotlin/androidx/wear/watchface/DrawMode`s. To render at 60hz set to 16. Note when battery is low, the frame rate will be clamped to 10fps. Watch faces are recommended to use lower frame rates if possible for better battery life. Variable frame rates can also help preserve battery life, e.g. if a watch face has a short animation once per second it can adjust the frame rate inorder to sleep when not animating. In ambient mode the watch face will be rendered once per minute. |

## Public functions

### getMainClockElementBounds

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)

```
@UiThread
open fun [getMainClockElementBounds](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#getMainClockElementBounds())(): Rect
```

> [!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

This method is used for accessibility support to describe the portion of the screen containing the main clock element. By default we assume this is contained in the central half of the watch face. Watch faces should override this to return the correct bounds for the main clock element.

| Returns |
|---|---|
| `https://developer.android.com/reference/android/graphics/Rect.html` | A `https://developer.android.com/reference/android/graphics/Rect.html` describing the bounds of the watch faces' main clock element |

### invalidate

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)

```
@UiThread
fun [invalidate](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#invalidate())(): Unit
```

> [!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

Schedules a call to either `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime)` or `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer#render(java.time.ZonedDateTime)` to draw the next frame.

### onDestroy

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)

```
@UiThread
open fun [onDestroy](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#onDestroy())(): Unit
```

> [!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

Called when the Renderer is destroyed.

### onDump

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)

```
@UiThread
abstract fun [onDump](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#onDump(java.io.PrintWriter))(writer: PrintWriter): Unit
```

> [!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

Called when adb shell dumpsys is invoked for the WatchFaceService, allowing the renderer to optionally record state for debugging purposes.

### postInvalidate

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)

```
fun [postInvalidate](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#postInvalidate())(): Unit
```

> [!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

Posts a message to schedule a call to either `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime)` or `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer#render(java.time.ZonedDateTime)` to draw the next frame. Unlike `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#invalidate()`, this method is thread-safe and may be called on any thread.

### sendPreviewImageNeedsUpdateRequest

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

```
fun [sendPreviewImageNeedsUpdateRequest](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#sendPreviewImageNeedsUpdateRequest())(): Unit
```

> [!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

Sends a request to the system asking it to update the preview image. This is useful for watch faces with configuration outside of the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/style/UserStyleSchema` E.g. a watchface with a selectable background.

The system may choose to rate limit this method for performance reasons and the system is free to schedule when the update occurs.

Requires a compatible system to work (if the system is incompatible this does nothing). This can be called from any thread.

### shouldAnimate

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)

```
@UiThread
open fun [shouldAnimate](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#shouldAnimate())(): 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

The system periodically (at least once per minute) calls onTimeTick() to trigger a display update. If the watch face needs to animate with an interactive frame rate, calls to invalidate must be scheduled. This method controls whether or not we should do that and if shouldAnimate returns true we inhibit entering `https://developer.android.com/reference/kotlin/androidx/wear/watchface/DrawMode#AMBIENT`.

By default we remain at an interactive frame rate when the watch face is visible and we're not in ambient mode. Watch faces with animated transitions for entering ambient mode may need to override this to ensure they play smoothly.

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | Whether we should schedule an onDraw call to maintain an interactive frame rate |

## Protected functions

### onRenderParametersChanged

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)

```
@UiThread
protected open fun [onRenderParametersChanged](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#onRenderParametersChanged(androidx.wear.watchface.RenderParameters))(renderParameters: RenderParameters): Unit
```

> [!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

Called when the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters` has been updated. Will always be called before the first call to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime)` or `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.GlesRenderer#render(java.time.ZonedDateTime)`.

## Public properties

### additionalContentDescriptionLabels

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)

```
var additionalContentDescriptionLabels: Collection<Pair<Int, ContentDescriptionLabel>>
```

> [!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

Accessibility `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ContentDescriptionLabel` for any rendered watch face elements other than the time and `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot`s which are generated automatically.

The `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` in the `Pair<Int, ContentDescriptionLabel>` is used to sort the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ContentDescriptionLabel`s. Note the time piece has an accessibility traversal index of -1 and each `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot`'s index is defined by its `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ComplicationSlot#accessibilityTraversalIndex()`.

### centerX

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 centerX: @Px Float
```

> [!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 center x coordinate of the `https://developer.android.com/reference/android/view/SurfaceHolder.html` this Renderer renders into.

### centerY

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 centerY: @Px Float
```

> [!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 center y coordinate of the `https://developer.android.com/reference/android/view/SurfaceHolder.html` this Renderer renders into.

### interactiveDrawModeUpdateDelayMillis

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)

```
var interactiveDrawModeUpdateDelayMillis: @IntRange(from = 0, to = 60000) Long
```

> [!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 interval in milliseconds between frames in interactive `https://developer.android.com/reference/kotlin/androidx/wear/watchface/DrawMode`s. To render at 60hz set to 16. Note when battery is low, the frame rate will be clamped to 10fps. Watch faces are recommended to use lower frame rates if possible for better battery life. Variable frame rates can also help preserve battery life, e.g. if a watch face has a short animation once per second it can adjust the frame rate inorder to sleep when not animating. In ambient mode the watch face will be rendered once per minute.

### renderParameters

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 renderParameters: RenderParameters
```

> [!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 current `https://developer.android.com/reference/kotlin/androidx/wear/watchface/RenderParameters`. Updated before every onDraw call.

### screenBounds

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 screenBounds: Rect
```

> [!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 bounds of the `https://developer.android.com/reference/android/view/SurfaceHolder.html` this Renderer renders into. Depending on the shape of the device's screen not all of these pixels may be visible to the user (see `https://developer.android.com/reference/android/content/res/Configuration.html#isScreenRound()`). Note also that API level 27+ devices draw indicators in the top and bottom 24dp of the screen, avoid rendering anything important there.

### surfaceHolder

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)

```
var surfaceHolder: SurfaceHolder
```

> [!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/android/view/SurfaceHolder.html` that `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer#renderInternal(java.time.ZonedDateTime)` will draw into.

### watchfaceColors

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

```
@WatchFaceExperimental
var watchfaceColors: WatchFaceColors?
```

> [!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

Representative `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFaceColors` which are made available to system clients via androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceColorsListener.

Initially this value is `null` signifying that the colors are unknown. When possible the watchFace should assign `non null` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFaceColors` and keep this updated when the colors change (e.g. due to a style change).