AutoGineer
Generated banner for Omniverse Realtime Viewer
Generated logo for Omniverse Realtime Viewer

Omniverse Realtime Viewer

NVIDIAOfficialCreated by NVIDIA Omniverse

  • Skill
  • Tool integration
  • Software development
  • Apache-2.0
  • Medium risk
Download ZIP

From the author

Use as the top-level router for Omniverse Realtime Viewer USD apps, XR delivery, SPG GPU processing, stylized rendering, and focused viewer reference documents.
— the description by NVIDIA Omniverse

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

The Omniverse Realtime Viewer skill acts as a central routing and architectural framework for developing USD-based 3D viewer applications. It provides a structured approach to composing rendering, scene state, and delivery mechanisms, ensuring that developers can integrate OVRTX rendering, OVStage scene management, and various UI or streaming adapters effectively. The skill emphasizes a modular architecture where the viewer runtime, UI/input adapters, and delivery systems are decoupled, allowing for consistent behavior across local and streamed environments.

What it does

  • Provides a routing architecture for USD viewer apps, XR delivery, and GPU-accelerated rendering.
  • Defines the separation of concerns between viewer runtime, UI adapters, and delivery systems.
  • Offers guidance on integrating OVRTX for high-fidelity 3D rendering.
  • Establishes conventions for camera interaction, scene state management, and input handling.
  • Supports the implementation of specialized features like stylized rendering and CAE/CFD visualization.
  • Provides protocols for agent-to-UI communication and scene control.

When to use it

  • When starting the development of a new USD-based realtime viewer application.
  • When integrating advanced rendering features like stylized visualization or AOV switching.
  • When building XR or spatial editing capabilities into an existing Omniverse application.
  • When you need to standardize the architecture for local and streamed viewer deployments.
  • When implementing chat-driven scene control or agent-based inspection of a 3D scene.

Advantages

  • Promotes a clean, modular architecture that separates rendering logic from UI and transport.
  • Ensures consistent behavior across different delivery methods, such as local windows or WebRTC streaming.
  • Provides clear paths for extending functionality without disrupting the core viewer runtime.
  • Facilitates the integration of complex simulation and visualization data into the viewer.
  • Standardizes conventions for scene state, selection, and camera control.

Usage examples

“How do I set up a basic USD viewer application using the Omniverse Realtime Viewer architecture?”
The agent will guide you to start with the viewer app reference, resolve dependencies, and implement the core runtime owner to manage the OVStage and OVRTX renderer.
“I need to add stylized rendering to my existing viewer. Where should I start?”
The agent will direct you to the stylized visualization references to implement the required USD/Lua/CUDA nodes within your existing runtime owner.
“How can I enable an AI agent to control the viewer scene?”
The agent will point to the A2UI Scene Copilot reference to implement an operation interface that allows the agent to send commands through the existing runtime owner.
“How do I switch between different render outputs like beauty and depth in my viewer?”
The agent will explain how to use the AOV switching reference to map RenderVars and update the RenderProduct's orderedVars through the runtime owner.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/nvidia/omniverse-realtime-viewer/download

  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip omniverse-realtime-viewer.zip -d .agents/skills

Documentation by NVIDIA Omniverse

<!-- SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. -->

<!-- SPDX-License-Identifier: Apache-2.0 -->

Omniverse Realtime Viewer

Build responsive USD viewers by composing OVRTX rendering, OVStage scene state, and the delivery/UI libraries appropriate to the app. Use this package for viewer architecture and interaction; use each selected SDK's upstream guidance for installation and exact release-specific APIs.

Start With The App

  1. When delivery is explicit, select its recipe through references/routing.md and follow its current phase. Otherwise start with references/usd-viewer-app/README.md. For an existing app, keep its architecture and read only the references for the requested change. Broad app, conventions and UI catalogs are lookups as needed.

  2. Resolve the selected libraries through references/dependencies/README.md. Preserve the project's manifest unless an upgrade is requested.

  3. Build a working frame and camera interaction in the chosen shell, then add the requested capabilities. Read references/conventions.md for shared input, camera, selection, and protocol conventions.

  4. Use references/viewer-ux-workflow/README.md for broader interface design. Loading, selection feedback, errors, and input responsiveness belong in the first working app, alongside rendering.

  5. Validate the actual delivery path with references/validation.md. A browser screenshot does not validate a native window or a different transport.

Architecture

OwnerResponsibility
Viewer runtimeOwn the live OVStage, publication clock, OVRTX renderer, scene changes, and render stepping.
UI and input adapterDisplay frames and copied app state; send user intent to the runtime owner.
Storage/query/simulation workersPerform their assigned work and return results through the selected integration boundary.
Delivery adapterPresent locally or stream through ovstream; respect frame ownership and backpressure.

Use OVRTX for USD/3D rendering. Browser apps display its WebRTC video; local apps present its output through their native shell. A missing GPU means rendering is unverified, not a reason to substitute a browser 3D renderer.

