OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd 2.0.2-preview.300

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd. 
dotnet add package OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd --version 2.0.2-preview.300
                    


                    

                
NuGet\Install-Package OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd -Version 2.0.2-preview.300
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd" Version="2.0.2-preview.300" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd" Version="2.0.2-preview.300" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd --version 2.0.2-preview.300
                    


                    

                
#r "nuget: OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd, 2.0.2-preview.300"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd@2.0.2-preview.300
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd&version=2.0.2-preview.300&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd&version=2.0.2-preview.300&prerelease
                    


                            Install as a Cake Tool

OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd

Offscreen renderer for the draft OPC UA Vision companion server.

This package renders a USD stage camera's view through the OpenUSD Silk backend (D3D12 hardware, D3D12 WARP software, or Vulkan headless) and returns encoded PNG frames through a small ISceneCameraCaptureProvider abstraction. The Vision server can depend on the abstraction without referencing OpenUSD, and degrades to a non-rendering sensor when this optional package is not present.

What it does

The Opc.Ua.Vision.OpenUsd.OpenUsdSceneCameraCaptureProvider fulfills a capture request by:

  1. Opening the USD stage from the supplied path or identifier.
  2. Resolving the camera prim (view + off-centre projection built from UsdGeomCamera.GetState(time) and GetTransform(time)) - or rendering the automatic default framing when no prim path is supplied.
  3. Retaining an OpenUsdSilkSession while requests use the same stage.
  4. Capturing successive RGBA8 frames with SilkFrameCapturer on a shared ISilkGraphicsDevice picked at construction time.
  5. Encoding to PNG with an in-repo, dependency-free encoder.
  6. Refusing to hand back an all-zero / no-mesh frame as if it succeeded - returning SceneCameraCaptureStatus.BlankFrame with a reason instead.

Capturing an already-running viewport

RetainedSceneCameraCaptureProvider adapts an injected IRetainedSceneFrameSource to the same ISceneCameraCaptureProvider contract. It does not probe a device, open a stage, acquire a server media lease or start inference. Its owner controls startup, camera selection, cancellation and disposal.

ISceneCameraCaptureProvider capture =
    new RetainedSceneCameraCaptureProvider(retainedFrameSource, telemetry);

The adapter rejects a different stage identity, unsupported image format, non-finite time, non-UTC timestamps, excessive dimensions and excessive RGBA8 bytes before calling the source. Only one capture may be active. The default bounds are 2048 pixels per dimension and 16 MiB of raw image data. Returned dimensions, storage, draw counts, mesh counts and pixel variation are checked before PNG encoding. No failure is represented by a successful blank image.

The connector's EmbeddedUsdViewport implements this source. It captures the currently selected camera, time and physical dimensions from the retained renderer, without synchronizing geometry into a second renderer. D3D12 uses SilkFrameCapture.CaptureRetained; the Vulkan and Metal composition callbacks read back their actual retained presentation targets. Requests are serialized with presentation and cancellation drains a started readback. Platform/driver and NativeAOT qualification remain per-RID, not implied by another host's result. Backend-owned Vulkan/Metal presenters do not expose adapter classification; their descriptors set IsSoftwareKnown = false rather than implying hardware.

Device selection

OpenUsdSceneCameraCaptureProvider tries backends in the order that makes sense for the host:

  • Windows: D3D12 hardware → D3D12 WARP (software rasterizer, no GPU) → Vulkan.
  • Linux / other: Vulkan (which the OpenUSD runtime bundles the SwiftShader software ICD for, so CI without a GPU is still functional).

The provider reports the chosen backend and whether it is a software renderer through Backend, and when no backend is available reports IsAvailable = false with a reason. In that case every CaptureAsync returns SceneCameraCaptureStatus.NoRenderingBackend.

Registration

using Opc.Ua.Vision.OpenUsd;
using Microsoft.Extensions.DependencyInjection;

services.AddOpenUsdSceneCameraCaptureProvider(o =>
{
    o.PluginPath = "/path/to/plugin/usd"; // optional; auto-probes AppContext.BaseDirectory
    o.PreferSoftware = false;
});

or without DI:

using var provider = new OpenUsdSceneCameraCaptureProvider(
    new OpenUsdSceneCaptureOptions(), telemetry: null);
SceneCameraCaptureResult result = await provider.CaptureAsync(
    new SceneCameraCaptureRequest
    {
        StageIdentifier = "/path/to/scene.usda",
        PrimPath = "/World/Cam",
        Width = 640,
        Height = 360,
        TimeCode = 0.0,
        Format = SceneCameraImageFormat.Png,
    },
    cancellationToken);

Native payload

The OpenUSD runtime packages ship RID-specific native assets (win-x64, linux-x64, osx-arm64). Publish the consuming application with an explicit RuntimeIdentifier (e.g. dotnet publish -r linux-x64) so the plugin/usd/ tree and the backend native libraries land alongside the executable. The provider then auto-discovers them from AppContext.BaseDirectory.

When the payload is absent — the normal case on unadorned CI legs — the provider still starts, Backend.IsAvailable reports false and every capture returns SceneCameraCaptureStatus.NoRenderingBackend. This is the degrade path the Vision developer guide describes: the sensor stays visible in the address space, browses still work, and only the pixel bytes are absent, so a client can distinguish "no GPU" from a genuine rendering fault.

Package Adds
OPCFoundation.NetStandard.Opc.Ua.Vision.Server The Vision server that consumes ISceneCameraCaptureProvider
OPCFoundation.NetStandard.Opc.Ua.Vision.Client The client that reads the simulated sensor's LatestClip / GetClip

License

OPC Foundation MIT License 1.00 — http://opcfoundation.org/License/MIT/1.00/

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on OPCFoundation.NetStandard.Opc.Ua.Vision.OpenUsd:

Package Downloads
OPCFoundation.NetStandard.Opc.Ua.OpenUsd.Connector.Viewer

Optional viewport for the OPC UA - OpenUSD connector. Renders the composed stage with the OpenUSD Avalonia viewer and exposes it as an IUsdSink, so the connector's --view option streams live OPC UA values into the picture on screen. Install alongside Opc.Ua.OpenUsd.Connector; the connector loads it on demand and works without it.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.2-preview.300 58 11/11/2026
2.0.1-preview.200 80 10/12/2026
2.0.0-preview.200 73 10/7/2026
2.0.0-preview.6 66 9/30/2026
2.0.0-preview.5 83 9/17/2026
2.0.0-preview.4 82 9/2/2026

https://github.com/OPCFoundation/UA-.NETStandard/releases