input.mouse · function ·

SetMouseRelativeMode

Relative mode uses raw foreground mouse input. The runtime hides and clips the cursor while focused, releases it on focus loss, and restores capture when focus returns.

cpufunctioninputinput.mousemousesource-exampleyeho

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

external SetMouseRelativeMode(bool enabled) -> bool

Status: source-declared

Parameters

bool enabled
Supply enabled as bool.

Use SetMouseRelativeMode

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

cpu · source-example · type checked

using input.mouse

// Read mouse position, buttons, and relative input for native interactions.
bool enabled = true
bool result = SetMouseRelativeMode(enabled)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.input_mouse__setmouserelativemode"
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"
Notes and source

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

yeho/packages/input/mouse/mouse.yh:92