Vendor WebGPU Bindings from web_sys (gfx-rs#5325)

Author: cwfitzgerald

.cargo/config.toml

@@ -1,10 +1,2 @@
 [alias]
-xtask = "run --manifest-path xtask/Cargo.toml"
-
-[build]
-rustflags = [
-"--cfg=web_sys_unstable_apis"
-]
-rustdocflags = [
-"--cfg=web_sys_unstable_apis"
-]
+xtask = "run --manifest-path xtask/Cargo.toml --"

.gitattributes

@@ -1,2 +1,3 @@
 *.mtl binary
 *.obj binary
+wgpu/src/backend/webgpu/webgpu_sys/** linguist-generated=true

.github/workflows/ci.yml

@@ -55,8 +55,8 @@ env:
   RUST_LOG: info
   RUST_BACKTRACE: full
   PKG_CONFIG_ALLOW_CROSS: 1 # allow android to work
-  RUSTFLAGS: --cfg=web_sys_unstable_apis -D warnings
-  RUSTDOCFLAGS: --cfg=web_sys_unstable_apis -D warnings
+  RUSTFLAGS: -D warnings
+  RUSTDOCFLAGS: -D warnings
   WASM_BINDGEN_TEST_TIMEOUT: 300 # 5 minutes
   CACHE_SUFFIX: c # cache busting
 

.github/workflows/publish.yml

@@ -12,7 +12,7 @@ env:
   CARGO_INCREMENTAL: false
   CARGO_TERM_COLOR: always
   RUST_BACKTRACE: full
-  RUSTFLAGS: --cfg=web_sys_unstable_apis
+  RUSTFLAGS:
 
 jobs:
   publish:

.gitignore

@@ -31,3 +31,6 @@ cts/
 
 # Cached GPU config
 .gpuconfig
+
+# Temporary clone location for wasm-bindgen mirroring
+wgpu/src/backend/webgpu/webgpu_sys/wasm_bindgen_clone_tmp

CHANGELOG.md

@@ -39,6 +39,18 @@ Bottom level categories:
 
 ## Unreleased
 
+### Major Changes
+
+#### Vendored WebGPU Bindings from `web_sys` 
+
+**`--cfg=web_sys_unstable_apis` is no longer needed in your `RUSTFLAGS` to compile for WebGPU!!!**
+
+While WebGPU's javascript api is stable in the browsers, the `web_sys` bindings for WebGPU are still improving. As such they are hidden behind the special cfg `--cfg=web_sys_unstable_apis` and are not available by default. Everyone who wanted to use our WebGPU backend needed to enable this cfg in their `RUSTFLAGS`. This was very inconvenient and made it hard to use WebGPU, especially when WebGPU is enabled by default. Additionally, the unstable APIs don't adhere to semver, so there were repeated breakages.
+
+To combat this problem we have decided to vendor the `web_sys` bindings for WebGPU within the crate. Notably we are not forking the bindings, merely vendoring, so any improvements we make to the bindings will be contributed directly to upstream `web_sys`.
+
+By @cwfitzgerald in [#5325](https://github.com/gfx-rs/wgpu/pull/5325).
+
 ### Documentation
 
 - Document Wayland specific behavior related to `SurfaceTexture::present`. By @i509VCB in [#5092](https://github.com/gfx-rs/wgpu/pull/5092).

wgpu/Cargo.toml

@@ -13,7 +13,7 @@ exclude = ["Cargo.lock"]
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs", "--cfg", "web_sys_unstable_apis"]
+rustdoc-args = ["--cfg", "docsrs"]
 targets = [
     "x86_64-unknown-linux-gnu",
     "x86_64-apple-darwin",
@@ -194,131 +194,16 @@ web-sys = { workspace = true, features = [
     "Navigator",
     "Node",
     "NodeList",
-    "Gpu",
-    "GpuAdapter",
-    "GpuAddressMode",
-    "GpuAutoLayoutMode",
-    "GpuBindGroup",
-    "GpuBindGroupDescriptor",
-    "GpuBindGroupEntry",
-    "GpuBindGroupLayout",
-    "GpuBindGroupLayoutDescriptor",
-    "GpuBindGroupLayoutEntry",
-    "GpuBlendComponent",
-    "GpuBlendFactor",
-    "GpuBlendOperation",
-    "GpuBlendState",
-    "GpuBuffer",
-    "GpuBufferBinding",
-    "GpuBufferBindingLayout",
-    "GpuBufferBindingType",
-    "GpuBufferDescriptor",
-    "GpuCanvasAlphaMode",
-    "GpuCanvasContext",
-    "GpuCanvasConfiguration",
-    "GpuColorDict",
-    "GpuColorTargetState",
-    "GpuCommandBuffer",
-    "GpuCommandBufferDescriptor",
-    "GpuCommandEncoder",
-    "GpuCommandEncoderDescriptor",
-    "GpuCompareFunction",
-    "GpuCompilationInfo",
-    "GpuCompilationMessage",
-    "GpuCompilationMessageType",
-    "GpuComputePassDescriptor",
-    "GpuComputePassEncoder",
-    "GpuComputePassTimestampWrites",
-    "GpuComputePipeline",
-    "GpuComputePipelineDescriptor",
-    "GpuCullMode",
-    "GpuDepthStencilState",
-    "GpuDevice",
-    "GpuDeviceDescriptor",
-    "GpuDeviceLostInfo",
-    "GpuDeviceLostReason",
-    "GpuError",
-    "GpuErrorFilter",
-    # "GpuExtent2dDict", Not yet implemented in web_sys
-    "GpuExtent3dDict",
-    "GpuFeatureName",
-    "GpuFilterMode",
-    "GpuFragmentState",
-    "GpuFrontFace",
-    "GpuImageCopyBuffer",
-    "GpuImageCopyExternalImage",
-    "GpuImageCopyTexture",
-    "GpuImageCopyTextureTagged",
-    "GpuImageDataLayout",
-    "GpuIndexFormat",
-    "GpuLoadOp",
-    "gpu_map_mode",
-    "GpuMipmapFilterMode",
-    "GpuMultisampleState",
-    "GpuObjectDescriptorBase",
-    "GpuOrigin2dDict",
-    "GpuOrigin3dDict",
-    "GpuOutOfMemoryError",
-    "GpuPipelineDescriptorBase",
-    "GpuPipelineLayout",
-    "GpuPipelineLayoutDescriptor",
-    "GpuPowerPreference",
-    "GpuPrimitiveState",
-    "GpuPrimitiveTopology",
-    "GpuProgrammableStage",
-    "GpuQuerySet",
-    "GpuQuerySetDescriptor",
-    "GpuQueryType",
-    "GpuQueue",
-    "GpuRenderBundle",
-    "GpuRenderBundleDescriptor",
-    "GpuRenderBundleEncoder",
-    "GpuRenderBundleEncoderDescriptor",
-    "GpuRenderPassColorAttachment",
-    "GpuRenderPassDepthStencilAttachment",
-    "GpuRenderPassDescriptor",
-    "GpuRenderPassEncoder",
-    "GpuRenderPipeline",
-    "GpuRenderPipelineDescriptor",
-    "GpuRequestAdapterOptions",
-    "GpuSampler",
-    "GpuSamplerBindingLayout",
-    "GpuSamplerBindingType",
-    "GpuSamplerDescriptor",
-    "GpuShaderModule",
-    "GpuShaderModuleDescriptor",
-    "GpuStencilFaceState",
-    "GpuStencilOperation",
-    "GpuStorageTextureAccess",
-    "GpuStorageTextureBindingLayout",
-    "GpuStoreOp",
-    "GpuSupportedFeatures",
-    "GpuSupportedLimits",
-    "GpuTexture",
-    "GpuTextureAspect",
-    "GpuTextureBindingLayout",
-    "GpuTextureDescriptor",
-    "GpuTextureDimension",
-    "GpuTextureFormat",
-    "GpuTextureSampleType",
-    "GpuTextureView",
-    "GpuTextureViewDescriptor",
-    "GpuTextureViewDimension",
-    "GpuUncapturedErrorEvent",
-    "GpuUncapturedErrorEventInit",
-    "GpuValidationError",
-    "GpuVertexAttribute",
-    "GpuVertexBufferLayout",
-    "GpuVertexFormat",
-    "GpuVertexState",
-    "GpuVertexStepMode",
     "HtmlCanvasElement",
     "OffscreenCanvas",
     "ImageBitmap",
     "ImageBitmapRenderingContext",
     "Window",
     "WorkerGlobalScope",
     "WorkerNavigator",
+    # Needed by webgpu_sys
+    "Event",
+    "EventTarget",
 ] }
 wasm-bindgen.workspace = true
 js-sys.workspace = true

wgpu/src/backend/mod.rs

@@ -1,21 +1,8 @@
-#[cfg(all(webgpu, web_sys_unstable_apis))]
+#[cfg(webgpu)]
 mod webgpu;
-#[cfg(all(webgpu, web_sys_unstable_apis))]
+#[cfg(webgpu)]
 pub(crate) use webgpu::{get_browser_gpu_property, ContextWebGpu};
 
-#[cfg(all(webgpu, not(web_sys_unstable_apis)))]
-compile_error!(
-    "webgpu feature used without web_sys_unstable_apis config:
-Here are some ways to resolve this:
-* If you wish to use webgpu backend, create a .cargo/config.toml in the root of the repo containing:
-    [build]
-    rustflags = [ \"--cfg=web_sys_unstable_apis\" ]
-    rustdocflags = [ \"--cfg=web_sys_unstable_apis\" ]
-* If you wish to disable webgpu backend and instead use webgl backend, change your wgpu Cargo.toml entry to:
-    wgpu = { version = \"\", default-features = false, features = [\"webgl\"] }
-"
-);
-
 #[cfg(wgpu_core)]
 mod wgpu_core;