ListenableCanvasRenderer2
public abstract class ListenableCanvasRenderer2<SharedAssetsT extends Renderer.SharedAssets> extends Renderer.CanvasRenderer2
ListenableFuture-based compatibility wrapper around Renderer.CanvasRenderer2's suspending methods.
use Watch Face Format instead
Summary
Public constructors |
|---|
<SharedAssetsT extends Renderer.SharedAssets> This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public methods |
|
|---|---|
abstract @NonNull ListenableFuture<@NonNull SharedAssetsT> |
This 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. |
@NonNull ListenableFuture<Unit> |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Protected methods |
|
|---|---|
final @NonNull SharedAssetsT |
This method is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Inherited methods |
||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||
|
Public constructors
ListenableCanvasRenderer2
public <SharedAssetsT extends Renderer.SharedAssets>ListenableCanvasRenderer2(
@NonNull SurfaceHolder surfaceHolder,
@NonNull CurrentUserStyleRepository currentUserStyleRepository,
@NonNull WatchState watchState,
int canvasType,
@IntRange(from = 0, to = 60000) long interactiveDrawModeUpdateDelayMillis,
boolean clearWithBackgroundTintBeforeRenderingHighlightLayer
)
Public methods
createSharedAssetsFuture
@WorkerThread
public abstract @NonNull ListenableFuture<@NonNull SharedAssetsT>createSharedAssetsFuture()
Implement to allow your Renderers to share data with SharedAssets. When editing multiple WatchFaceService, instances and hence Renderers can exist concurrently (e.g. a headless instance and an interactive instance). 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 ListenableFuture<@NonNull SharedAssetsT> |
A |
init
public final 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
@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 |
Protected methods
createSharedAssets
protected final @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 |