{"id":"ui--yuiCompositionPlan","name":"yuiCompositionPlan","owner":"yeho","package":"ui","kind":"thing","signature":"external thing yuiCompositionPlan","description":"A yui composition plan record carrying schema, schemaVersion, surfaceId, targets, layers, and related state.","context":"Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.","parameters":[],"returns":"void","members":[{"name":"schema","kind":"field","type":"text","description":"Stores schema as text.","signature":"text schema","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"schemaVersion","kind":"field","type":"int","description":"Stores schema version as int.","signature":"int schemaVersion","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"surfaceId","kind":"field","type":"text","description":"Stores surface id as text.","signature":"text surfaceId","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"targets","kind":"field","type":"list of yuiRenderTarget","description":"Stores targets as list of yuiRenderTarget.","signature":"list of yuiRenderTarget targets","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"layers","kind":"field","type":"list of yuiRenderLayer","description":"Stores layers as list of yuiRenderLayer.","signature":"list of yuiRenderLayer layers","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"batches","kind":"field","type":"list of yuiRenderBatch","description":"Stores batches as list of yuiRenderBatch.","signature":"list of yuiRenderBatch batches","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"commandCount","kind":"field","type":"int","description":"Stores command count as int.","signature":"int commandCount","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"offscreenTargetCount","kind":"field","type":"int","description":"Stores offscreen target count as int.","signature":"int offscreenTargetCount","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"diagnostic","kind":"field","type":"text","description":"Stores diagnostic as text.","signature":"text diagnostic","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"yuiCompositionPlan","kind":"constructor","parameters":[{"name":"surfaceId","type":"text","description":"Surface id."}],"returns":"void","signature":"yuiCompositionPlan(text surfaceId)","description":"Yui composition plan.","tags":["thing","constructor","ui"],"updated":"2026-09-09"},{"name":"Reset","kind":"method","parameters":[{"name":"surfaceId","type":"text","description":"Surface id."}],"returns":"bool","signature":"Reset(text surfaceId) returns bool","description":"Reset.","tags":["thing","method","ui"],"exampleId":"method-Reset-10","updated":"2026-09-09"},{"name":"TargetIndex","kind":"method","parameters":[{"name":"id","type":"text","description":"Id."}],"returns":"int","signature":"TargetIndex(text id) returns int","description":"Target index.","tags":["thing","method","ui"],"exampleId":"method-TargetIndex-11","updated":"2026-09-09"},{"name":"LayerIndex","kind":"method","parameters":[{"name":"id","type":"text","description":"Id."}],"returns":"int","signature":"LayerIndex(text id) returns int","description":"Layer index.","tags":["thing","method","ui"],"exampleId":"method-LayerIndex-12","updated":"2026-09-09"},{"name":"AddTarget","kind":"method","parameters":[{"name":"target","type":"yuiRenderTarget","description":"Target."}],"returns":"bool","signature":"AddTarget(yuiRenderTarget target) returns bool","description":"Add target.","tags":["thing","method","ui"],"exampleId":"method-AddTarget-13","updated":"2026-09-09"},{"name":"AddLayer","kind":"method","parameters":[{"name":"layer","type":"yuiRenderLayer","description":"Layer."}],"returns":"bool","signature":"AddLayer(yuiRenderLayer layer) returns bool","description":"Add layer.","tags":["thing","method","ui"],"exampleId":"method-AddLayer-14","updated":"2026-09-09"},{"name":"BuildBatches","kind":"method","parameters":[{"name":"displayList","type":"yuiDisplayList original","description":"Display list."}],"returns":"bool","signature":"BuildBatches(yuiDisplayList original displayList) returns bool","description":"Build batches.","tags":["thing","method","ui"],"exampleId":"method-BuildBatches-15","updated":"2026-09-09"},{"name":"RenderReport","kind":"method","parameters":[],"returns":"text","signature":"RenderReport() returns text","description":"Render report.","tags":["thing","method","ui"],"exampleId":"method-RenderReport-16","updated":"2026-09-09"}],"tags":["cpu","method","source-example","thing","ui","yeho"],"updated":"2026-09-09","source":{"repository":"yeho","path":"packages/ui/render-20-composition.yh","line":20,"sha256":"75fcbc2bac833dffd9c1748ff9b9dac1f27de61fa717cca81b19209f46122a25"},"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 yuiCompositionPlan","description":"A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.","code":"using ui\n\n// Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.\nyuiCompositionPlan sample = yuiCompositionPlan(\"surface Id\")\nConsole.Log(Text.From(sample.schema))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuicompositionplan\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"graphics.image\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/image\"\n\n[[dependencies]]\npackage = \"graphics.text\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/text\"\n\n[[dependencies]]\npackage = \"host.ui_services\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/host/ui_services\"\n\n[[dependencies]]\npackage = \"ui\"\nversion = \"0.2.0\"\npath = \"../../../yeho/packages/ui\"\n","tags":["cpu","source-example"],"verification":"type checked","run":"cpu-oracle","sha256":"0341e53f2e8192f8be467f7a0c60799b51c5db8610d2c040d6861dd8888a5cde","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Reset-10","title":"yuiCompositionPlan.Reset","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Reset.\nyuiCompositionPlan instance = yuiCompositionPlan(\"surface Id\")\ntext argument_surfaceId = \"argument surface Id\"\nbool result = instance.Reset(argument_surfaceId)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuicompositionplan\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"graphics.image\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/image\"\n\n[[dependencies]]\npackage = \"graphics.text\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/text\"\n\n[[dependencies]]\npackage = \"host.ui_services\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/host/ui_services\"\n\n[[dependencies]]\npackage = \"ui\"\nversion = \"0.2.0\"\npath = \"../../../yeho/packages/ui\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"34649c023f2175bb36c662d869418c8db9342af331dea9ef5e60e7efe7a00ce2","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-TargetIndex-11","title":"yuiCompositionPlan.TargetIndex","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Target index.\nyuiCompositionPlan instance = yuiCompositionPlan(\"surface Id\")\ntext argument_id = \"argument id\"\nint result = instance.TargetIndex(argument_id)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuicompositionplan\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"graphics.image\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/image\"\n\n[[dependencies]]\npackage = \"graphics.text\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/text\"\n\n[[dependencies]]\npackage = \"host.ui_services\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/host/ui_services\"\n\n[[dependencies]]\npackage = \"ui\"\nversion = \"0.2.0\"\npath = \"../../../yeho/packages/ui\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"5b699047713bc07cfe1d48213db713ed9db1084101c0eb4180c0fc456646a98d","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-LayerIndex-12","title":"yuiCompositionPlan.LayerIndex","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Layer index.\nyuiCompositionPlan instance = yuiCompositionPlan(\"surface Id\")\ntext argument_id = \"argument id\"\nint result = instance.LayerIndex(argument_id)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuicompositionplan\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"graphics.image\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/image\"\n\n[[dependencies]]\npackage = \"graphics.text\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/text\"\n\n[[dependencies]]\npackage = \"host.ui_services\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/host/ui_services\"\n\n[[dependencies]]\npackage = \"ui\"\nversion = \"0.2.0\"\npath = \"../../../yeho/packages/ui\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"84df05eeaa058abf6c89ed12f777c5a79a6914ac0b333a1496de0bd77ecb611b","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-AddTarget-13","title":"yuiCompositionPlan.AddTarget","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Add target.\nyuiCompositionPlan instance = yuiCompositionPlan(\"surface Id\")\nyuiRenderTarget argument_target = yuiRenderTarget(\"id\", \"kind\", 1, 1, \"png\", 1, \"clear Role\")\nbool result = instance.AddTarget(argument_target)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuicompositionplan\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"graphics.image\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/image\"\n\n[[dependencies]]\npackage = \"graphics.text\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/text\"\n\n[[dependencies]]\npackage = \"host.ui_services\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/host/ui_services\"\n\n[[dependencies]]\npackage = \"ui\"\nversion = \"0.2.0\"\npath = \"../../../yeho/packages/ui\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"be454e9a4faf805853c58d002bfb15c840d6464737ece44049012dd6d20a54d5","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-AddLayer-14","title":"yuiCompositionPlan.AddLayer","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Add layer.\nyuiCompositionPlan instance = yuiCompositionPlan(\"surface Id\")\nyuiRenderLayer argument_layer = yuiRenderLayer(\"id\", \"target Id\", 1, 1, \"blend\", true)\nbool result = instance.AddLayer(argument_layer)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuicompositionplan\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"graphics.image\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/image\"\n\n[[dependencies]]\npackage = \"graphics.text\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/text\"\n\n[[dependencies]]\npackage = \"host.ui_services\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/host/ui_services\"\n\n[[dependencies]]\npackage = \"ui\"\nversion = \"0.2.0\"\npath = \"../../../yeho/packages/ui\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"8a2de6f6d2d6846cc1931fca113cc36c187f97cd2795d251e10294b1d2c8de0f","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-BuildBatches-15","title":"yuiCompositionPlan.BuildBatches","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Build batches.\nyuiCompositionPlan instance = yuiCompositionPlan(\"surface Id\")\nyuiDisplayList argument_displayList = yuiDisplayList(\"surface Id\")\nbool result = instance.BuildBatches(argument_displayList)\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuicompositionplan\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"graphics.image\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/image\"\n\n[[dependencies]]\npackage = \"graphics.text\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/text\"\n\n[[dependencies]]\npackage = \"host.ui_services\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/host/ui_services\"\n\n[[dependencies]]\npackage = \"ui\"\nversion = \"0.2.0\"\npath = \"../../../yeho/packages/ui\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"9487fbeb6c927da7d0258b8f331b76285aa1b007fb2e1c3f860e5486f0cd719b","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-RenderReport-16","title":"yuiCompositionPlan.RenderReport","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Render report.\nyuiCompositionPlan instance = yuiCompositionPlan(\"surface Id\")\ntext result = instance.RenderReport()\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuicompositionplan\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"graphics.image\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/image\"\n\n[[dependencies]]\npackage = \"graphics.text\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/graphics/text\"\n\n[[dependencies]]\npackage = \"host.ui_services\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/host/ui_services\"\n\n[[dependencies]]\npackage = \"ui\"\nversion = \"0.2.0\"\npath = \"../../../yeho/packages/ui\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"1d0cba3d6f303d9449b936655336c22d683aa20b9217fe576eec67c68b1ff07a","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null}],"searchTerms":["schema","schemaVersion","surfaceId","targets","layers","batches","commandCount","offscreenTargetCount","diagnostic","yuiCompositionPlan","Reset","TargetIndex","LayerIndex","AddTarget","AddLayer","BuildBatches","RenderReport"],"url":"https://demonhunterlabs.com/academy/api?item=ui--yuiCompositionPlan","json":"https://demonhunterlabs.com/reference/items/ui--yuiCompositionPlan.json","markdown":"https://demonhunterlabs.com/reference/text/ui--yuiCompositionPlan.md"}