Keep viewer cameras, settings, effects, and transient edits in app-owned session or runtime state so the source USD stays intact. Serialize scene mutation and render stepping through the runtime owner. Read references/ovstage-ovrtx-integration/README.md for that loop, then the population or data-plane references when implementing scene loading or attribute writes.

Keep expensive loading and metadata work off the UI and render threads. Keep transport details behind a delivery adapter so camera, selection, properties, and loading state can be reused across local and streamed shells.

Add Capabilities As Needed

Use references/routing.md to select camera/picking, scene management, render settings, cloud assets, simulation, editor tools, deployment, or CAE/CFD visualization. Read the selected capability's implementation flow and its linked contract; the full reference catalog is not a prerequisite for a first frame.

For simulation, use the routing reference's Simulation Ecosystem section plus references/realtime-sim-integration/README.md. For UI-driven forces or control, add references/interaction-round-trip/README.md.

For example scenes, use references/usd-sample-data/README.md. When a runtime failure needs diagnosis, use references/troubleshooting/README.md and the selected SDK's matching release guidance before changing the architecture.

Solid Modeling: Upstream First

For usd-brep, exact BRep, solid modeling, kernel failures, CAD topology, or BrepArray questions, first read references/dependencies/README.md → USD BRep. Follow the owning repository's current agent guidance, skills, operation docs, and package API before selecting local integration references. Discover the upstream router rather than assuming skill names or directory layouts remain fixed. Upstream owns modeling semantics, schema rules, tuning, and diagnostics; this package owns OVRTX display, worker handoff, selection mapping, and publication timing.

GPU Processing And Stylized Viewers

For custom GPU processing, chained outputs and lens sampling, read references/spg-processing/README.md. For toon, ink, technical/X-Ray styles, geometry strokes or full wireframe, continue to references/stylized-visualization/implementation.md. Its USD/Lua/CUDA starting node and geometry/depth/composite build sequence work with the selected viewer recipe; use references/stylized-visualization/style-recipes.md for the preset math and references/stylized-visualization/README.md for supporting contracts. Implement the result inside the existing OVRTX/runtime owner and deliver the published processed output. These instructions do not require a sample checkout or a prior stylized-rendering implementation.

For an optional usd-brep geometry source, first read references/dependencies/README.md → USD BRep and the owning repository's current agent guidance, skills, and operation docs; then read references/stylized-visualization/usd-brep-source.md for the display boundary.

XR Viewers

For headsets, immersive viewers, or spatial editors, start with references/xr-viewer-recipe/README.md. Resolve SDK setup and contracts through references/dependencies/ovxr.md; the library owns OpenXR lifecycle and frame submission. For controllers, hands, navigation, or scene tools, add references/xr-spatial-input/README.md and references/ovxr-python-interactions/README.md. For projection-integrated UI, read references/ovxr-composition-ui/README.md and references/ovxr-composition-ui-validation/README.md.

Files

references/electron-shm-viewer/electron-client.md

Electron SHM Client

Electron Main And N-API Addon

Electron main starts the Python sidecar or attaches to an existing SHM session, waits for shmReady, and creates one native client and frame pump. The addon performs frame waits on a libuv worker; main remains available for window events, input, and shutdown. Main also forwards app messages through the preload API. Terminate the sidecar on quit only when the app started it.

Use the environment selected during setup to launch the sidecar; see windows-native-setup for Windows. Package the addon for Electron's runtime ABI.

A compact addon interface is:

type NativeShmClient = {
  connect(options: { name: string }): void;
  close(): void;
  waitFrame(): Promise<SharedArrayBuffer>;
  sendMessage(message: string): void;
  onMessage(callback: (message: string) => void): () => void;
};

Unified Native Client And Ownership

Wrap the unified API from the matching ovstream headers and libraries:

ovstream_client_config_t config = {};
config.shm.stream_name = OVSTREAM_STRING_LITERAL("viewer-stream");
ovstream_client_t* client = nullptr;
auto result = ovstream_create_client(OVSTREAM_CLIENT_SHM, &config, &client);
// Check result before using client.

Use ovstream_client_wait_frame, ovstream_client_send_message, ovstream_client_send_input_event, and ovstream_destroy_client on that handle. Dependency acquisition and upstream API references live in dependencies/ovstream.

The frame pump validates each frame's source, format, dimensions, and pitch, then promptly copies rows into an app-owned bounded SharedArrayBuffer ring. Native ovstream_frame_t storage is borrowed and may be recycled independently of the next wait; retaining a pointer does not pin it for asynchronous JS use. Pack padded rows before delivery. The 16-byte frontend header used by this recipe is an app IPC convention, not the native frame struct.

Reuse a ring slot only after its JS consumer finishes reading it. Bound pending frames and drop stale work when presentation falls behind; a larger queue adds latency. Keep raw native handles and pointer arithmetic inside the addon.

Use bounded wait timeouts so close() can stop and join the pump before ovstream_destroy_client. Destroy outside callbacks, keeping callback objects and user data alive until destruction completes, including deliveries already in flight when a callback is replaced.

Preload API

