{"id":"graphics.canvas--BeginCanvasOverlayFrame","name":"BeginCanvasOverlayFrame","owner":"yeho","package":"graphics.canvas","kind":"function","signature":"external BeginCanvasOverlayFrame() returns bool","description":"Preserve the current presentation target while establishing Canvas pixel coordinates and source-over state for a final 2D pass. This is the bounded transition from a provider-owned world pass; it neither clears nor presents.","context":"Draw 2D shapes, text, images, and composited interface content.","parameters":[],"returns":"bool","members":[],"tags":["canvas","cpu","function","graphics","graphics.canvas","source-example","yeho"],"updated":"2026-09-09","source":{"repository":"yeho","path":"packages/graphics/canvas/canvas.yh","line":9,"sha256":"6ccd4ec500a65b2f8a7447e335a0f6661c8b064e12be567abc0974e818716f45"},"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 BeginCanvasOverlayFrame","description":"A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.","code":"using graphics.canvas\n\n// Draw 2D shapes, text, images, and composited interface content.\nbool result = BeginCanvasOverlayFrame()\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.graphics_canvas__begincanvasoverlayframe\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"graphics.canvas\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/canvas\"\n","tags":["cpu","source-example"],"verification":"type checked","run":"cpu-oracle","sha256":"68d0ec7989228c58413eee44a7d8a8f6bfb32a9ef24151d53ffa9d97370d070b","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null}],"searchTerms":[],"url":"https://demonhunterlabs.com/academy/api?item=graphics.canvas--BeginCanvasOverlayFrame","json":"https://demonhunterlabs.com/reference/items/graphics.canvas--BeginCanvasOverlayFrame.json","markdown":"https://demonhunterlabs.com/reference/text/graphics.canvas--BeginCanvasOverlayFrame.md"}