DelegatedInkTrailPresenter
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.
TheDelegatedInkTrailPresenter interface of theInk API provides the ability to instruct the OS-level compositor to render ink strokes between pointer event dispatches.
In this article
Instance properties
expectedImprovementDeprecatedNon-standardRead onlyReturns a value, in milliseconds, indicating the latency improvement that can be expected using this presenter.
presentationAreaExperimentalRead onlyReturns the
Elementinside which rendering of ink strokes is confined.
Instance methods
updateInkTrailStartPoint()ExperimentalPasses the
PointerEventthat was used as the last rendering point for the current frame, allowing the OS-level compositor to render a delegated ink trail ahead of the next pointer event being dispatched.
Example
In this example, we draw a trail onto a 2D canvas. Near the start of the code, we callInk.requestPresenter(), passing it the canvas as the presentation area for it to take care of and storing the promise it returns in thepresenter variable.
Later on, in thepointermove event listener, the new position of the trailhead is drawn onto the canvas each time the event fires. In addition, theDelegatedInkTrailPresenter object returned when thepresenter promise fulfills has itsupdateInkTrailStartPoint() method invoked; this is passed:
- The last trusted pointer event representing the rendering point for the current frame.
- A
styleobject containing color and diameter settings.
The result is that a delegated ink trail is drawn ahead of the default browser rendering on the app's behalf, in the specified style, until the next time it receives apointermove event.
const ctx = canvas.getContext("2d");let presenter = navigator.ink.requestPresenter({ presentationArea: canvas });let moveCnt = 0;let style = { color: "rgb(0 0 255 / 100%)", diameter: 10 };function getRandomInt(min, max) { min = Math.ceil(min); max = Math.floor(max); return Math.floor(Math.random() * (max - min + 1)) + min;}canvas.addEventListener("pointermove", (evt) => { const pointSize = 10; ctx.fillStyle = "black"; ctx.fillRect(evt.pageX, evt.pageY, pointSize, pointSize); if (moveCnt === 50) { let r = getRandomInt(0, 255); let g = getRandomInt(0, 255); let b = getRandomInt(0, 255); style = { color: `rgb(${r} ${g} ${b} / 100%)`, diameter: 10, }; moveCnt = 0; document.getElementById("div").style.backgroundColor = `rgb(${r} ${g} ${b} / 100%)`; } moveCnt += 1; presenter.then((v) => { v.updateInkTrailStartPoint(evt, style); });});window.addEventListener("pointerdown", (evt) => { evt.pointerId; ctx.clearRect(0, 0, ctx.canvas.width, ctx.canvas.height);});canvas.width = window.innerWidth;canvas.height = window.innerHeight;Note:See this example running live —Delegated ink trail.
Specifications
| Specification |
|---|
| Ink API> # delegatedinktrailpresenter> |