Renderer.CanvasRenderer2
public abstract class Renderer.CanvasRenderer2<SharedAssetsT extends Renderer.SharedAssets> extends Renderer.CanvasRenderer
| java.lang.Object | |||
| ↳ | androidx.wear.watchface.Renderer | ||
| ↳ | androidx.wear.watchface.Renderer.CanvasRenderer | ||
| ↳ | androidx.wear.watchface.Renderer.CanvasRenderer2 |
ListenableCanvasRenderer2 |
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Watch faces that require Canvas rendering and are able to take advantage of SharedAssets to save memory (there can be more than once instance when editing), should extend their Renderer from this class.
A CanvasRenderer is expected to be constructed on the background thread associated with WatchFaceService.getBackgroundThreadHandler inside a call to WatchFaceService.createWatchFace. All rendering is be done on the UiThread. There is a memory barrier between construction and rendering so no special threading primitives are required.
In Java it may be easier to extend androidx.wear.watchface.ListenableCanvasRenderer2 instead.
use Watch Face Format instead
| Parameters | |
|---|---|
<SharedAssetsT extends Renderer.SharedAssets> |
The type extending |
Summary
Public constructors |
|---|
@WorkerThreadThis method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public methods |
|
|---|---|
final void |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
abstract void |
@UiThreadThis method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
final void |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
abstract void |
@UiThreadThis method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Protected methods |
|
|---|---|
abstract @NonNull SharedAssetsT |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Inherited methods |
||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||||||||||||
|
Public constructors
CanvasRenderer2
@WorkerThread
public <SharedAssetsT extends Renderer.SharedAssets>CanvasRenderer2(
@NonNull SurfaceHolder surfaceHolder,
@NonNull CurrentUserStyleRepository currentUserStyleRepository,
@NonNull WatchState watchState,
int canvasType,
@IntRange(from = 0, to = 60000) long interactiveDrawModeUpdateDelayMillis,
boolean clearWithBackgroundTintBeforeRenderingHighlightLayer
)
| Parameters | |
|---|---|
<SharedAssetsT extends Renderer.SharedAssets> |
The type extending |
@NonNull SurfaceHolder surfaceHolder |
The |
@NonNull CurrentUserStyleRepository currentUserStyleRepository |
The watch face's associated |
@NonNull WatchState watchState |
The watch face's associated |
int canvasType |
The |
@IntRange(from = 0, to = 60000) long interactiveDrawModeUpdateDelayMillis |
The interval in milliseconds between frames in interactive |
boolean clearWithBackgroundTintBeforeRenderingHighlightLayer |
Whether the |
Public methods
render
public final voidrender(
@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. Please note WatchState.isAmbient may not match the RenderParameters.drawMode and should not be used to decide what to render. E.g. when editing from the companion phone while the watch is ambient, renders may be requested with DrawMode.INTERACTIVE.
Any highlights due to RenderParameters.highlightLayer should be rendered by renderHighlightLayer instead where possible. For correct behavior this function must use the supplied ZonedDateTime in favor of any other ways of getting the time.
Before any calls to render, init will be called once.
| Parameters | |
|---|---|
@NonNull Canvas canvas |
The |
@NonNull Rect bounds |
A |
@NonNull ZonedDateTime zonedDateTime |
The |
render
@UiThread
public abstract voidrender(
@NonNull Canvas canvas,
@NonNull Rect bounds,
@NonNull ZonedDateTime zonedDateTime,
@NonNull SharedAssetsT sharedAssets
)
Sub-classes should override this to implement their watch face rendering logic which should respect the current renderParameters. Please note WatchState.isAmbient may not match the RenderParameters.drawMode and should not be used to decide what to render. E.g. when editing from the companion phone while the watch is ambient, renders may be requested with DrawMode.INTERACTIVE.
Any highlights due to RenderParameters.highlightLayer should be rendered by renderHighlightLayer instead where possible. For correct behavior this function must use the supplied ZonedDateTime in favor of any other ways of getting the time.
Before any calls to render, init will be called once.
| Parameters | |
|---|---|
@NonNull Canvas canvas |
The |
@NonNull Rect bounds |
A |
@NonNull ZonedDateTime zonedDateTime |
The |
@NonNull SharedAssetsT sharedAssets |
The |
renderHighlightLayer
public final voidrenderHighlightLayer(
@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. Typically the implementation will clear canvas to RenderParameters.HighlightLayer.backgroundTint before rendering a transparent highlight or a solid outline around the RenderParameters.HighlightLayer.highlightedElement. This will be composited as needed on top of the results of render. For correct behavior this function must use the supplied ZonedDateTime in favor of any other ways of getting the time.
Note if clearWithBackgroundTintBeforeRenderingHighlightLayer is true then canvas will cleared with RenderParameters.HighlightLayer.backgroundTint before renderHighlightLayer is called. Otherwise it is up to the overridden function to clear the Canvas if necessary.
| Parameters | |
|---|---|
@NonNull Canvas canvas |
The |
@NonNull Rect bounds |
A |
@NonNull ZonedDateTime zonedDateTime |
the |
renderHighlightLayer
@UiThread
public abstract voidrenderHighlightLayer(
@NonNull Canvas canvas,
@NonNull Rect bounds,
@NonNull ZonedDateTime zonedDateTime,
@NonNull SharedAssetsT sharedAssets
)
Sub-classes should override this to implement their watch face highlight layer rendering logic for the RenderParameters.highlightLayer aspect of renderParameters. Typically the implementation will clear canvas to RenderParameters.HighlightLayer.backgroundTint before rendering a transparent highlight or a solid outline around the RenderParameters.HighlightLayer.highlightedElement. This will be composited as needed on top of the results of render. For correct behavior this function must use the supplied ZonedDateTime in favor of any other ways of getting the time.
Note if clearWithBackgroundTintBeforeRenderingHighlightLayer is true then canvas will cleared with RenderParameters.HighlightLayer.backgroundTint before renderHighlightLayer is called. Otherwise it is up to the overridden function to clear the Canvas if necessary.
| Parameters | |
|---|---|
@NonNull Canvas canvas |
The |
@NonNull Rect bounds |
A |
@NonNull ZonedDateTime zonedDateTime |
the |
@NonNull SharedAssetsT sharedAssets |
The |
Protected methods
createSharedAssets
@WorkerThread
protected abstract @NonNull SharedAssetsTcreateSharedAssets()
When editing multiple WatchFaceService instances and hence Renderers can exist concurrently (e.g. a headless instance and an interactive instance) and using 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 render as an argument (NB you'll have to cast this to your type).
When all instances using SharedAssets have been closed, 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 | |
|---|---|
@NonNull SharedAssetsT |
The |