Update to wgpu-native v25.0.2.1 (#718)

* update prerelease header

* run codegen

* fix feature level

* force dxc

* fix marker placement

* revert version info

* update to release

* run codegen

* fix GLSL module

* disable instance extras for CI

* update error messages

* ruff format

* move instance extras

* add compiler enum

* support python3.9 syntax

* amend last commit

* get dlls from resources

* map remaining extras

* cleanup debug code

* avoid crash

* undo restructure

* name both headerfiles

* add logger note

* raise extras error

* add some native flags

* ruff format

* use lib

* write native flags in codegen

* take list of str

* note changes

---------

Co-authored-by: Almar Klein <[email protected]>

Author: Vipitis

CHANGELOG.md

@@ -16,6 +16,16 @@ Possible sections in each release:
 * Fixed: for any bug fixes.
 * Security: in case of vulnerabilities.
 
+### unreleased
+
+Added:
+* New `wgpu.backends.wgpu_native.extra.set_instance_extras()` function to enable additional debug features and using Dxc
+
+Changed:
+* Updated to wgpu-native v25.0.2.1
+
+Fixed:
+* Some native only features with Dx12 backend no longer crash, but can still produce incorrect numbers for push constants and indirect draws. Other backends work as expected, fixes are expected in v26 upstream.
 
 ### [v0.22.2] - 16-05-2025
 

codegen/hparser.py

@@ -54,7 +54,7 @@ def get_h_parser(*, allow_cache=True):
 
 
 class HParser:
-    """Object to parse the wgpu.h header file, by letting cffi do the heavy lifting."""
+    """Object to parse the webgpu.h/wgpu.h header files, by letting cffi do the heavy lifting."""
 
     def __init__(self, source):
         self.source = source
@@ -69,10 +69,10 @@ def parse(self, verbose=True):
         self._parse_from_cffi()
 
         if verbose:
-            print(f"The wgpu.h defines {len(self.functions)} functions")
+            print(f"webgpu.h/wgpu.h define {len(self.functions)} functions")
             keys = "flags", "enums", "structs"
             stats = ", ".join(f"{len(getattr(self, key))} {key}" for key in keys)
-            print("The wgpu.h defines " + stats)
+            print("webgpu.h/wgpu.h define " + stats)
 
     def _parse_from_h(self):
         code = self.source

codegen/wgpu_native_patcher.py

@@ -34,14 +34,14 @@
 def compare_flags():
     """For each flag in WebGPU:
 
-    * Verify that there is a corresponding flag in wgpu.h
+    * Verify that there is a corresponding flag in webgpu.h/wgpu.h
     * Verify that all fields are present too.
     * Verify that the (integer) value is equal.
 
     """
 
     idl = get_idl_parser()
-    hp = get_h_parser()
+    hp = get_h_parser()  # gets both headerfiles!
 
     name_map = {
         "ColorWrite": "ColorWriteMask",
@@ -50,13 +50,13 @@ def compare_flags():
     for name, flag in idl.flags.items():
         name = name_map.get(name, name)
         if name not in hp.flags:
-            print(f"Flag {name} missing in wgpu.h")
+            print(f"Flag {name} missing in webgpu.h/wgpu.h")
         else:
             for key, val in flag.items():
                 key = key.title().replace("_", "")  # MAP_READ -> MapRead
                 key = name_map.get(f"{name}.{key}") or key
                 if key not in hp.flags[name]:
-                    print(f"Flag field {name}.{key} missing in wgpu.h")
+                    print(f"Flag field {name}.{key} missing in webgpu.h/wgpu.h")
                 elif val != hp.flags[name][key]:
                     print(f"Warning: Flag field {name}.{key} have different values.")
 
@@ -70,6 +70,7 @@ def write_mappings():
     idl = get_idl_parser()
     hp = get_h_parser()
 
+    # These maps are empty and thus not used, since no name mapping is (currently) necessary.
     name_map = {}
     name_map_i = {v: k for k, v in name_map.items()}
 
@@ -82,7 +83,7 @@ def write_mappings():
     for name in idl.enums:
         hname = name_map.get(name, name)
         if hname not in hp.enums:
-            print(f"Enum {hname} missing in wgpu.h")
+            print(f"Enum {hname} missing in webgpu.h/wgpu.h")
             continue
         hp_enum = {key.lower(): val for key, val in hp.enums[hname].items()}
         for ikey in idl.enums[name].values():
@@ -91,7 +92,7 @@ def write_mappings():
             if hkey in hp_enum:
                 enummap[name + "." + ikey] = hp_enum[hkey]
             else:
-                print(f"Enum field {name}.{ikey} missing in wgpu.h")
+                print(f"Enum field {name}.{ikey} missing in webgpu.h/wgpu.h")
 
     # Write enummap
     pylines.append(f"# There are {len(enummap)} enum mappings\n")
@@ -126,6 +127,7 @@ def write_mappings():
         ("BackendType", False),
         ("NativeFeature", True),
         ("PipelineStatisticName", True),
+        ("Dx12Compiler", False),
     ):
         pylines.append(f'    "{name}":' + " {")
         for key, val in hp.enums[name].items():
@@ -167,6 +169,20 @@ def write_mappings():
             pylines.append(f'        {val}: "{enum_val}",')
         pylines.append("    },")
     pylines.append("}")
+    pylines.append("")
+
+    # Write a few native-only flags
+    pylines.append("native_flags = {")
+    for name in [
+        "InstanceBackend",
+        "InstanceFlag",
+    ]:
+        for key, val in hp.flags[name].items():
+            if key == "Force32":
+                continue
+            pylines.append(f'    "{name}.{key}": {val},')
+    pylines.append("}")
+    pylines.append("")
 
     # Wrap up
     code = format_code("\n".join(pylines))
@@ -182,8 +198,8 @@ def patch_wgpu_native_backend(code):
 
     For functions:
 
-    * Verify that the function exists in wgpu.h. If not, add a fixme comment.
-    * Add a comment showing corresponding signature from wgpu.h.
+    * Verify that the function exists in webgpu.h/wgpu.h. If not, add a fixme comment.
+    * Add a comment showing corresponding signature from webgpu.h/wgpu.h.
 
     For structs:
 

examples/cube.py

@@ -15,6 +15,7 @@
 import wgpu
 import numpy as np
 
+
 from rendercanvas.auto import RenderCanvas, loop
 
 
@@ -454,7 +455,6 @@ async def draw_frame_async():
 uniform_dtype = [("transform", "float32", (4, 4))]
 uniform_data = np.zeros((), dtype=uniform_dtype)
 
-
 print("Available adapters on this system:")
 for a in wgpu.gpu.enumerate_adapters_sync():
     print(a.summary)

tests/test_wgpu_native_errors.py

@@ -185,7 +185,7 @@ def test_validate_shader_error1(caplog):
            ┌─ :10:20
            │
         10 │     out.position = matrics * out.position;
-           │                    ^^^^^^^^^^^^^^^^^^^^^^ naga::Expression [7]
+           │                    ^^^^^^^^^^^^^^^^^^^^^^ naga::ir::Expression [7]
            │
            = Expression [7] is invalid
            = Operation Multiply can't work with [4] (of type Matrix { columns: Quad, rows: Quad, scalar: Scalar { kind: Float, width: 4 } }) and [6] (of type Vector { size: Tri, scalar: Scalar { kind: Float, width: 4 } })
@@ -238,7 +238,7 @@ def test_validate_shader_error2(caplog):
           ┌─ :9:16
           │
         9 │         return vec3<f32>(1.0, 0.0, 1.0);
-          │                ^^^^^^^^^^^^^^^^^^^^^^^^ naga::Expression [8]
+          │                ^^^^^^^^^^^^^^^^^^^^^^^^ naga::ir::Expression [8]
           │
           = The `return` value Some([8]) does not match the function return value
 

tools/download_wgpu_native.py

@@ -149,7 +149,9 @@ def main(version=None, os_string=None, arch=None, upstream=None):
 
     current_version = get_current_version()
     if version != current_version:
-        print(f"Version changed, updating {VERSION_FILE}")
+        print(
+            f"Version changed, updating {VERSION_FILE}, diff: https://github.com/{upstream}/compare/v{current_version}...v{version}"
+        )
         filename = "commit-sha"
         url = f"https://github.com/{upstream}/releases/download/v{version}/{filename}"
         commit_sha_filename = os.path.join(tmp, filename)

wgpu/_classes.py

@@ -92,7 +92,7 @@ class GPU:
     def request_adapter_sync(
         self,
         *,
-        feaure_level: str = "core",
+        feature_level: str = "core",
         power_preference: enums.PowerPreference = None,
         force_fallback_adapter: bool = False,
         canvas=None,
@@ -105,6 +105,7 @@ def request_adapter_sync(
         from .backends.auto import gpu
 
         return gpu.request_adapter_sync(
+            feature_level=feature_level,
             power_preference=power_preference,
             force_fallback_adapter=force_fallback_adapter,
             canvas=canvas,
@@ -115,7 +116,7 @@ def request_adapter_sync(
     async def request_adapter_async(
         self,
         *,
-        feaure_level: str = "core",
+        feature_level: str = "core",
         power_preference: enums.PowerPreference = None,
         force_fallback_adapter: bool = False,
         canvas=None,
@@ -124,7 +125,7 @@ async def request_adapter_async(
         implementation, from which one can request a `GPUDevice`.
 
         Arguments:
-            feaure_level (str): The feature level "core" (default) or "compatibility".
+            feature_level (str): The feature level "core" (default) or "compatibility".
                 This provides a way to opt into additional validation restrictions.
             power_preference (PowerPreference): "high-performance" or "low-power".
             force_fallback_adapter (bool): whether to use a (probably CPU-based)
@@ -135,7 +136,10 @@ async def request_adapter_async(
         # If this method gets called, no backend has been loaded yet, let's do that now!
         from .backends.auto import gpu
 
+        # note, feature_level current' does nothing: # not used currently: https://gpuweb.github.io/gpuweb/#dom-gpurequestadapteroptions-featurelevel
+
         return await gpu.request_adapter_async(
+            feature_level=feature_level,
             power_preference=power_preference,
             force_fallback_adapter=force_fallback_adapter,
             canvas=canvas,

wgpu/backends/wgpu_native/__init__.py

@@ -11,8 +11,8 @@
 
 
 # The wgpu-native version that we target/expect
-__version__ = "24.0.3.1"
-__commit_sha__ = "e305465e8f1abd2b13878274bf74bbde920096a3"
+__version__ = "25.0.2.1"
+__commit_sha__ = "af9074edf144efe4f1432b2e42c477429c4964c1"
 version_info = tuple(map(int, __version__.split(".")))  # noqa: RUF048
 _check_expected_version(version_info)  # produces a warning on mismatch