Expose a narrow contextBridge API:

export type ShmViewerApi = {
  connect(options?: { name?: string }): Promise<ViewerCapabilities>;
  disconnect(): Promise<void>;
  waitFrame(): Promise<SharedArrayBuffer>;
  sendMessage(message: { event_type: string; payload?: unknown }): Promise<void>;
  onMessage(callback: (message: { event_type: string; payload: unknown }) => void): () => void;
  getStatus(): Promise<BackendStatus>;
};

Preload rules:

  • contextIsolation: true

  • renderer nodeIntegration: false

  • expose functions, not raw ipcRenderer

  • validate message envelopes before sending to main

  • do not expose filesystem, shell, child process, native addon, or environment access directly to React

  • return a protocol version from connect()

ViewerBackend Interface

useShmBackend.ts should implement the shared frontend contract. Keep SHM specifics inside frame metadata and backend internals.

export type FrameData = {
  width: number;
  height: number;
  sequence: number;
  format: 'BGRA8' | 'RGBA8';
  buffer: SharedArrayBuffer;
  pixelsByteOffset: number;
  byteLength: number;
};

export type RenderSettingCapability = {
  key: string;
  label: string;
  control: string;
  applies_at: 'immediate' | 'reload_required' | 'next_scene_load' | 'unsupported';
  apply_path: string;
  validated: boolean;
  validation_evidence: string;
};

export type RenderSettingsState = {
  settings: Record<string, unknown>;
  capabilities: RenderSettingCapability[];
};

export interface ViewerBackend {
  connect(): Promise<void>;
  disconnect(): void;
  loadStage(path: string): Promise<{ path: string; tree?: PrimNode[] } | void>;
  resize(width: number, height: number): Promise<void>;
  setCamera(camera: CameraState): Promise<void>;
  cameraMouseButton(input: PointerInput): Promise<boolean>;
  cameraMouseMove(x: number, y: number): Promise<void>;
  cameraWheel(delta: number): Promise<void>;
  onFrame(callback: (frame: FrameData) => void): () => void;
  onSelectionChanged(callback: (paths: string[]) => void): () => void;
  pick(x: number, y: number): Promise<string | null>;
  getStageTree(rootPath?: string): Promise<PrimNode[]>;
  selectPrims(paths: string[]): Promise<void>;
  getProperties(path: string): Promise<PrimProperty[]>;
  getRenderSettings?(): Promise<RenderSettingsState>;
  setRenderSetting?(key: string, value: unknown): Promise<RenderSettingsState>;
}

Behavior:

  • connect() attaches, subscribes to messages, and starts one frame pump.

  • disconnect() stops the pump before closing native resources.

  • resize() updates UI layout unless the server implements RenderProduct resolution changes and matching frame-storage updates.

  • onFrame() fans out frames from the single pump to UI subscribers.

  • pick() sends a request id and resolves on matching response, with timeout.

  • hierarchy, properties, selection, AOVs, and settings use JSON messages.

  • Render settings panels must render from RenderSettingCapability[]; setting changes reject unsupported keys and only report success when active viewer state changed or an explicit non-live action was accepted.

React Renderer And WebGL Blit

The React viewport displays server-rendered pixels:

  • maintain canvas size and device pixel ratio

  • compute letterboxed content rectangle

  • map pointer coordinates into render-product pixels

  • upload BGRA/RGBA pixels into a WebGL texture

  • draw a full-canvas quad

  • render overlays, tree, panels, toolbar, and status as DOM UI

  • drop stale frames by sequence number

WebGL setup:

const gl = canvas.getContext('webgl', {
  alpha: false,
  antialias: false,
  depth: false,
  stencil: false,
  preserveDrawingBuffer: false,
});

RGBA upload fallback:

gl.bindTexture(gl.TEXTURE_2D, texture);
gl.pixelStorei(gl.UNPACK_ALIGNMENT, 1);
gl.texImage2D(
  gl.TEXTURE_2D,
  0,
  gl.RGBA,
  frame.width,
  frame.height,
  0,
  gl.RGBA,
  gl.UNSIGNED_BYTE,
  rgbaPixels,
);

Do not add 3D engines, scene graph helpers, material systems, model loaders, or camera libraries for the viewport. Read webgl-shm-transport for extension checks, shader details, canvas resize behavior, and conversion fallback.

Requirements and compatibility

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs Python, Needs Node.js

The author says: Orchestrator skill. Downstream focused references may require NVIDIA GPUs, ovrtx, ovstream, ovui, OpenUSD, Python, Node/React, Tauri, Electron, C++, or cloud GPU deployment access depending on the selected viewer path.

Security

What our scanner noticed· Medium risk

  • Large base64-encoded blobs
  • Instructions that use the network

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
NVIDIA Omniverse
Publisher
NVIDIA (Official)
Source
NVIDIA/skills · skills/omniverse-realtime-viewer · commit fce3cca
Licence
Apache License 2.0 (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE-APACHE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by NVIDIA Omniverse or NVIDIA.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download omniverse-realtime-viewer.zip