# ListenableCanvasRenderer2

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

*** ** * ** ***


```
abstract class ListenableCanvasRenderer2<SharedAssetsT : Renderer.SharedAssets> : Renderer.CanvasRenderer2<SharedAssetsT>
```

<br />

|---|---|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||||
| ↳ | [androidx.wear.watchface.Renderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer) ||||
|   | ↳ | [androidx.wear.watchface.Renderer.CanvasRenderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer) |||
|   |   | ↳ | [androidx.wear.watchface.Renderer.CanvasRenderer2](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2)\<SharedAssetsT\> ||
|   |   |   | ↳ | [androidx.wear.watchface.ListenableCanvasRenderer2](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2) |

*** ** * ** ***

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

`https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html`-based compatibility wrapper around `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2`'s suspending methods.

use Watch Face Format instead

## Summary

| ### Public constructors |
|---|
| `<SharedAssetsT : https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.SharedAssets> [ListenableCanvasRenderer2](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#ListenableCanvasRenderer2(android.view.SurfaceHolder,androidx.wear.watchface.style.CurrentUserStyleRepository,androidx.wear.watchface.WatchState,kotlin.Int,kotlin.Long,kotlin.Boolean))( 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, canvasType: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, 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, clearWithBackgroundTintBeforeRenderingHighlightLayer: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Public functions |
|---|---|
| `abstract https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<SharedAssetsT>` | `@https://developer.android.com/reference/kotlin/androidx/annotation/WorkerThread [createSharedAssetsFuture](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#createSharedAssetsFuture())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `final suspend https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `[init](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#init())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
| `open https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html>` | `@https://developer.android.com/reference/kotlin/androidx/annotation/UiThread [initFuture](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#initFuture())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

| ### Protected functions |
|---|---|
| `final suspend SharedAssetsT` | `[createSharedAssets](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#createSharedAssets())()` **This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead. |

### Inherited functions

From [androidx.wear.watchface.Renderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer) `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.
`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.
`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.
From [androidx.wear.watchface.Renderer.CanvasRenderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer) `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[onDump](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer#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.
From [androidx.wear.watchface.Renderer.CanvasRenderer2](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2) `final https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[render](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime))(canvas: https://developer.android.com/reference/android/graphics/Canvas.html, bounds: https://developer.android.com/reference/android/graphics/Rect.html, zonedDateTime: https://developer.android.com/reference/java/time/ZonedDateTime.html)`

**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
[render](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime,androidx.wear.watchface.Renderer.SharedAssets))(
canvas: https://developer.android.com/reference/android/graphics/Canvas.html,
bounds: https://developer.android.com/reference/android/graphics/Rect.html,
zonedDateTime: https://developer.android.com/reference/java/time/ZonedDateTime.html,
sharedAssets: SharedAssetsT
)`

**This function is deprecated.** AndroidX watchface libraries are deprecated, use Watch Face Format instead.
`final https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `[renderHighlightLayer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2#renderHighlightLayer(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime))(
canvas: https://developer.android.com/reference/android/graphics/Canvas.html,
bounds: https://developer.android.com/reference/android/graphics/Rect.html,
zonedDateTime: https://developer.android.com/reference/java/time/ZonedDateTime.html
)`

**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
[renderHighlightLayer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2#renderHighlightLayer(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime,androidx.wear.watchface.Renderer.SharedAssets))(
canvas: https://developer.android.com/reference/android/graphics/Canvas.html,
bounds: https://developer.android.com/reference/android/graphics/Rect.html,
zonedDateTime: https://developer.android.com/reference/java/time/ZonedDateTime.html,
sharedAssets: SharedAssetsT
)`

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

### Inherited properties

From [androidx.wear.watchface.Renderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer) `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.
From [androidx.wear.watchface.Renderer.CanvasRenderer](https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer#clearWithBackgroundTintBeforeRenderingHighlightLayer()`

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

## Public constructors

### ListenableCanvasRenderer2

```
<SharedAssetsT : Renderer.SharedAssets> [ListenableCanvasRenderer2](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#ListenableCanvasRenderer2(android.view.SurfaceHolder,androidx.wear.watchface.style.CurrentUserStyleRepository,androidx.wear.watchface.WatchState,kotlin.Int,kotlin.Long,kotlin.Boolean))(
    surfaceHolder: SurfaceHolder,
    currentUserStyleRepository: CurrentUserStyleRepository,
    watchState: WatchState,
    canvasType: Int,
    interactiveDrawModeUpdateDelayMillis: @IntRange(from = 0, to = 60000) Long,
    clearWithBackgroundTintBeforeRenderingHighlightLayer: Boolean = false
)
```

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

### createSharedAssetsFuture

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

```
@WorkerThread
abstract fun [createSharedAssetsFuture](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#createSharedAssetsFuture())(): ListenableFuture<SharedAssetsT>
```

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

Implement to allow your Renderers to share data with SharedAssets. When editing multiple `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFaceService`, instances and hence Renderers can exist concurrently (e.g. a headless instance and an interactive instance). Using `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.SharedAssets` allows memory to be saved by sharing immutable data (e.g. Bitmaps, shaders, etc...) between them.

To take advantage of SharedAssets, override this method. The constructed SharedAssets are passed into the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime,androidx.wear.watchface.Renderer.SharedAssets)` as an argument (NB you'll have to cast this to your type).

When all instances using SharedAssets have been closed, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.SharedAssets#onDestroy()` will be called.

Note that while SharedAssets are constructed on a background thread, they'll typically be used on the main thread and subsequently destroyed there.

| Returns |
|---|---|
| `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<SharedAssetsT>` | A `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html` for the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2` that will be passed into `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime,androidx.wear.watchface.Renderer.SharedAssets)` and `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#renderHighlightLayer(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime,androidx.wear.watchface.Renderer.SharedAssets)` |

