Skip to content
Project referenceDevelopmentEngine ccf7d03f
Authored
  • Backend-neutral viewport contributors, model composition, safe previews and authoring target artifacts.

Backend-neutral viewport contributors, model composition, safe previews and authoring target artifacts.

Compose a model without coupling the Editor

Section titled “Compose a model without coupling the Editor”

Contribute to a viewport explains purpose IDs, render routes, independent interaction priority, frame-scoped content and same-frame manipulation matrices. Multiple models need an explicit route and separate targets with compatible output format; there is no implicit cross-model depth sharing.

Opaque presentation output becomes ready only after the current target revision records its write. Preview release covers targets that have not produced an image and their persistent program scopes. Resident texture generation/size is rechecked after reimport. Wrong or absent contributors produce local diagnostics/unavailable state rather than exposing native handles or breaking unrelated Editor features.

Interactive draft Check requires tool output plus real device pipeline/link/reflection validation at a safe point and does not fall back to a stale preview as proof of success. The formal authoring artifact provider may retain last-good Ready output while compiling a replacement by content version. Pending, Failed and Unavailable remain distinct. PipelineDocuments records detached settings edits with full owner references through the shared draft/History service; Save and runtime activation are separate. Completed-frame Stats reports unavailable diagnostics explicitly.

These use the actual host contracts and borrowed live dependencies. They do not initialize a product or establish lifecycle/device acceptance.

using Inno.Editor.Rendering;
using Inno.Rendering;
using Inno.Rendering.Runtime;
public readonly record struct ViewportExtent(
int width,
int height
);
[EditorViewportContributorExtension("sample.viewport-extent", "sample.viewport")]
public sealed class ViewportExtentContributor : EditorViewportContributor
{
public override bool CanContribute(EditorViewportContext context)
=> context.pixelWidth > 0 && context.pixelHeight > 0;
public override EditorViewportContribution Build(EditorViewportContext context)
{
var data = new RenderFrameData();
data.Set(new RenderDataChannelId("sample.viewport-extent"),
new ViewportExtent(context.pixelWidth, context.pixelHeight));
return new EditorViewportContribution(data);
}
}

Source project. Declarations, script selection and runtime behavior require separate matching evidence.

Types and exact member contracts preserve captured declarations and source XML.

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.Editor.Rendering
Source: src/composition/editor/features/Inno.Editor.Rendering/Inno.Editor.Rendering.csproj

Type API Description
EditorGizmoContext engine Provides scene content and selection for transient Editor gizmos.
EditorGizmoFrame engine Holds the transient gizmo primitives for one Scene viewport frame.
EditorGizmoIcon engine One selectable Editor icon.
EditorGizmoLine engine One non-interactive Editor line.
EditorGizmoProvider engine Contributes Editor-only icons and bounds without modifying a rendering model.
EditorGizmoProviderExtensionAttribute engine Marks one reloadable Editor gizmo provider.
EditorPreviewHandle engine Identifies one preview texture owned by a specific rendering-device generation.
EditorRenderTargetArtifactProvider engine Produces target-specific render artifacts from imported authoring assets without exposing source access to the backend-neutral render runtime.

