{"id":"input.mouse--SetMouseRelativeMode","name":"SetMouseRelativeMode","owner":"yeho","package":"input.mouse","kind":"function","signature":"external SetMouseRelativeMode(bool enabled) -> bool","description":"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.","context":"Read mouse position, buttons, and relative input for native interactions.","parameters":[{"name":"enabled","type":"bool","description":"Supply enabled as bool."}],"returns":"bool","members":[],"tags":["cpu","function","input","input.mouse","mouse","source-example","yeho"],"updated":"2026-09-09","source":{"repository":"yeho","path":"packages/input/mouse/mouse.yh","line":92,"sha256":"a5cc47e935de36ef75b762c9e99443a266ac5906884f1d657528aeb744667047"},"status":"source-declared","notes":["Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup."],"examples":[{"id":"usage","title":"Use SetMouseRelativeMode","description":"A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.","code":"using input.mouse\n\n// Read mouse position, buttons, and relative input for native interactions.\nbool enabled = true\nbool result = SetMouseRelativeMode(enabled)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.input_mouse__setmouserelativemode\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"input.mouse\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/input/mouse\"\n","tags":["cpu","source-example"],"verification":"type checked","run":"cpu-oracle","sha256":"4aeb0392bc11c12e38d0cf2c561672aca519851fa13279084ed46cdc7dd52099","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null}],"searchTerms":[],"url":"https://demonhunterlabs.com/academy/api?item=input.mouse--SetMouseRelativeMode","json":"https://demonhunterlabs.com/reference/items/input.mouse--SetMouseRelativeMode.json","markdown":"https://demonhunterlabs.com/reference/text/input.mouse--SetMouseRelativeMode.md"}