frontend.yui · function ·
CreateYuiPersistentCanvasFrameFromRetainedPlanV1
Create yui persistent canvas frame from retained plan v1 from the supplied values.
Turn YUI models into a working frontend and its rendering/input adapters.
external CreateYuiPersistentCanvasFrameFromRetainedPlanV1(yuiRetainedFramePlan original plan, bool fullRedraw, int backgroundRed, int backgroundGreen, int backgroundBlue, text source) returns yuiPersistentCanvasFrameV1Status: source-declared
Parameters
yuiRetainedFramePlan original plan- Supply plan as yuiRetainedFramePlan original.
bool fullRedraw- Supply full redraw as bool.
int backgroundRed- Supply background red as int.
int backgroundGreen- Supply background green as int.
int backgroundBlue- Supply background blue as int.
text source- Supply source as text.
Use CreateYuiPersistentCanvasFrameFromRetainedPlanV1
A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.
cpu · source-example · type checked
using frontend.yui
// Turn YUI models into a working frontend and its rendering/input adapters.
yuiRetainedFramePlan plan = yuiRetainedFramePlan("surface Id", "reason")
bool fullRedraw = true
int backgroundRed = 1
int backgroundGreen = 1
int backgroundBlue = 1
text source = "example"
yuiPersistentCanvasFrameV1 result = CreateYuiPersistentCanvasFrameFromRetainedPlanV1(plan, fullRedraw, backgroundRed, backgroundGreen, backgroundBlue, source)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.frontend_yui__createyuipersistentcanvasframefromretainedplanv1"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"
[app]
kind = "headless"
[[dependencies]]
package = "frontend.yui"
version = "0.2.0"
path = "../../../yeho/packages/frontend/yui"
[[dependencies]]
package = "graphics.canvas"
version = "0.1.0"
path = "../../../yeho/packages/graphics/canvas"
[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"
[[dependencies]]
package = "graphics.image.processing"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image/processing"
[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"
[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"
[[dependencies]]
package = "input.text"
version = "0.1.0"
path = "../../../yeho/packages/input/text"
[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"
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/frontend/yui/render-persistent_canvas.yh:879