Skip to content
Project referenceDevelopmentEngine ccf7d03f
Authored
  • Backend-neutral retained documents, execution scopes, input, events and immutable rendering deltas.

This project defines the retained UI contract without selecting a native layout library, GPU renderer or scene implementation. Start with displaying a UI document. Backend authors also use the explicit provider and frame-building interfaces.

Create a context with positive physical pixel dimensions and a finite positive density. Documents belong to that context. Hide preserves document state; close releases it; context destruction ends all of its documents. Handles are assigned only by an owner and must not be serialized as persistent identities or reused after retirement.

Document sources and fragments carry an explicit language identity. Imported documents additionally identify their required implementation. SetText accepts plain Unicode; SetContent accepts intentional language-specific markup. Mutation booleans report an existing target and applied operation, not an old/new value comparison.

Update advances interaction/layout. DrainEvents transfers the backend’s queued event snapshot. Render returns immutable resource deltas and ordered commands; it does not submit GPU work. Consumers preserve retained resources between frames, apply premultiplied RGBA8 texture updates, and retire GPU allocations under their own in-flight protection.

Host infrastructure uses IUiService explicitly. Runtime scripts use the projected InnoEngine.UI namespace and a host-bound UI facade. The current export manifest includes UiInputSnapshot, document/font asset data, handles, events and render-frame data. Backend capabilities, IUiBackend, font registration and UiRenderFrameBuilder remain host/backend contracts.

Execution scopes bind an owner and must be released in strict last-in-first-out order. They do not make native operations concurrent or move them to an owner thread. No active scope is an explicit failure.

UiTextureData copies its input pixels. Backend frame builders take exclusive ownership of supplied update arrays; callers must never mutate them after transfer. Retirement frames copy their supplied handle arrays. Immutable managed data does not extend a native handle’s valid lifetime.

Capability selection is explicit. Unsupported languages or face selection must remain visible failures; a backend must not silently choose another implementation. Default/unassigned handle structs are not valid resources.

Read UI lifetimes and render-frame consumption before implementing a consumer.

Browse types and exact member contracts.

The compiler-selected script declarations are separate from this project’s host CLR surface. Read the script calling guide and the associated module contracts before using a projected member.

Project: Inno.UI
Source: src/services/ui/Inno.UI/Inno.UI.csproj

Type API Description
IUiBackend engine Defines the replaceable document, layout, input, and draw-geometry backend boundary.
IUiService engine Provides retained-mode documents and backend-neutral UI frames to scripts and rendering plugins.
UI engine Provides script-friendly retained-mode UI operations.
UiBackendCapabilities engine Describes optional behavior implemented by one UI backend generation.
UiBackendCapability engine Identifies an optional backend behavior requested by a caller.
UiCapabilityUnavailableException engine Reports that the selected backend cannot perform an explicitly requested optional operation.
UiClipRectangle engine Defines an integer clipping rectangle in UI surface coordinates.
UiContextHandle engine Identifies one UI context owned by the active UI service generation.
UiContextOptions engine Defines one independent UI layout and interaction surface.
UiDocumentAsset engine Represents one imported, language-tagged UI document source.
UiDocumentFontFace engine Identifies one imported font face owned by a single UI document.
UiDocumentFragment engine Contains a language-tagged fragment for a backend-specific document mutation.
UiDocumentHandle engine Identifies one document owned by a UI context.
UiDocumentLanguageId engine Identifies a document source language independently from any UI backend implementation.
UiDocumentSource engine Contains immutable text in one explicitly selected UI document language.
UiDrawCommand engine Describes one draw of a previously published mesh.
UiEvent engine Describes one queued document event after a context update.
UiEventType engine Identifies one document event made visible to game code.
UiExecutionContext engine Binds one UI service to the current asynchronous execution context.
UiFontRegistration engine Describes one encoded font face registration across the neutral backend boundary.
UiInputSnapshot engine Carries one immutable input snapshot across the UI backend boundary.
UiMeshHandle engine Identifies one backend-owned immutable mesh generation.
UiMeshUpdate engine Publishes one immutable mesh generation to a rendering plugin.
UiRenderFrame engine Contains incremental resource changes and ordered draw commands for one UI context.
UiRenderFrameBuilder engine Builds one immutable backend-neutral frame while transferring ownership of update arrays.
UiTextureData engine Contains immutable RGBA8 texture pixels addressable by a document source name.
UiTextureHandle engine Identifies one backend-owned immutable texture generation.
UiTextureUpdate engine Publishes one immutable premultiplied RGBA8 texture generation.
UiVertex engine Describes one vertex in backend-neutral UI draw geometry.
IUiService Runtime Provides retained-mode documents and backend-neutral UI frames to scripts and rendering plugins.
UI Runtime Provides script-friendly retained-mode UI operations.
UiClipRectangle Runtime Defines an integer clipping rectangle in UI surface coordinates.
UiContextHandle Runtime Identifies one UI context owned by the active UI service generation.
UiContextOptions Runtime Defines one independent UI layout and interaction surface.
UiDocumentAsset Runtime Represents one imported, language-tagged UI document source.
UiDocumentFontFace Runtime Identifies one imported font face owned by a single UI document.
UiDocumentFragment Runtime Contains a language-tagged fragment for a backend-specific document mutation.
UiDocumentHandle Runtime Identifies one document owned by a UI context.
UiDocumentLanguageId Runtime Identifies a document source language independently from any UI backend implementation.
UiDocumentSource Runtime Contains immutable text in one explicitly selected UI document language.
UiDrawCommand Runtime Describes one draw of a previously published mesh.
UiEvent Runtime Describes one queued document event after a context update.
UiEventType Runtime Identifies one document event made visible to game code.
UiExecutionContext Runtime Binds one UI service to the current asynchronous execution context.
UiInputSnapshot Runtime Carries one immutable input snapshot across the UI backend boundary.
UiMeshHandle Runtime Identifies one backend-owned immutable mesh generation.
UiMeshUpdate Runtime Publishes one immutable mesh generation to a rendering plugin.
UiRenderFrame Runtime Contains incremental resource changes and ordered draw commands for one UI context.
UiTextureData Runtime Contains immutable RGBA8 texture pixels addressable by a document source name.
UiTextureHandle Runtime Identifies one backend-owned immutable texture generation.
UiTextureUpdate Runtime Publishes one immutable premultiplied RGBA8 texture generation.
UiVertex Runtime Describes one vertex in backend-neutral UI draw geometry.