Centralize WebGPU probes into WebGPURuntime

Author: JimBobSquarePants

samples/DrawingBackendBenchmark/BenchmarkForm.cs

@@ -1,9 +1,9 @@
-// Copyright (c) Six Labors.
+// Copyright (c) Six Labors.
 // Licensed under the Six Labors Split License.
 
-using SkiaSharp.Views.Desktop;
 using SixLabors.ImageSharp;
 using SixLabors.ImageSharp.PixelFormats;
+using SkiaSharp.Views.Desktop;
 using Color = SixLabors.ImageSharp.Color;
 using PointF = SixLabors.ImageSharp.PointF;
 

samples/DrawingBackendBenchmark/WebGpuBenchmarkBackend.cs

@@ -23,11 +23,9 @@ private WebGpuBenchmarkBackend()
 
     public static bool TryCreate([NotNullWhen(true)] out WebGpuBenchmarkBackend? result, [NotNullWhen(false)] out string? error)
     {
-        using WebGPUDrawingBackend backend = new();
-        if (!backend.IsSupported)
+        if (!WebGPUEnvironment.TryProbeComputePipelineSupport(out error))
         {
             result = null;
-            error = "WebGPU unsupported";
             return false;
         }
 

src/ImageSharp.Drawing.WebGPU/ImageSharp.Drawing.WebGPU.csproj

@@ -9,8 +9,8 @@
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <RepositoryUrl Condition="'$(RepositoryUrl)' == ''">https://github.com/SixLabors/ImageSharp.Drawing/</RepositoryUrl>
     <PackageProjectUrl>$(RepositoryUrl)</PackageProjectUrl>
-    <PackageTags>Image Draw Shape Path Font</PackageTags>
-    <Description>An extension to ImageSharp that allows the drawing of images, paths, and text.</Description>
+    <PackageTags>ImageSharp Drawing WebGPU GPU Graphics Shapes Paths Text Raster Compute</PackageTags>
+    <Description>A WebGPU backend for ImageSharp.Drawing with GPU-accelerated rendering for windows and render targets.</Description>
     <Configurations>Debug;Release</Configurations>
     <!--
       OutputType=Exe is required so that runtimeconfig.json and deps.json are generated.
@@ -22,9 +22,6 @@
     <IsTrimmable>true</IsTrimmable>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
 
-    <!-- TEMP: To avoid publishing while we experiment. -->
-    <IsPublishable>false</IsPublishable>
-
     <!--
       This project is strong-name signed by the shared SixLabors build settings.
       Silk.NET WebGPU packages are currently unsigned, which triggers CS8002.

src/ImageSharp.Drawing.WebGPU/RemoteExecutor/Program.cs

@@ -25,7 +25,7 @@ private static int Main(string[] args)
 
         return methodName switch
         {
-            nameof(WebGPUDrawingBackend.ProbeComputePipelineSupport) => WebGPUDrawingBackend.ProbeComputePipelineSupport(),
+            nameof(WebGPURuntime.ProbeComputePipelineSupport) => WebGPURuntime.ProbeComputePipelineSupport(),
             _ => -1
         };
     }

src/ImageSharp.Drawing.WebGPU/WebGPUDeviceContext{TPixel}.cs

@@ -51,12 +51,6 @@ public unsafe WebGPUDeviceContext(Configuration configuration)
             this.queueHandle = (nint)queue;
             this.runtimeLease = lease;
             this.Configuration = configuration;
