CanvasComplication
interface CanvasComplication
CanvasComplicationDrawable |
This class is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Interface for rendering complicationSlots onto a Canvas. These should be created by CanvasComplicationFactory.create. If state needs to be shared with the Renderer that should be set up inside onRendererCreated.
use Watch Face Format instead
Summary
Nested types |
|---|
interface CanvasComplication.InvalidateCallbackThis interface is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public functions |
|
|---|---|
Unit |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
open Unit |
@ComplicationExperimentalThis function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
ComplicationData |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Unit |
This function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
open Unit |
@WorkerThreadThis function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Unit |
@UiThreadThis function is deprecated. AndroidX watchface libraries are deprecated, use Watch Face Format instead. |
Public functions
drawHighlight
fundrawHighlight(
canvas: Canvas,
bounds: Rect,
boundsType: Int,
zonedDateTime: ZonedDateTime,
color: @ColorInt Int
): Unit
Draws a highlight for a ComplicationSlotBoundsType.ROUND_RECT complication. The default implementation does this by drawing a dashed line around the complication, other visual effects may be used if desired.
| Parameters | |
|---|---|
canvas: Canvas |
The |
bounds: Rect |
A |
boundsType: Int |
The |
zonedDateTime: ZonedDateTime |
The |
color: @ColorInt Int |
The color to render the highlight with |
drawHighlight
@ComplicationExperimental
open fundrawHighlight(
canvas: Canvas,
bounds: Rect,
boundsType: Int,
zonedDateTime: ZonedDateTime,
color: @ColorInt Int,
boundingArc: BoundingArc?
): Unit
Draws a highlight for a ComplicationSlotBoundsType.ROUND_RECT complication. The default implementation does this by drawing a dashed line around the complication, other visual effects may be used if desired.
| Parameters | |
|---|---|
canvas: Canvas |
The |
bounds: Rect |
A |
boundsType: Int |
The |
zonedDateTime: ZonedDateTime |
The |
color: @ColorInt Int |
The color to render the highlight with |
boundingArc: BoundingArc? |
Optional |
getData
fungetData(): ComplicationData
Returns the ComplicationData to render with.
loadData
funloadData(
complicationData: ComplicationData,
loadDrawablesAsynchronous: Boolean
): Unit
Sets the ComplicationData to render with and loads any Drawables contained within the ComplicationData. You can choose whether this is done synchronously or asynchronously via loadDrawablesAsynchronous. When any asynchronous loading has completed InvalidateCallback.onInvalidate must be called.
| Parameters | |
|---|---|
complicationData: ComplicationData |
The |
loadDrawablesAsynchronous: Boolean |
Whether or not any drawables should be loaded asynchronously |
onRendererCreated
@WorkerThread
open funonRendererCreated(renderer: Renderer): Unit
Called once on a background thread before any subsequent UI thread rendering to inform the CanvasComplication of the Renderer which is useful if they need to share state. Note the Renderer is created asynchronously which is why we can't pass it in via CanvasComplicationFactory.create as it may not be available at that time.
render
@UiThread
funrender(
canvas: Canvas,
bounds: Rect,
zonedDateTime: ZonedDateTime,
renderParameters: RenderParameters,
slotId: Int
): Unit
Draws the complication defined by getData into the canvas with the specified bounds. This will usually be called by user watch face drawing code, but the system may also call it for complication selection UI rendering. The width and height will be the same as that computed by computeBounds but the translation and canvas size may differ.
| Parameters | |
|---|---|
canvas: Canvas |
The |
bounds: Rect |
A |
zonedDateTime: ZonedDateTime |
The |
renderParameters: RenderParameters |
The current |
slotId: Int |
The Id of the |