androidx.wear.watchface

Interfaces

CanvasComplication

Interface for rendering complicationSlots onto a Canvas.

CanvasComplication.InvalidateCallback

Interface for observing when a CanvasComplication needs the screen to be redrawn.

CanvasComplicationFactory

Factory for creating a CanvasComplication.

ComplicationSlotsManager.TapCallback

Interface used to report user taps on the ComplicationSlot.

ComplicationTapFilter

Interface for determining whether a tap hits a complication.

Renderer.SharedAssets

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 and shaders) between them.

WatchFace.TapListener

Listens for taps on the watchface.

Classes

BackgroundComplicationTapFilter

Default ComplicationTapFilter for ComplicationSlotBoundsType.BACKGROUND complicationSlots.

BoundingArc

In combination with a bounding Rect, BoundingArc describes the geometry of an edge complication.

ComplicationSlot

Represents the slot an individual complication on the screen may go in.

ComplicationSlot.Builder

Builder for constructing ComplicationSlots.

ComplicationSlotInflationFactory

A ComplicationSlotInflationFactory provides the CanvasComplicationFactory and where necessary edge complication ComplicationTapFilters needed for inflating ComplicationSlots.

ComplicationSlotsManager

The ComplicationSlots associated with the WatchFace.

ContentDescriptionLabel

Describes regions of the watch face for use by a screen reader.

ListenableCanvasRenderer

This class is deprecated. Use ListenableCanvasRenderer2 instead

ListenableCanvasRenderer2

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

ListenableGlesRenderer

This class is deprecated. Use ListenableGlesRenderer2 instead

ListenableGlesRenderer2

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

ListenableStatefulWatchFaceRuntimeService

ListenableFuture-based compatibility wrapper around WatchFaceRuntimeService's suspending WatchFaceService.createWatchFace.

ListenableStatefulWatchFaceService

ListenableFuture-based compatibility wrapper around StatefulWatchFaceService's suspending WatchFaceService.createWatchFace.

ListenableWatchFaceRuntimeService

ListenableFuture-based compatibility wrapper around WatchFaceRuntimeService's suspending WatchFaceService.createWatchFace.

ListenableWatchFaceService

ListenableFuture-based compatibility wrapper around WatchFaceService's suspending WatchFaceService.createWatchFace.

RenderParameters

Used to parameterize watch face rendering.

RenderParameters.HighlightLayer

The definition of what to include in the highlight layer.

RenderParameters.HighlightedElement

An element of the watch face to highlight.

RenderParameters.HighlightedElement.ComplicationSlot

A single androidx.wear.watchface.ComplicationSlot with the specified id will be highlighted.

RenderParameters.HighlightedElement.UserStyle

A UserStyleSetting to highlight.

Renderer

The base class for CanvasRenderer, CanvasRenderer2, GlesRenderer, GlesRenderer2.

Renderer.CanvasRenderer

This class is deprecated. CanvasRenderer is deprecated

Renderer.CanvasRenderer2

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.

Renderer.GlesRenderer

This class is deprecated. GlesRenderer is deprecated

Renderer.GlesRenderer2

Watch faces that require GLES20 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.

RoundRectComplicationTapFilter

Default ComplicationTapFilter for ComplicationSlotBoundsType.ROUND_RECT complicationSlots.

StatefulWatchFaceRuntimeService

WatchFaceRuntimeService is required to be stateless as multiple can be created in parallel.

StatefulWatchFaceService

WatchFaceService is required to be stateless as multiple can be created in parallel.

TapEvent

An input event received by the watch face.

WatchFace

The return value of WatchFaceService.createWatchFace which brings together rendering, styling, complicationSlots and state observers.

WatchFace.LegacyWatchFaceOverlayStyle

Legacy Wear 2.0 watch face styling.

WatchFace.OverlayStyle

This class is deprecated. OverlayStyle will be removed in a future release.

WatchFaceColors

Provides information about the colors of a watch face, exposing the three most representative colors.

WatchFaceRuntimeService

WatchFaceRuntimeService is a special kind of WatchFaceService, which loads the watch face definition from another resource only watch face package (see the resourceOnlyWatchFacePackageName parameter passed to createUserStyleSchema, createComplicationSlotsManager, createUserStyleFlavors and createWatchFace).

WatchFaceService

WatchFaceService and WatchFace are a pair of classes intended to handle much of the boilerplate needed to implement a watch face without being too opinionated.

WatchState

Describes the current state of the wearable including some hardware details such as whether or not it supports burn in prevention and low-bit ambient.

Exceptions

Renderer.GlesRenderer.GlesException

Exception thrown if a GL call fails

Objects

CanvasType

Describes the type of Canvas a Renderer.CanvasRenderer or Renderer.CanvasRenderer2 can request from a SurfaceHolder.

ComplicationSlotBoundsType

The various types of ComplicationSlot bounds.

RenderParameters.HighlightedElement.AllComplicationSlots

All ComplicationSlots will be highlighted.

TapType

The types of tap events the system can forward to the watch face.

WatchFaceType

The type of watch face, whether it's digital or analog.

Annotations

Enums