ListenableCanvasRenderer

Artifact: androidx.wear.watchface:watchface-guava

Added in 1.0.0

Deprecated in 1.1.0

Kotlin |Java

public abstract class ListenableCanvasRenderer extends Renderer.CanvasRenderer

java.lang.Object
↳	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( @NonNull SurfaceHolder surfaceHolder, @NonNull CurrentUserStyleRepository currentUserStyleRepository, @NonNull WatchState watchState, int canvasType, @IntRange(from = 0, to = 60000) long interactiveDrawModeUpdateDelayMillis, boolean clearWithBackgroundTintBeforeRenderingHighlightLayer )`

Public methods
`void`	`init()` Perform UiThread specific initialization.
`@NonNull ListenableFuture<Unit>`	`@UiThread initFuture()` Perform UiThread specific initialization.

Inherited methods

From androidx.wear.watchface.Renderer

`final @NonNull Collection<@NonNull Pair<@NonNull Integer, @NonNull ContentDescriptionLabel>>`	`getAdditionalContentDescriptionLabels()` Accessibility `ContentDescriptionLabel` for any rendered watch face elements other than the time and `ComplicationSlot`s which are generated automatically.
`final float`	`getCenterX()` The center x coordinate of the `SurfaceHolder` this Renderer renders into.
`final float`	`getCenterY()` The center y coordinate of the `SurfaceHolder` this Renderer renders into.
`final long`	`getInteractiveDrawModeUpdateDelayMillis()` The interval in milliseconds between frames in interactive `DrawMode`s.
`@NonNull Rect`	`@UiThread getMainClockElementBounds()` This method is used for accessibility support to describe the portion of the screen containing the main clock element.
`final @NonNull RenderParameters`	`getRenderParameters()` The current `RenderParameters`.
`final @NonNull Rect`	`getScreenBounds()` The bounds of the `SurfaceHolder` this Renderer renders into.
`final @NonNull SurfaceHolder`	`getSurfaceHolder()` The `SurfaceHolder` that `renderInternal` will draw into.
`final WatchFaceColors`	`@WatchFaceExperimental getWatchfaceColors()` Representative `WatchFaceColors` which are made available to system clients via androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceColorsListener.
`final void`	`@UiThread invalidate()` Schedules a call to either `CanvasRenderer.render` or `GlesRenderer.render` to draw the next frame.
`void`	`@UiThread onDestroy()` Called when the Renderer is destroyed.
`void`	`@UiThread onRenderParametersChanged(@NonNull RenderParameters renderParameters)` Called when the `RenderParameters` has been updated.
`final void`	`postInvalidate()` Posts a message to schedule a call to either `CanvasRenderer.render` or `GlesRenderer.render` to draw the next frame.
`final void`	`sendPreviewImageNeedsUpdateRequest()` Sends a request to the system asking it to update the preview image.
`final void`	`setAdditionalContentDescriptionLabels( @NonNull Collection<@NonNull Pair<@NonNull Integer, @NonNull ContentDescriptionLabel>> additionalContentDescriptionLabels )` Accessibility `ContentDescriptionLabel` for any rendered watch face elements other than the time and `ComplicationSlot`s which are generated automatically.
`final void`	`setInteractiveDrawModeUpdateDelayMillis( long interactiveDrawModeUpdateDelayMillis )`
`final void`	`setSurfaceHolder(@NonNull SurfaceHolder surfaceHolder)` The `SurfaceHolder` that `renderInternal` will draw into.
`final void`	`@WatchFaceExperimental setWatchfaceColors( @WatchFaceExperimental WatchFaceColors watchfaceColors )` Representative `WatchFaceColors` which are made available to system clients via androidx.wear.watchface.client.InteractiveWatchFaceClient.OnWatchFaceColorsListener.
`boolean`	`@UiThread shouldAnimate()` The system periodically (at least once per minute) calls onTimeTick() to trigger a display update.

From androidx.wear.watchface.Renderer.CanvasRenderer

`final boolean`	`getClearWithBackgroundTintBeforeRenderingHighlightLayer()` Whether the `Canvas` is cleared with `RenderParameters.HighlightLayer.backgroundTint` before `renderHighlightLayer` is called.
`void`	`onDump(@NonNull PrintWriter writer)` Called when adb shell dumpsys is invoked for the WatchFaceService, allowing the renderer to optionally record state for debugging purposes.
`abstract void`	`@UiThread render( @NonNull Canvas canvas, @NonNull Rect bounds, @NonNull ZonedDateTime zonedDateTime )` Sub-classes should override this to implement their watch face rendering logic which should respect the current `renderParameters`.
`abstract void`	`@UiThread renderHighlightLayer( @NonNull Canvas canvas, @NonNull Rect bounds, @NonNull ZonedDateTime zonedDateTime )` Sub-classes should override this to implement their watch face highlight layer rendering logic for the `RenderParameters.highlightLayer` aspect of `renderParameters`.

Public constructors

ListenableCanvasRenderer

Added in 1.1.0

Deprecated in 1.1.0

public ListenableCanvasRenderer(
    @NonNull SurfaceHolder surfaceHolder,
    @NonNull CurrentUserStyleRepository currentUserStyleRepository,
    @NonNull WatchState watchState,
    int canvasType,
    @IntRange(from = 0, to = 60000) long interactiveDrawModeUpdateDelayMillis,
    boolean clearWithBackgroundTintBeforeRenderingHighlightLayer
)

Public methods

init

Added in 1.0.0

Deprecated in 1.1.0

public void init()

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
public @NonNull ListenableFuture<Unit> initFuture()

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
`@NonNull ListenableFuture<Unit>`	A ListenableFuture which is resolved when UiThread has completed. Rendering will be blocked until this has resolved.