ListenableCanvasRenderer

abstract class ListenableCanvasRenderer : Renderer.CanvasRenderer

kotlin.Any
   ↳ androidx.wear.watchface.Renderer
     ↳ androidx.wear.watchface.Renderer.CanvasRenderer
       ↳ androidx.wear.watchface.ListenableCanvasRenderer

ListenableFuture-based compatibility wrapper around Renderer.CanvasRenderer's suspending methods.

Summary

Public constructors
ListenableCanvasRenderer(
    surfaceHolder: SurfaceHolder,
    currentUserStyleRepository: CurrentUserStyleRepository,
    watchState: WatchState,
    canvasType: Int,
    interactiveDrawModeUpdateDelayMillis: @IntRange(from = 0, to = 60000) Long,
    clearWithBackgroundTintBeforeRenderingHighlightLayer: Boolean
)

Public functions
open suspend Unit

Perform UiThread specific initialization.
open ListenableFuture<Unit>

Perform UiThread specific initialization.

Inherited functions
From androidx.wear.watchface.Renderer
open Rect

This method is used for accessibility support to describe the portion of the screen containing the main clock element.
Unit

Schedules a call to either CanvasRenderer.render or GlesRenderer.render to draw the next frame.
open Unit

Called when the Renderer is destroyed.
open Unit

Called when the RenderParameters has been updated.
Unit

Posts a message to schedule a call to either CanvasRenderer.render or GlesRenderer.render to draw the next frame.
Unit

Sends a request to the system asking it to update the preview image.
open Boolean

The system periodically (at least once per minute) calls onTimeTick() to trigger a display update.
From androidx.wear.watchface.Renderer.CanvasRenderer
open Unit

Called when adb shell dumpsys is invoked for the WatchFaceService, allowing the renderer to optionally record state for debugging purposes.
abstract Unit
@UiThread
render(canvas: Canvas, bounds: Rect, zonedDateTime: ZonedDateTime)

Sub-classes should override this to implement their watch face rendering logic which should respect the current renderParameters.
abstract Unit
@UiThread
renderHighlightLayer(
    canvas: Canvas,
    bounds: Rect,
    zonedDateTime: ZonedDateTime
)

Sub-classes should override this to implement their watch face highlight layer rendering logic for the RenderParameters.highlightLayer aspect of renderParameters.

Inherited properties
From androidx.wear.watchface.Renderer
Collection<Pair<Int, ContentDescriptionLabel>>

Accessibility ContentDescriptionLabel for any rendered watch face elements other than the time and ComplicationSlots which are generated automatically.
@Px Float

The center x coordinate of the SurfaceHolder this Renderer renders into.
@Px Float

The center y coordinate of the SurfaceHolder this Renderer renders into.
Long

The interval in milliseconds between frames in interactive DrawModes.
RenderParameters

The current RenderParameters.
Rect

The bounds of the SurfaceHolder this Renderer renders into.
SurfaceHolder

The SurfaceHolder that renderInternal will draw into.
WatchFaceColors?

Representative WatchFaceColors which are made available to system clients via androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceColorsListener.
From androidx.wear.watchface.Renderer.CanvasRenderer
Boolean

Whether the Canvas is cleared with RenderParameters.HighlightLayer.backgroundTint before renderHighlightLayer is called.

Public constructors

ListenableCanvasRenderer

Added in 1.1.0
Deprecated in 1.1.0
ListenableCanvasRenderer(
    surfaceHolder: SurfaceHolder,
    currentUserStyleRepository: CurrentUserStyleRepository,
    watchState: WatchState,
    canvasType: Int,
    interactiveDrawModeUpdateDelayMillis: @IntRange(from = 0, to = 60000) Long,
    clearWithBackgroundTintBeforeRenderingHighlightLayer: Boolean = false
)

Public functions

init

Added in 1.0.0
Deprecated in 1.1.0
open suspend fun init(): Unit

Perform UiThread specific initialization. Will be called once during initialization before any subsequent calls to render. If you need to override this method in java, consider using androidx.wear.watchface.ListenableCanvasRenderer instead.

initFuture

Added in 1.0.0
Deprecated in 1.1.0
@UiThread
open fun initFuture(): ListenableFuture<Unit>

Perform UiThread specific initialization. Will be called once during initialization before any subsequent calls to render. Note cancellation of the returned future is not supported.

Returns
ListenableFuture<Unit>

A ListenableFuture which is resolved when UiThread has completed. Rendering will be blocked until this has resolved.