-            this.Configuration.SetDrawingBackend(this.Backend);
-
-            if (!this.Backend.IsSupported)
-            {
-                throw new InvalidOperationException("WebGPU unsupported.");
-            }
         }
         catch
         {
@@ -101,7 +95,6 @@ public WebGPUDeviceContext(Configuration configuration, nint deviceHandle, nint
         this.queueHandle = queueHandle;
         this.Backend = new WebGPUDrawingBackend();
         this.Configuration = configuration;
-        this.Configuration.SetDrawingBackend(this.Backend);
     }
 
     /// <summary>
@@ -261,7 +254,7 @@ public DrawingCanvas<TPixel> CreateCanvas(
         WebGPUTextureFormatId format,
         int width,
         int height)
-        => new(this.Configuration, this.CreateFrame(textureHandle, textureViewHandle, format, width, height), new DrawingOptions());
+        => new(this.Configuration, this.Backend, this.CreateFrame(textureHandle, textureViewHandle, format, width, height), new DrawingOptions());
 
     /// <summary>
     /// Creates a drawing canvas over an externally-owned WebGPU texture.
@@ -280,7 +273,7 @@ public DrawingCanvas<TPixel> CreateCanvas(
         int width,
         int height,
         DrawingOptions options)
-        => new(this.Configuration, this.CreateFrame(textureHandle, textureViewHandle, format, width, height), options);
+        => new(this.Configuration, this.Backend, this.CreateFrame(textureHandle, textureViewHandle, format, width, height), options);
 
     /// <summary>
     /// Creates a hybrid drawing canvas over an externally-owned WebGPU texture and a caller-provided CPU region.
@@ -299,7 +292,7 @@ public DrawingCanvas<TPixel> CreateHybridCanvas(
         int width,
         int height,
         Buffer2DRegion<TPixel> cpuRegion)
-        => new(this.Configuration, this.CreateHybridFrame(textureHandle, textureViewHandle, format, width, height, cpuRegion), new DrawingOptions());
+        => new(this.Configuration, this.Backend, this.CreateHybridFrame(textureHandle, textureViewHandle, format, width, height, cpuRegion), new DrawingOptions());
 
     /// <summary>
     /// Creates a hybrid drawing canvas over an externally-owned WebGPU texture and a caller-provided CPU region.
@@ -320,7 +313,7 @@ public DrawingCanvas<TPixel> CreateHybridCanvas(
         int height,
         Buffer2DRegion<TPixel> cpuRegion,
         DrawingOptions options)
-        => new(this.Configuration, this.CreateHybridFrame(textureHandle, textureViewHandle, format, width, height, cpuRegion), options);
+        => new(this.Configuration, this.Backend, this.CreateHybridFrame(textureHandle, textureViewHandle, format, width, height, cpuRegion), options);
 
     /// <summary>
     /// Creates a hybrid drawing canvas over an externally-owned WebGPU texture and the root frame of a CPU image.
@@ -335,7 +328,7 @@ public DrawingCanvas<TPixel> CreateHybridCanvas(
         nint textureViewHandle,
         WebGPUTextureFormatId format,
         Image<TPixel> image)
-        => new(this.Configuration, this.CreateHybridFrame(textureHandle, textureViewHandle, format, image), new DrawingOptions());
+        => new(this.Configuration, this.Backend, this.CreateHybridFrame(textureHandle, textureViewHandle, format, image), new DrawingOptions());
 
     /// <summary>
     /// Creates a hybrid drawing canvas over an externally-owned WebGPU texture and a CPU image frame.
@@ -350,7 +343,7 @@ public DrawingCanvas<TPixel> CreateHybridCanvas(
         nint textureViewHandle,
         WebGPUTextureFormatId format,
         ImageFrame<TPixel> imageFrame)
-        => new(this.Configuration, this.CreateHybridFrame(textureHandle, textureViewHandle, format, imageFrame), new DrawingOptions());
+        => new(this.Configuration, this.Backend, this.CreateHybridFrame(textureHandle, textureViewHandle, format, imageFrame), new DrawingOptions());
 
     /// <summary>
     /// Creates a hybrid drawing canvas over an externally-owned WebGPU texture and the root frame of a CPU image.
@@ -367,7 +360,7 @@ public DrawingCanvas<TPixel> CreateHybridCanvas(
         WebGPUTextureFormatId format,
         Image<TPixel> image,
         DrawingOptions options)
-        => new(this.Configuration, this.CreateHybridFrame(textureHandle, textureViewHandle, format, image), options);
+        => new(this.Configuration, this.Backend, this.CreateHybridFrame(textureHandle, textureViewHandle, format, image), options);
 
     /// <summary>
     /// Creates a hybrid drawing canvas over an externally-owned WebGPU texture and a CPU image frame.
@@ -384,7 +377,7 @@ public DrawingCanvas<TPixel> CreateHybridCanvas(
         WebGPUTextureFormatId format,
         ImageFrame<TPixel> imageFrame,
         DrawingOptions options)
-        => new(this.Configuration, this.CreateHybridFrame(textureHandle, textureViewHandle, format, imageFrame), options);
+        => new(this.Configuration, this.Backend, this.CreateHybridFrame(textureHandle, textureViewHandle, format, imageFrame), options);
 
     /// <summary>
     /// Disposes the drawing backend owned by this context.

src/ImageSharp.Drawing.WebGPU/WebGPUDrawingBackend.cs

@@ -30,7 +30,6 @@ public sealed unsafe partial class WebGPUDrawingBackend : IDrawingBackend, IDisp
     private const int MaxDynamicGrowthAttempts = 8;
 
     private readonly DefaultDrawingBackend fallbackBackend;
-    private static bool? isSupported;
 
     // The staged pipeline keeps the most recently successful scratch capacities so later flushes
     // can start closer to the scene sizes the current device has already proven it needs.
@@ -90,153 +89,6 @@ public WebGPUDrawingBackend()
     /// </summary>
     public string DiagnosticLastChunkingBindingFailure => this.TestingLastChunkingBindingFailure.ToString();
 
-    /// <summary>
-    /// Gets a value indicating whether WebGPU is available on the current system.
-    /// This probes the runtime by attempting to acquire an adapter and device.
-    /// The result is cached after the first probe.
-    /// </summary>
-    public bool IsSupported => isSupported ??= ProbeFullSupport();
-
-    /// <summary>
-    /// Probes whether WebGPU compute is fully supported on the current system.
-    /// First checks adapter/device availability in-process. If that succeeds,
-    /// spawns a child process via <see cref="RemoteExecutor"/> to test compute
-    /// pipeline creation, which can crash with an unrecoverable access violation
-    /// on some systems. If the remote executor is not available, falls back to
-    /// the device-only check.
-    /// </summary>
-    /// <returns>Returns <see langword="true"/> if WebGPU compute support is available; otherwise, <see langword="false"/>.</returns>
-    private static bool ProbeFullSupport()
-    {
-        if (!ProbeSupport())
-        {
-            return false;
-        }
-
-        if (!RemoteExecutor.IsSupported)
-        {
-            return true;
-        }
-
-        return RemoteExecutor.Invoke(ProbeComputePipelineSupport) == 0;
-    }
-
-    /// <summary>
-    /// Determines whether WebGPU adapter and device are available on the current system.
-    /// </summary>
-    /// <remarks>This method only checks adapter and device availability. It does not attempt
-    /// compute pipeline creation. Use <see cref="ProbeFullSupport"/> for a complete check.</remarks>
-    /// <returns>Returns <see langword="true"/> if a WebGPU device is available; otherwise, <see langword="false"/>.</returns>
-    public static bool ProbeSupport()
-    {
-        try
-        {
-            using WebGPURuntime.Lease lease = WebGPURuntime.Acquire();
-            return WebGPURuntime.TryGetOrCreateDevice(out _, out _, out _);
-        }
-        catch
-        {
-            return false;
-        }
-    }
-
-    /// <summary>
-    /// Probes full WebGPU compute pipeline support by compiling a trivial shader and
-    /// creating a compute pipeline. This method may crash with an access violation on
-    /// systems with broken WebGPU compute support - callers should run it in a child
-    /// process (for example via <c>RemoteExecutor</c>) to isolate the crash.
-    /// </summary>
-    /// <returns>Exit code: 0 on success, 1 on failure.</returns>
-    public static int ProbeComputePipelineSupport()
-    {
-        try
-        {
-            using WebGPURuntime.Lease lease = WebGPURuntime.Acquire();
-            if (!WebGPURuntime.TryGetOrCreateDevice(out Device* device, out _, out _))
-            {
-                return 1;
-            }
-
-            WebGPU api = lease.Api;
-
-            ReadOnlySpan<byte> probeShader = "@compute @workgroup_size(1) fn main() {}\0"u8;
-            fixed (byte* shaderCodePtr = probeShader)
-            {
-                ShaderModuleWGSLDescriptor wgslDescriptor = new()
-                {
-                    Chain = new ChainedStruct { SType = SType.ShaderModuleWgslDescriptor },
-                    Code = shaderCodePtr
-                };
-
-                ShaderModuleDescriptor shaderDescriptor = new()
-                {
-                    NextInChain = (ChainedStruct*)&wgslDescriptor
-                };
-
-                ShaderModule* shaderModule = api.DeviceCreateShaderModule(device, in shaderDescriptor);
-                if (shaderModule is null)
-                {
-                    return 1;
-                }
-
-                try
-                {
-                    ReadOnlySpan<byte> entryPoint = "main\0"u8;
-                    fixed (byte* entryPointPtr = entryPoint)
-                    {
-                        ProgrammableStageDescriptor computeStage = new()
-                        {
-                            Module = shaderModule,
-                            EntryPoint = entryPointPtr
-                        };
-
-                        PipelineLayoutDescriptor layoutDescriptor = new()
-                        {
-                            BindGroupLayoutCount = 0,
-                            BindGroupLayouts = null
-                        };
-
-                        PipelineLayout* pipelineLayout = api.DeviceCreatePipelineLayout(device, in layoutDescriptor);
-                        if (pipelineLayout is null)
-                        {
-                            return 1;
-                        }
-
-                        try
-                        {
-                            ComputePipelineDescriptor pipelineDescriptor = new()
-                            {
-                                Layout = pipelineLayout,
-                                Compute = computeStage
-                            };
-
-                            ComputePipeline* pipeline = api.DeviceCreateComputePipeline(device, in pipelineDescriptor);
-                            if (pipeline is null)
-                            {
-                                return 1;
-                            }
-
-                            api.ComputePipelineRelease(pipeline);
-                            return 0;
-                        }
-                        finally
-                        {
-                            api.PipelineLayoutRelease(pipelineLayout);
-                        }
-                    }
-                }
-                finally
-                {
-                    api.ShaderModuleRelease(shaderModule);
-                }
-            }
-        }
-        catch
-        {
-            return 1;
-        }
-    }
-
     /// <inheritdoc />
     public void FlushCompositions<TPixel>(
         Configuration configuration,

src/ImageSharp.Drawing.WebGPU/WebGPUEnvironment.cs

@@ -0,0 +1,29 @@
+// Copyright (c) Six Labors.
+// Licensed under the Six Labors Split License.
+
+using System.Diagnostics.CodeAnalysis;
+
+namespace SixLabors.ImageSharp.Drawing.Processing.Backends;
+
+/// <summary>
+/// Provides explicit support probes for the library-managed WebGPU environment.
+/// Use this type when you want to check availability or compute pipeline support before constructing WebGPU objects.
+/// </summary>
+public static class WebGPUEnvironment
+{
+    /// <summary>
+    /// Tries to acquire the library-managed WebGPU device and queue.
+    /// </summary>
+    /// <param name="error">Receives the failure reason when the probe fails.</param>
+    /// <returns><see langword="true"/> when the library-managed WebGPU device and queue are available; otherwise, <see langword="false"/>.</returns>
+    public static bool TryProbeAvailability([NotNullWhen(false)] out string? error)
+        => WebGPURuntime.TryProbeAvailability(out error);
+
+    /// <summary>
+    /// Tries to create a trivial compute pipeline using the library-managed WebGPU device.
+    /// </summary>
+    /// <param name="error">Receives the failure reason when the probe fails.</param>
+    /// <returns><see langword="true"/> when compute pipeline creation succeeds; otherwise, <see langword="false"/>.</returns>
+    public static bool TryProbeComputePipelineSupport([NotNullWhen(false)] out string? error)
+        => WebGPURuntime.TryProbeComputePipelineSupport(out error);
+}

src/ImageSharp.Drawing.WebGPU/WebGPURenderTarget{TPixel}.cs

@@ -212,7 +212,7 @@ public DrawingCanvas<TPixel> CreateCanvas(DrawingOptions options)
     {
         this.ThrowIfDisposed();
         this.Graphics.ThrowIfDisposed();
-        return new DrawingCanvas<TPixel>(this.Graphics.Configuration, this.NativeFrame, options);
+        return new DrawingCanvas<TPixel>(this.Graphics.Configuration, this.Graphics.Backend, this.NativeFrame, options);
     }
 
     /// <summary>
@@ -233,7 +233,7 @@ public DrawingCanvas<TPixel> CreateHybridCanvas(Buffer2DRegion<TPixel> cpuRegion
     {
         this.ThrowIfDisposed();
         this.Graphics.ThrowIfDisposed();
-        return new DrawingCanvas<TPixel>(this.Graphics.Configuration, this.CreateHybridFrame(cpuRegion), options);
+        return new DrawingCanvas<TPixel>(this.Graphics.Configuration, this.Graphics.Backend, this.CreateHybridFrame(cpuRegion), options);
     }
 
     /// <summary>