ui · thing · Updated 2026-09-09

yuiDisplayList

A yui display list record carrying schema, schemaVersion, commandVersion, surfaceId, commands, and related state.

cpumethodsource-examplethinguiyeho

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

external thing yuiDisplayList

Status: source-declared

Fields and methods (37)

text schema: Stores schema as text.
int schemaVersion: Stores schema version as int.
int commandVersion: Stores command version as int.
text surfaceId: Stores surface id as text.
list of yuiDisplayCommand commands: Stores commands as list of yuiDisplayCommand.
list of yuiDisplayCommand reusableCommands: Stores reusable commands as list of yuiDisplayCommand.
list of yuiRenderPaint paints: Stores paints as list of yuiRenderPaint.
list of yuiRenderPaint reusablePaints: Stores reusable paints as list of yuiRenderPaint.
list of yuiRenderImageResource images: Stores images as list of yuiRenderImageResource.
list of yuiRenderGlyphAlphaResource glyphAlphaResources: Stores glyph alpha resources as list of yuiRenderGlyphAlphaResource.
int glyphAlphaBytes: Stores glyph alpha bytes as int.
list of int paintIdLengths: Stores paint id lengths as list of int.
list of int imageIdLengths: Stores image id lengths as list of int.
list of yuiRenderClip clips: Stores clips as list of yuiRenderClip.
list of yuiRenderTransform transforms: Stores transforms as list of yuiRenderTransform.
int revision: Stores revision as int.
text diagnostic: Stores diagnostic as text.
yuiDisplayList(text surfaceId): Yui display list.
Reset(text surfaceId) returns bool: Reset. Complete example
PaintIndex(text id) returns int: Paint index. Complete example
RegisterPaint(yuiRenderPaint paint) returns bool: Register paint. Complete example
RegisterReusablePaint(text id, int red, int green, int blue, int alpha, int radius, int borderWidth, int opacityPercent) returns bool: Register reusable paint. Complete example
ImageIndex(text id) returns int: Image index. Complete example
RegisterImage(yuiRenderImageResource image) returns bool: Register image. Complete example
GlyphAlphaIndex(text id) returns int: Glyph alpha index. Complete example
RegisterGlyphAlpha(yuiRenderGlyphAlphaResource resource) returns bool: Register glyph alpha. Complete example
ClipIndex(text id) returns int: Clip index. Complete example
RegisterClip(yuiRenderClip clip) returns bool: Register clip. Complete example
TransformIndex(text id) returns int: Transform index. Complete example
RegisterTransform(yuiRenderTransform transform) returns bool: Register transform. Complete example
KnownKind(text kind) returns bool: Known kind. Complete example
Append(yuiDisplayCommand command) returns bool: Append. Complete example
AppendReusable(int sequence, text ownerId, text kind, text layerId, text targetId, text resourceId, int resourceGeneration, text paintId, text clipId, text transformId, int x, int y, int width, int height, text semanticRole, text content) returns bool: Append reusable. Complete example
OwnerCommandCount(text ownerId) returns int: Owner command count. Complete example
ReplaceOwnerRole(text ownerId, text semanticRole) returns bool: Replace owner role. Complete example
Snapshot() returns text: Snapshot. Complete example
StableEquivalent(yuiDisplayList original other) returns bool: Stable equivalent. Complete example

Use yuiDisplayList

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.
yuiDisplayList sample = yuiDisplayList("surface Id")
Console.Log(Text.From(sample.schema))

project.mech

manifestVersion = "2"
package = "api.example.ui__yuidisplaylist"
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"