{"id":"ui--uiSurfaceState","name":"uiSurfaceState","owner":"yeho","package":"ui","kind":"thing","signature":"external thing uiSurfaceState","description":"A ui surface state record carrying id, requestedWidth, requestedHeight, actualWidth, actualHeight, and related state.","context":"Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.","parameters":[],"returns":"void","members":[{"name":"id","kind":"field","type":"text","description":"Stores id as text.","signature":"text id","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"requestedWidth","kind":"field","type":"int","description":"Stores requested width as int.","signature":"int requestedWidth","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"requestedHeight","kind":"field","type":"int","description":"Stores requested height as int.","signature":"int requestedHeight","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"actualWidth","kind":"field","type":"int","description":"Stores actual width as int.","signature":"int actualWidth","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"actualHeight","kind":"field","type":"int","description":"Stores actual height as int.","signature":"int actualHeight","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"scalePercent","kind":"field","type":"int","description":"Stores scale percent as int.","signature":"int scalePercent","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"visible","kind":"field","type":"bool","description":"Stores visible as bool.","signature":"bool visible","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"enabled","kind":"field","type":"bool","description":"Stores enabled as bool.","signature":"bool enabled","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"focused","kind":"field","type":"bool","description":"Stores focused as bool.","signature":"bool focused","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"disposed","kind":"field","type":"bool","description":"Stores disposed as bool.","signature":"bool disposed","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"dirtyBlock","kind":"field","type":"bool","description":"Stores dirty block as bool.","signature":"bool dirtyBlock","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"dirtyLayout","kind":"field","type":"bool","description":"Stores dirty layout as bool.","signature":"bool dirtyLayout","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"dirtyViewport","kind":"field","type":"bool","description":"Stores dirty viewport as bool.","signature":"bool dirtyViewport","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"dirtyText","kind":"field","type":"bool","description":"Stores dirty text as bool.","signature":"bool dirtyText","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"dirtyLayer","kind":"field","type":"bool","description":"Stores dirty layer as bool.","signature":"bool dirtyLayer","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"lifecycle","kind":"field","type":"text","description":"Stores lifecycle as text.","signature":"text lifecycle","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"root","kind":"field","type":"text","description":"Stores root as text.","signature":"text root","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"focusOwner","kind":"field","type":"text","description":"Stores focus owner as text.","signature":"text focusOwner","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"pointerOwner","kind":"field","type":"text","description":"Stores pointer owner as text.","signature":"text pointerOwner","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"lastInput","kind":"field","type":"text","description":"Stores last input as text.","signature":"text lastInput","tags":["thing","field","ui"],"updated":"2026-09-09"},{"name":"frameReason","kind":"field","type":"text","description":"Stores frame reason as text.","signature":"text frameReason","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":"uiSurfaceState","kind":"constructor","parameters":[{"name":"id","type":"text","description":"Id."},{"name":"requestedWidth","type":"int","description":"Requested width."},{"name":"requestedHeight","type":"int","description":"Requested height."},{"name":"actualWidth","type":"int","description":"Actual width."},{"name":"actualHeight","type":"int","description":"Actual height."},{"name":"scalePercent","type":"int","description":"Scale percent."},{"name":"root","type":"text","description":"Root."}],"returns":"void","signature":"uiSurfaceState(text id, int requestedWidth, int requestedHeight, int actualWidth, int actualHeight, int scalePercent, text root)","description":"Ui surface state.","tags":["thing","constructor","ui"],"updated":"2026-09-09"},{"name":"MarkInvalid","kind":"method","parameters":[{"name":"message","type":"text","description":"Message."}],"returns":"uiSurfaceState","signature":"MarkInvalid(text message) returns uiSurfaceState","description":"Mark invalid.","tags":["thing","method","ui"],"exampleId":"method-MarkInvalid-23","updated":"2026-09-09"},{"name":"RenderLifecycle","kind":"method","parameters":[],"returns":"text","signature":"RenderLifecycle() returns text","description":"Render lifecycle.","tags":["thing","method","ui"],"exampleId":"method-RenderLifecycle-24","updated":"2026-09-09"},{"name":"RenderDirtyState","kind":"method","parameters":[],"returns":"text","signature":"RenderDirtyState() returns text","description":"Render dirty state.","tags":["thing","method","ui"],"exampleId":"method-RenderDirtyState-25","updated":"2026-09-09"}],"tags":["cpu","method","source-example","thing","ui","yeho"],"updated":"2026-09-09","source":{"repository":"yeho","path":"packages/ui/surface-surface.yh","line":88,"sha256":"7bd2b644c8330e50977ce280ec0003bba995d80ea276cb1d982acc5996ab2f13"},"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 uiSurfaceState","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.\nuiSurfaceState sample = uiSurfaceState(\"id\", 1, 1, 1, 1, 1, \"root\")\nConsole.Log(Text.From(sample.id))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__uisurfacestate\"\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":"6187c5622e0aeb58a84b2e0ad4dedfbe16af79fb55705cc11d583e6937484806","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-MarkInvalid-23","title":"uiSurfaceState.MarkInvalid","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Mark invalid.\nuiSurfaceState instance = uiSurfaceState(\"id\", 1, 1, 1, 1, 1, \"root\")\ntext argument_message = \"argument message\"\nuiSurfaceState result = instance.MarkInvalid(argument_message)\nConsole.Log(\"Inspect result in your debugger\")\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__uisurfacestate\"\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":"0abe7a34605c04db418754d435dd32cfdf7430a8cb86f82fee48c461b6f1c18d","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-RenderLifecycle-24","title":"uiSurfaceState.RenderLifecycle","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Render lifecycle.\nuiSurfaceState instance = uiSurfaceState(\"id\", 1, 1, 1, 1, 1, \"root\")\ntext result = instance.RenderLifecycle()\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__uisurfacestate\"\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":"1d09011e6ac4f411149173bd1776fdef6383382beff206b6ffbbf951215c6158","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-RenderDirtyState-25","title":"uiSurfaceState.RenderDirtyState","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using ui\n\n// Render dirty state.\nuiSurfaceState instance = uiSurfaceState(\"id\", 1, 1, 1, 1, 1, \"root\")\ntext result = instance.RenderDirtyState()\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.ui__uisurfacestate\"\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":"98086666b76c472dec6af37389f64c307ad674f58b719f82d9bd61b581e816e2","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null}],"searchTerms":["id","requestedWidth","requestedHeight","actualWidth","actualHeight","scalePercent","visible","enabled","focused","disposed","dirtyBlock","dirtyLayout","dirtyViewport","dirtyText","dirtyLayer","lifecycle","root","focusOwner","pointerOwner","lastInput","frameReason","diagnostic","uiSurfaceState","MarkInvalid","RenderLifecycle","RenderDirtyState"],"url":"https://demonhunterlabs.com/academy/api?item=ui--uiSurfaceState","json":"https://demonhunterlabs.com/reference/items/ui--uiSurfaceState.json","markdown":"https://demonhunterlabs.com/reference/text/ui--uiSurfaceState.md"}
