{"id":"ui--yuiRetainedFramePlan","name":"yuiRetainedFramePlan","owner":"yeho","package":"ui","kind":"thing","signature":"external thing yuiRetainedFramePlan","description":"A yui retained frame plan record carrying surfaceId, retainedOwners, touchedOwners, rebuiltOwners, reusedOwners, and related state.","context":"Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.","parameters":[],"returns":"void","members":[{"name":"surfaceId","kind":"field","type":"text","description":"Stores surface id as text.","signature":"text surfaceId","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"retainedOwners","kind":"field","type":"int","description":"Stores retained owners as int.","signature":"int retainedOwners","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"touchedOwners","kind":"field","type":"int","description":"Stores touched owners as int.","signature":"int touchedOwners","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"rebuiltOwners","kind":"field","type":"int","description":"Stores rebuilt owners as int.","signature":"int rebuiltOwners","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"reusedOwners","kind":"field","type":"int","description":"Stores reused owners as int.","signature":"int reusedOwners","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"compositedOwners","kind":"field","type":"int","description":"Stores composited owners as int.","signature":"int compositedOwners","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"retainedSemanticOwners","kind":"field","type":"int","description":"Stores retained semantic owners as int.","signature":"int retainedSemanticOwners","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"touchedSemanticOwners","kind":"field","type":"int","description":"Stores touched semantic owners as int.","signature":"int touchedSemanticOwners","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"updatedSemanticOwners","kind":"field","type":"int","description":"Stores updated semantic owners as int.","signature":"int updatedSemanticOwners","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"damageRegionCount","kind":"field","type":"int","description":"Stores damage region count as int.","signature":"int damageRegionCount","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"damageArea","kind":"field","type":"int","description":"Stores damage area as int.","signature":"int damageArea","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"replayedCommands","kind":"field","type":"int","description":"Stores replayed commands as int.","signature":"int replayedCommands","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"redraw","kind":"field","type":"bool","description":"Stores redraw as bool.","signature":"bool redraw","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"present","kind":"field","type":"bool","description":"Stores present as bool.","signature":"bool present","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"damageRegions","kind":"field","type":"list of yuiRetainedDamageRegion","description":"Stores damage regions as list of yuiRetainedDamageRegion.","signature":"list of yuiRetainedDamageRegion damageRegions","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"replayCommands","kind":"field","type":"list of yuiDisplayCommand","description":"Stores replay commands as list of yuiDisplayCommand.","signature":"list of yuiDisplayCommand replayCommands","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"replayOwnerIds","kind":"field","type":"list of text","description":"Stores replay owner ids as list of text.","signature":"list of text replayOwnerIds","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"semanticUpdates","kind":"field","type":"list of yuiRetainedSemanticFragment","description":"Stores semantic updates as list of yuiRetainedSemanticFragment.","signature":"list of yuiRetainedSemanticFragment semanticUpdates","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"ownerIndexProbes","kind":"field","type":"int","description":"Stores owner index probes as int.","signature":"int ownerIndexProbes","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"spatialCellProbes","kind":"field","type":"int","description":"Stores spatial cell probes as int.","signature":"int spatialCellProbes","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"spatialBucketsExamined","kind":"field","type":"int","description":"Stores spatial buckets examined as int.","signature":"int spatialBucketsExamined","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"spatialOwnersExamined","kind":"field","type":"int","description":"Stores spatial owners examined as int.","signature":"int spatialOwnersExamined","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"replayOwners","kind":"field","type":"int","description":"Stores replay owners as int.","signature":"int replayOwners","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"reason","kind":"field","type":"text","description":"Stores reason as text.","signature":"text reason","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":"yuiRetainedFramePlan","kind":"constructor","parameters":[{"name":"surfaceId","type":"text","description":"Surface id."},{"name":"reason","type":"text","description":"Reason."}],"returns":"void","signature":"yuiRetainedFramePlan(text surfaceId, text reason)","description":"Yui retained frame plan.","tags":["thing","constructor","ui"],"updated":"2026-09-09"},{"name":"Idle","kind":"method","parameters":[],"returns":"bool","signature":"Idle() returns bool","description":"Idle.","tags":["thing","method","ui"],"exampleId":"method-Idle-26","updated":"2026-09-09"},{"name":"NativeIdle","kind":"method","parameters":[],"returns":"bool","signature":"NativeIdle() returns bool","description":"Native idle.","tags":["thing","method","ui"],"exampleId":"method-NativeIdle-27","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-28","updated":"2026-09-09"}],"tags":["cpu","method","source-example","thing","ui","yeho"],"updated":"2026-09-09","source":{"repository":"yeho","path":"packages/ui/render-50-retained-fragments.yh","line":578,"sha256":"1062403654e37b95d0b190990ad54290638b64d047aa164ee82220bd91ac0674"},"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 yuiRetainedFramePlan","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.\nyuiRetainedFramePlan sample = yuiRetainedFramePlan(\"surface Id\", \"reason\")\nConsole.Log(Text.From(sample.surfaceId))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuiretainedframeplan\"\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":"20736579e5be8ea968b365d3d688abbe3bb2e4473a4c5ab7a810ae016d0fd520","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Idle-26","title":"yuiRetainedFramePlan.Idle","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Idle.\nyuiRetainedFramePlan instance = yuiRetainedFramePlan(\"surface Id\", \"reason\")\nbool result = instance.Idle()\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuiretainedframeplan\"\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":"59e4bf00da8dde210d524415cd5575861562108a22f04e4c74639fbf132e1db8","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-NativeIdle-27","title":"yuiRetainedFramePlan.NativeIdle","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Native idle.\nyuiRetainedFramePlan instance = yuiRetainedFramePlan(\"surface Id\", \"reason\")\nbool result = instance.NativeIdle()\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuiretainedframeplan\"\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":"ea161af78785af0b72f4fb45c03a5382041d80483bc2092f6424b1fe42a08d7c","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-RenderReport-28","title":"yuiRetainedFramePlan.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.\nyuiRetainedFramePlan instance = yuiRetainedFramePlan(\"surface Id\", \"reason\")\ntext result = instance.RenderReport()\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__yuiretainedframeplan\"\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":"3464af36753cab17ab594d7a3470d94a62a4199f66ae978327e74e5f1ad92c9c","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null}],"searchTerms":["surfaceId","retainedOwners","touchedOwners","rebuiltOwners","reusedOwners","compositedOwners","retainedSemanticOwners","touchedSemanticOwners","updatedSemanticOwners","damageRegionCount","damageArea","replayedCommands","redraw","present","damageRegions","replayCommands","replayOwnerIds","semanticUpdates","ownerIndexProbes","spatialCellProbes","spatialBucketsExamined","spatialOwnersExamined","replayOwners","reason","diagnostic","yuiRetainedFramePlan","Idle","NativeIdle","RenderReport"],"url":"https://demonhunterlabs.com/academy/api?item=ui--yuiRetainedFramePlan","json":"https://demonhunterlabs.com/reference/items/ui--yuiRetainedFramePlan.json","markdown":"https://demonhunterlabs.com/reference/text/ui--yuiRetainedFramePlan.md"}