{"id":"input.mouse--TakeRelativeMouseDelta","name":"TakeRelativeMouseDelta","owner":"yeho","package":"input.mouse","kind":"function","signature":"external TakeRelativeMouseDelta() returns mouseDelta","description":"TakeRelativeX performs the single packed atomic exchange and latches Y; TakeRelativeY completes that same snapshot. Keeping the pair behind this record-returning API prevents X/Y from crossing a message-pump boundary.","context":"Read mouse position, buttons, and relative input for native interactions.","parameters":[],"returns":"mouseDelta","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":100,"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 TakeRelativeMouseDelta","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.\nmouseDelta result = TakeRelativeMouseDelta()\nConsole.Log(\"Inspect result in your debugger\")\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.input_mouse__takerelativemousedelta\"\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":"72f15286d91798901c7627f23a2bfa43079d209d3d39325c5f0f97e8d72d829c","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null}],"searchTerms":[],"url":"https://demonhunterlabs.com/academy/api?item=input.mouse--TakeRelativeMouseDelta","json":"https://demonhunterlabs.com/reference/items/input.mouse--TakeRelativeMouseDelta.json","markdown":"https://demonhunterlabs.com/reference/text/input.mouse--TakeRelativeMouseDelta.md"}