ui · class ·

yuiRetainedResourcePreparedCandidateBatchV1

A yui retained resource prepared candidate batch v1 object with the operations listed below.

classcpumethodsource-exampleuivalidationyeho

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

external class yuiRetainedResourcePreparedCandidateBatchV1

Status: source-declared

Fields and methods (17)
yuiRetainedResourcePreparedCandidateBatchV1(yuiRetainedResourceStoreIdentityV1 storeIdentity, int preparedRevision, bool accepted, text diagnostic, list of yuiRetainedResourcePreparedAdmissionV1 items, int overlayIndexComparisons, int unrelatedBaseEntriesInspected, int baseEntriesCopied)
Yui retained resource prepared candidate batch v1.
Admitted() returns bool
Admitted. Complete example
Revision() returns int
Revision. Complete example
Count() returns int
Count. Complete example
Validations() returns int
Validations. Complete example
ExplicitComparisons() returns int
Explicit comparisons. Complete example
PayloadComparisons() returns int
Payload comparisons. Complete example
BaseIndexComparisons() returns int
Base index comparisons. Complete example
OverlayIndexComparisons() returns int
Overlay index comparisons. Complete example
UnrelatedBaseEntriesInspected() returns int
Unrelated base entries inspected. Complete example
BaseEntriesCopied() returns int
Base entries copied. Complete example
Diagnostic() returns text
Diagnostic. Complete example
Consumed() returns bool
Consumed. Complete example
MatchesStore(yuiRetainedResourceStoreIdentityV1 identity) returns bool
Matches store. Its identity parameter is private. Use the owning store commit operation; it performs this comparison internally. Complete example
Consume()
Consume. Complete example
MatchesInputs(list of yuiRetainedOwnerFragment fragments, list of yuiRetainedResourceDeltaV1 deltas) returns bool
Matches inputs. Complete example
PreparedPlanAt(int index, yuiRetainedOwnerFragment fragment, yuiRetainedResourceDeltaV1 delta) returns yuiRetainedResourcePreflightV1
Prepared plan at. Complete example

Preflight a HUD resource update

Ask the owning resource store to create a prepared result. Its internal identity is private; inspect admission and diagnostics before committing.

cpu · ui · validation · executed

using ui

yuiRetainedResourceStoreV1 store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment fragments = [fragment]
list of yuiRetainedResourceDeltaV1 deltas = [delta]
yuiRetainedResourcePreparedCandidateBatchV1 prepared = store.PrepareCandidateBatch(fragments, deltas, 0)
Console.Log(Text.From(prepared.Admitted()))
Console.Log(prepared.Diagnostic())
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.Admitted

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

// Admitted.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
bool result = instance.Admitted()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.Revision

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

// Revision.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
int result = instance.Revision()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.Count

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

// Count.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
int result = instance.Count()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.Validations

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

// Validations.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
int result = instance.Validations()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.ExplicitComparisons

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

// Explicit comparisons.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
int result = instance.ExplicitComparisons()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.PayloadComparisons

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

// Payload comparisons.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
int result = instance.PayloadComparisons()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.BaseIndexComparisons

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

// Base index comparisons.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
int result = instance.BaseIndexComparisons()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.OverlayIndexComparisons

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

// Overlay index comparisons.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
int result = instance.OverlayIndexComparisons()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.UnrelatedBaseEntriesInspected

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

// Unrelated base entries inspected.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
int result = instance.UnrelatedBaseEntriesInspected()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.BaseEntriesCopied

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

// Base entries copied.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
int result = instance.BaseEntriesCopied()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.Diagnostic

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

// Diagnostic.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
text result = instance.Diagnostic()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.Consumed

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

// Consumed.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
bool result = instance.Consumed()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.MatchesStore

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

yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
// MatchesStore uses a private store identity. Let the owning store check it.
instance_store.CommitPreparedCandidateBatch(instance, instance_fragments, instance_deltas)
Console.Log("Store identity was checked by the owner")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.Consume

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

// Consume.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
instance.Consume()
Console.Log("Consume completed")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.MatchesInputs

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

// Matches inputs.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
list of yuiRetainedOwnerFragment argument_fragments = []
list of yuiRetainedResourceDeltaV1 argument_deltas = []
bool result = instance.MatchesInputs(argument_fragments, argument_deltas)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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"

yuiRetainedResourcePreparedCandidateBatchV1.PreparedPlanAt

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

// Prepared plan at.
yuiRetainedResourceStoreV1 instance_store = CreateYuiRetainedResourceStoreV1("hud")
yuiRetainedOwnerFragment instance_fragment = yuiRetainedOwnerFragment("player-panel", 1, 0, yuiRenderBounds(0, 0, 100, 40), yuiRenderBounds(0, 0, 100, 40), yuiFragmentDependencySignature("layout", "paint", "resources", "motion", "composite", "example"), "example")
yuiRetainedResourceDeltaV1 instance_delta = yuiRetainedResourceDeltaV1("hud")
list of yuiRetainedOwnerFragment instance_fragments = [instance_fragment]
list of yuiRetainedResourceDeltaV1 instance_deltas = [instance_delta]
yuiRetainedResourcePreparedCandidateBatchV1 instance = instance_store.PrepareCandidateBatch(instance_fragments, instance_deltas, 0)
int argument_index = 1
yuiRetainedOwnerFragment argument_fragment = yuiRetainedOwnerFragment("owner Id", 1, 1, yuiRenderBounds(1, 1, 1, 1), yuiRenderBounds(1, 1, 1, 1), yuiFragmentDependencySignature("layout Key", "paint Key", "resource Key", "motion Key", "composite Key", "example"), "example")
yuiRetainedResourceDeltaV1 argument_delta = yuiRetainedResourceDeltaV1("surface Id")
instance.PreparedPlanAt(argument_index, argument_fragment, argument_delta)
Console.Log("PreparedPlanAt completed")
project.mech
manifestVersion = "2"
package = "api.example.ui__yuiretainedresourcepreparedcandidatebatchv1"
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-60-retained-resource-snapshots.yh:444