Stages Editor shader artifacts for device validation and preview.
EditorRenderingModule engine Composes reloadable rendering-model contributors while retaining only opaque presentation outputs.
EditorShaderArtifactValidationSnapshot engine Contains active-device validation state for one immutable Editor shader candidate.
EditorShaderCompilation engine Schedules Editor shader compilation for the active device without exposing native handles to authoring panels.
EditorShaderCompilationSnapshot engine Contains detached compiler state without retaining assets, tasks or extension instances.
EditorShaderCompilationState engine Identifies native compilation state independently of document persistence.
EditorShaderDraftCompilationSnapshot engine Contains a preview-only immutable candidate, never registered as a canonical asset artifact.
EditorViewportComposition engine Describes a complete ordered set of rendering-model layers targeting one Editor viewport.
EditorViewportContext engine Supplies frame-only Editor interaction and output dimensions to a contributor.
EditorViewportContribution engine Returns one rendering-model contribution without exposing a GPU backend.
EditorViewportContributor engine Contributes one rendering model while the host owns viewport composition, targets, and presentation.
EditorViewportContributorExtensionAttribute engine Marks a reloadable rendering-model contributor for one Editor viewport purpose.
EditorViewportFocusBounds engine Describes a world-space sphere that can be framed by host navigation.
EditorViewportKindId engine Identifies one open Editor viewport purpose without prescribing rendering semantics.
EditorViewportLayer engine Describes one model-neutral layer in an Editor viewport composition.
EditorViewportManipulationPlane engine Selects whether transform handles use all axes or a contributor-declared planar orientation.
EditorViewportManipulationSpace engine Describes the exact backend-neutral view and projection used to draw a viewport so host tools can manipulate selected scene transforms without knowing the controller’s camera model.
EditorViewportNavigationCapabilities engine Declares navigation operations supported by one viewport interaction controller.
EditorViewportNavigationMode engine Identifies the active interaction model without prescribing a rendering camera type.
EditorViewportNavigationProfile engine Describes how the host may navigate one provider-owned viewport without exposing the provider’s camera model.
EditorViewportNavigationProfileId engine Identifies a provider-defined navigation profile across reload generations.
EditorViewportNavigationState engine Stores rendering-model-neutral navigation state for one Editor viewport across provider reloads.
EditorViewportOutput engine Identifies a renderer-owned editor viewport image through an opaque presentation token.
EditorViewportPointerContext engine Supplies normalized pointer interaction over one rendered viewport.
EditorViewportPresentation engine Describes host-selected presentation preferences without prescribing rendering behavior.
EditorViewportProjection engine Identifies the projection family represented by neutral Editor viewport navigation state.
IEditorGizmoSink engine Receives transient world-space gizmo geometry from independent Editor extensions.
IEditorPreviewService engine Provides one shared preview texture bridge for browsers, inspectors, and document canvases.
IEditorRenderingHost engine Bridges editor extensions to a host-owned render request sink and opaque texture presenter.
IEditorShaderArtifactValidator engine Queues immutable shader candidates for validation at the active device’s next frame safety point.
PipelineDocuments engine Edits Pipeline sources and typed extension settings without changing canonical rendering assets before Save.
EditorGizmoContext Editor Provides scene content and selection for transient Editor gizmos.
EditorGizmoProvider Editor Contributes Editor-only icons and bounds without modifying a rendering model.
EditorGizmoProviderExtensionAttribute Editor Marks one reloadable Editor gizmo provider.
EditorPreviewHandle Editor Identifies one preview texture owned by a specific rendering-device generation.
EditorShaderCompilationState Editor Identifies native compilation state independently of document persistence.
EditorShaderDraftCompilationSnapshot Editor Contains a preview-only immutable candidate, never registered as a canonical asset artifact.
EditorViewportComposition Editor Describes a complete ordered set of rendering-model layers targeting one Editor viewport.
EditorViewportContext Editor Supplies frame-only Editor interaction and output dimensions to a contributor.
EditorViewportContribution Editor Returns one rendering-model contribution without exposing a GPU backend.
EditorViewportContributor Editor Contributes one rendering model while the host owns viewport composition, targets, and presentation.
EditorViewportContributorExtensionAttribute Editor Marks a reloadable rendering-model contributor for one Editor viewport purpose.
EditorViewportFocusBounds Editor Describes a world-space sphere that can be framed by host navigation.
EditorViewportKindId Editor Identifies one open Editor viewport purpose without prescribing rendering semantics.
EditorViewportLayer Editor Describes one model-neutral layer in an Editor viewport composition.
EditorViewportManipulationPlane Editor Selects whether transform handles use all axes or a contributor-declared planar orientation.
EditorViewportManipulationSpace Editor Describes the exact backend-neutral view and projection used to draw a viewport so host tools can manipulate selected scene transforms without knowing the controller’s camera model.
EditorViewportNavigationCapabilities Editor Declares navigation operations supported by one viewport interaction controller.
EditorViewportNavigationMode Editor Identifies the active interaction model without prescribing a rendering camera type.
EditorViewportNavigationProfile Editor Describes how the host may navigate one provider-owned viewport without exposing the provider’s camera model.
EditorViewportNavigationProfileId Editor Identifies a provider-defined navigation profile across reload generations.
EditorViewportNavigationState Editor Stores rendering-model-neutral navigation state for one Editor viewport across provider reloads.
EditorViewportPointerContext Editor Supplies normalized pointer interaction over one rendered viewport.
EditorViewportPresentation Editor Describes host-selected presentation preferences without prescribing rendering behavior.
EditorViewportProjection Editor Identifies the projection family represented by neutral Editor viewport navigation state.
IEditorGizmoSink Editor Receives transient world-space gizmo geometry from independent Editor extensions.
IEditorPreviewService Editor Provides one shared preview texture bridge for browsers, inspectors, and document canvases.
PipelineDocuments Editor Edits Pipeline sources and typed extension settings without changing canonical rendering assets before Save.