ui · function · Updated 2026-09-09

AcquireYuiPointerSampleCanary

Acquire yui pointer sample canary.

Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.

external AcquireYuiPointerSampleCanary(yuiTree tree, list of yuiInputRegion regions, text capturedNodeId, yuiPointerAcquisitionSample current, bool hasPrevious, yuiPointerAcquisitionSample previous, text sweepPurpose) returns yuiPointerAcquisitionResult

Status: source-declared

Parameters

yuiTree tree

Supply tree as yuiTree.

list of yuiInputRegion regions

Supply regions as list of yuiInputRegion.

text capturedNodeId

Supply captured node id as text.

yuiPointerAcquisitionSample current

Supply current as yuiPointerAcquisitionSample.

bool hasPrevious

Supply has previous as bool.

yuiPointerAcquisitionSample previous

Supply previous as yuiPointerAcquisitionSample.

text sweepPurpose

Supply sweep purpose as text.

using ui

// Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.
yuiTree tree = yuiTree("id")
list of yuiInputRegion regions = []
text capturedNodeId = "captured Node Id"
yuiPointerAcquisitionSample current = yuiPointerAcquisitionSample("pointer Id", 1, 1, 1, 1, 1)
bool hasPrevious = true
yuiPointerAcquisitionSample previous = yuiPointerAcquisitionSample("pointer Id", 1, 1, 1, 1, 1)
text sweepPurpose = "sweep Purpose"
yuiPointerAcquisitionResult result = AcquireYuiPointerSampleCanary(tree, regions, capturedNodeId, current, hasPrevious, previous, sweepPurpose)
Console.Log("Inspect result in your debugger")

manifestVersion = "2"
package = "api.example.ui__acquireyuipointersamplecanary"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"