frontend.yui · function ·

ExecuteYuiPersistentCanvasRetainedPlanV1

Execute the planner payload against the currently selected persistent target. The display-list argument is the current immutable registry snapshot; its command list is intentionally ignored. Only plan.replayCommands can become native draws. A native-idle plan returns before registry copying, registry validation, persistent-surface inspection, drawing, or presenting.

cpufrontendfrontend.yuifunctionsource-exampleyehoyui

Turn YUI models into a working frontend and its rendering/input adapters.

external ExecuteYuiPersistentCanvasRetainedPlanV1(yuiDisplayList original currentRegistries, yuiRetainedFramePlan original plan, bool initializeFullSurface, int backgroundRed, int backgroundGreen, int backgroundBlue, text source) returns yuiPersistentCanvasExecutionV1

Status: source-declared

Parameters

yuiDisplayList original currentRegistries
Supply current registries as yuiDisplayList original.
yuiRetainedFramePlan original plan
Supply plan as yuiRetainedFramePlan original.
bool initializeFullSurface
Supply initialize full surface 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 ExecuteYuiPersistentCanvasRetainedPlanV1

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.
yuiDisplayList currentRegistries = yuiDisplayList("surface Id")
yuiRetainedFramePlan plan = yuiRetainedFramePlan("surface Id", "reason")
bool initializeFullSurface = true
int backgroundRed = 1
int backgroundGreen = 1
int backgroundBlue = 1
text source = "example"
yuiPersistentCanvasExecutionV1 result = ExecuteYuiPersistentCanvasRetainedPlanV1(currentRegistries, plan, initializeFullSurface, backgroundRed, backgroundGreen, backgroundBlue, source)
Console.Log("Inspect result in your debugger")
project.mech
manifestVersion = "2"
package = "api.example.frontend_yui__executeyuipersistentcanvasretainedplanv1"
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:972