# yuiInputRegion

A yui input region record carrying nodeId, x, y, width, height, and related state.

Last updated: 2026-09-09

Package: ui | Status: source-declared

Tags: cpu, method, source-example, thing, ui, yeho

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

```yh
external thing yuiInputRegion
```

- text nodeId: Stores node id as text.
- int x: Stores x as int.
- int y: Stores y as int.
- int width: Stores width as int.
- int height: Stores height as int.
- int zOrder: Stores z order as int.
- bool clipped: Stores clipped as bool.
- int clipX: Stores clip x as int.
- int clipY: Stores clip y as int.
- int clipWidth: Stores clip width as int.
- int clipHeight: Stores clip height as int.
- bool acceptsPointer: Stores accepts pointer as bool.
- text acquisitionShape: Stores acquisition shape as text.
- int acquisitionCenterX: Stores acquisition center x as int.
- int acquisitionCenterY: Stores acquisition center y as int.
- int acquisitionRadius: Stores acquisition radius as int.
- yuiInputRegion(text nodeId, int x, int y, int width, int height, int zOrder, bool acceptsPointer): Yui input region.
- UseCircleAcquisitionCanary(int centerX, int centerY, int radius) returns bool: Use circle acquisition canary.
- AcquisitionGeometryValid() returns bool: Acquisition geometry valid.
- CanaryGeometryBounded() returns bool: Canary geometry bounded.
- BoundsContains(int pointX, int pointY) returns bool: Bounds contains.
- ClipContains(int pointX, int pointY) returns bool: Clip contains.
- HitContains(int pointX, int pointY) returns bool: Hit contains.
- SweepIntersectsCanary(int fromX, int fromY, int toX, int toY) returns bool: Sweep intersects canary.
- Describe() returns text: Describe.

## Use yuiInputRegion

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

Verification: type checked

```yh
using ui

// Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.
yuiInputRegion sample = yuiInputRegion("node Id", 1, 1, 1, 1, 1, true)
Console.Log(Text.From(sample.nodeId))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiinputregion"
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiInputRegion/usage --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiInputRegion.UseCircleAcquisitionCanary

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using ui

// Use circle acquisition canary.
yuiInputRegion instance = yuiInputRegion("node Id", 1, 1, 1, 1, 1, true)
int argument_centerX = 1
int argument_centerY = 1
int argument_radius = 1
bool result = instance.UseCircleAcquisitionCanary(argument_centerX, argument_centerY, argument_radius)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiinputregion"
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiInputRegion/method-UseCircleAcquisitionCanary-17 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiInputRegion.AcquisitionGeometryValid

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using ui

// Acquisition geometry valid.
yuiInputRegion instance = yuiInputRegion("node Id", 1, 1, 1, 1, 1, true)
bool result = instance.AcquisitionGeometryValid()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiinputregion"
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiInputRegion/method-AcquisitionGeometryValid-18 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiInputRegion.CanaryGeometryBounded

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using ui

// Canary geometry bounded.
yuiInputRegion instance = yuiInputRegion("node Id", 1, 1, 1, 1, 1, true)
bool result = instance.CanaryGeometryBounded()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiinputregion"
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiInputRegion/method-CanaryGeometryBounded-19 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiInputRegion.BoundsContains

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using ui

// Bounds contains.
yuiInputRegion instance = yuiInputRegion("node Id", 1, 1, 1, 1, 1, true)
int argument_pointX = 1
int argument_pointY = 1
bool result = instance.BoundsContains(argument_pointX, argument_pointY)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiinputregion"
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiInputRegion/method-BoundsContains-20 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiInputRegion.ClipContains

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using ui

// Clip contains.
yuiInputRegion instance = yuiInputRegion("node Id", 1, 1, 1, 1, 1, true)
int argument_pointX = 1
int argument_pointY = 1
bool result = instance.ClipContains(argument_pointX, argument_pointY)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiinputregion"
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiInputRegion/method-ClipContains-21 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiInputRegion.HitContains

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using ui

// Hit contains.
yuiInputRegion instance = yuiInputRegion("node Id", 1, 1, 1, 1, 1, true)
int argument_pointX = 1
int argument_pointY = 1
bool result = instance.HitContains(argument_pointX, argument_pointY)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiinputregion"
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiInputRegion/method-HitContains-22 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiInputRegion.SweepIntersectsCanary

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using ui

// Sweep intersects canary.
yuiInputRegion instance = yuiInputRegion("node Id", 1, 1, 1, 1, 1, true)
int argument_fromX = 1
int argument_fromY = 1
int argument_toX = 1
int argument_toY = 1
bool result = instance.SweepIntersectsCanary(argument_fromX, argument_fromY, argument_toX, argument_toY)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiinputregion"
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiInputRegion/method-SweepIntersectsCanary-23 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiInputRegion.Describe

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using ui

// Describe.
yuiInputRegion instance = yuiInputRegion("node Id", 1, 1, 1, 1, 1, true)
text result = instance.Describe()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiinputregion"
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiInputRegion/method-Describe-24 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

Source: yeho/packages/ui/interaction-model.yh

AI training permission: https://demonhunterlabs.com/ai-use