# mouseButtons

A mouse buttons record carrying left, middle, right, back, forward.

Last updated: 2026-09-09

Package: input.mouse | Status: source-declared

Tags: cpu, input, input.mouse, method, mouse, source-example, thing, yeho

Read mouse position, buttons, and relative input for native interactions.

```yh
external thing mouseButtons
```

- bool left: Stores left as bool.
- bool middle: Stores middle as bool.
- bool right: Stores right as bool.
- bool back: Stores back as bool.
- bool forward: Stores forward as bool.
- mouseButtons(bool left, bool middle, bool right, bool back, bool forward): Mouse buttons.
- AnyPressed() returns bool: Any pressed.

## Use mouseButtons

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

Verification: type checked

```yh
using input.mouse

// Read mouse position, buttons, and relative input for native interactions.
mouseButtons sample = mouseButtons(true, true, true, true, true)
Console.Log(Text.From(sample.left))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.input_mouse__mousebuttons"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "input.mouse"
version = "0.1.0"
path = "../../../yeho/packages/input/mouse"

```

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/input.mouse--mouseButtons-2bff80dc/usage --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## mouseButtons.AnyPressed

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

Verification: type checked

```yh
using input.mouse

// Any pressed.
mouseButtons instance = mouseButtons(true, true, true, true, true)
bool result = instance.AnyPressed()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.input_mouse__mousebuttons"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "input.mouse"
version = "0.1.0"
path = "../../../yeho/packages/input/mouse"

```

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/input.mouse--mouseButtons-2bff80dc/method-AnyPressed-6 --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/input/mouse/mouse.yh

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