# ConsumeKeyPress

Consumes one non-repeated key-down edge. This remains true across a short down/up tap until the caller observes it, then returns false until the next physical press.

Last updated: 2026-09-09

Package: input.keyboard | Status: source-declared

Tags: cpu, function, input, input.keyboard, keyboard, source-example, yeho

Poll named keys for the active application window.

```yh
external ConsumeKeyPress(text key) -> bool
```


## Use ConsumeKeyPress

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

Verification: type checked

```yh
using input.keyboard

// Poll named keys for the active application window.
text key = "key"
bool result = ConsumeKeyPress(key)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

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

[app]
kind = "headless"

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

```

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.keyboard--ConsumeKeyPress/usage --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/keyboard/keyboard.yh

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