ui · thing ·

yuiRetainedFramePlan

A yui retained frame plan record carrying surfaceId, retainedOwners, touchedOwners, rebuiltOwners, reusedOwners, and related state.

cpumethodsource-examplethinguiyeho

Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.

external thing yuiRetainedFramePlan

Status: source-declared

Fields and methods (29)
text surfaceId
Stores surface id as text.
int retainedOwners
Stores retained owners as int.
int touchedOwners
Stores touched owners as int.
int rebuiltOwners
Stores rebuilt owners as int.
int reusedOwners
Stores reused owners as int.
int compositedOwners
Stores composited owners as int.
int retainedSemanticOwners
Stores retained semantic owners as int.
int touchedSemanticOwners
Stores touched semantic owners as int.
int updatedSemanticOwners
Stores updated semantic owners as int.
int damageRegionCount
Stores damage region count as int.
int damageArea
Stores damage area as int.
int replayedCommands
Stores replayed commands as int.
bool redraw
Stores redraw as bool.
bool present
Stores present as bool.
list of yuiRetainedDamageRegion damageRegions
Stores damage regions as list of yuiRetainedDamageRegion.
list of yuiDisplayCommand replayCommands
Stores replay commands as list of yuiDisplayCommand.
list of text replayOwnerIds
Stores replay owner ids as list of text.
list of yuiRetainedSemanticFragment semanticUpdates
Stores semantic updates as list of yuiRetainedSemanticFragment.
int ownerIndexProbes
Stores owner index probes as int.
int spatialCellProbes
Stores spatial cell probes as int.
int spatialBucketsExamined
Stores spatial buckets examined as int.
int spatialOwnersExamined
Stores spatial owners examined as int.
int replayOwners
Stores replay owners as int.
text reason
Stores reason as text.
text diagnostic
Stores diagnostic as text.
yuiRetainedFramePlan(text surfaceId, text reason)
Yui retained frame plan.
Idle() returns bool
Idle. Complete example
NativeIdle() returns bool
Native idle. Complete example
RenderReport() returns text
Render report. Complete example

Use yuiRetainedFramePlan

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

cpu · source-example · type checked

using ui

// Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.
yuiRetainedFramePlan sample = yuiRetainedFramePlan("surface Id", "reason")
Console.Log(Text.From(sample.surfaceId))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedframeplan"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[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 = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiRetainedFramePlan.Idle

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Idle.
yuiRetainedFramePlan instance = yuiRetainedFramePlan("surface Id", "reason")
bool result = instance.Idle()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedframeplan"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[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 = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiRetainedFramePlan.NativeIdle

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Native idle.
yuiRetainedFramePlan instance = yuiRetainedFramePlan("surface Id", "reason")
bool result = instance.NativeIdle()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedframeplan"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[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 = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

yuiRetainedFramePlan.RenderReport

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using ui

// Render report.
yuiRetainedFramePlan instance = yuiRetainedFramePlan("surface Id", "reason")
text result = instance.RenderReport()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedframeplan"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[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 = "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/ui/render-50-retained-fragments.yh:578