### init

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

```
final suspend fun [init](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#init())(): 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

Perform UiThread specific initialization. Will be called once during initialization before any subsequent calls to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime)`. If you need to override this method in java, consider using `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer` instead.

### initFuture

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

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

Perform UiThread specific initialization. Will be called once during initialization before any subsequent calls to `https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime,androidx.wear.watchface.Renderer.SharedAssets)`. Note cancellation of the returned future is not supported.

| Returns |
|---|---|
| `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html>` | A ListenableFuture which is resolved when UiThread has completed. Rendering will be blocked until this has resolved. |

## Protected functions

### createSharedAssets

```
protected final suspend fun [createSharedAssets](https://developer.android.com/reference/kotlin/androidx/wear/watchface/ListenableCanvasRenderer2#createSharedAssets())(): SharedAssetsT
```

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

When editing multiple `https://developer.android.com/reference/kotlin/androidx/wear/watchface/WatchFaceService` instances and hence Renderers can exist concurrently (e.g. a headless instance and an interactive instance) and using `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.SharedAssets` allows memory to be saved by sharing immutable data (e.g. Bitmaps, shaders, etc...) between them.

To take advantage of SharedAssets, override this method. The constructed SharedAssets are passed into the `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime,androidx.wear.watchface.Renderer.SharedAssets)` as an argument (NB you'll have to cast this to your type).

When all instances using SharedAssets have been closed, `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.SharedAssets#onDestroy()` will be called.

Note that while SharedAssets are constructed on a background thread, they'll typically be used on the main thread and subsequently destroyed there.

| Returns |
|---|---|
| `SharedAssetsT` | The `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2` that will be passed into `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2#render(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime,androidx.wear.watchface.Renderer.SharedAssets)` and `https://developer.android.com/reference/kotlin/androidx/wear/watchface/Renderer.CanvasRenderer2#renderHighlightLayer(android.graphics.Canvas,android.graphics.Rect,java.time.ZonedDateTime,androidx.wear.watchface.Renderer.SharedAssets)`. |