upgrade to wgpu-native v27.0.2.0 (#741)

* v26 headers

* initial codegen

* update error message

* enable polygon mode

* drop dxill requirement

* download 27.0.2.0 release

* run codegen

* update error messages

* multi-draw-indirect feature no longer needed

* maybe fix query set destroy panic

* fix polygonmode

* add new dx12 extras

* ruff format

* update extras documentation

* Some tweaks related to destroy

* remove br and use more backticks

* Update wgpu/_classes.py

* bump pypy python version

---------

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

Author: Vipitis

.github/workflows/ci.yml

@@ -170,7 +170,7 @@ jobs:
             pyversion: '3.13'
           - name: Test Linux pypy3
             os: ubuntu-latest
-            pyversion: 'pypy3.10'
+            pyversion: 'pypy3.11'
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.pyversion }}

codegen/wgpu_native_patcher.py

@@ -128,6 +128,7 @@ def write_mappings():
         ("NativeFeature", True),
         ("PipelineStatisticName", True),
         ("Dx12Compiler", False),
+        ("PolygonMode", False),
     ):
         pylines.append(f'    "{name}":' + " {")
         for key, val in hp.enums[name].items():

docs/backends.rst

@@ -317,18 +317,20 @@ given in a different order in the list.
 
     :param encoder: The ComputePassEncoder or RenderPassEncoder.
 
-.. py:function:: wgpu.backends.wgpu_native.set_instance_extras(backends, flags, dx12_compiler, gles3_minor_version, fence_behavior, dxil_path, dxc_path, dxc_max_shader_model)
+.. py:function:: wgpu.backends.wgpu_native.set_instance_extras(backends, flags, dx12_compiler, gles3_minor_version, fence_behavior, dxc_path, dxc_max_shader_model, budget_for_device_creation, budget_for_device_loss)
 
     Sets the global instance with extras. Needs to be called before instance is created (in enumerate_adapters or request_adapter).
+    Most of these options are for specific backends, and might not create an instance or crash when used in the wrong combinations. 
 
     :param backends: bitflags as list[str], which backends to enable on the instance level. Defaults to ``["All"]``. Can be any combination of ``["Vulkan", "GL", "Metal", "DX12", "BrowserWebGPU"]`` or the premade combinations ``["All", "Primary", "secondary"]``. Note that your device needs to support these backends, for detailed information see https://docs.rs/wgpu/latest/wgpu/struct.Backends.html
     :param flags: bitflags as list[str], debug flags for the compiler. Defaults to ``["Default"]``, can be any combination of ``["Debug", "Validation", "DiscardHalLabels"]``.
     :param dx12_compiler: enum/str, either "Fxc", "Dxc" or "Undefined". Defaults to "Fxc" same as "Undefined". Dxc requires additional library files.
     :param gles3_minor_version: enum/int 0, 1 or 2. Defaults to "Atomic" (handled by driver).
     :param fence_behavior: enum/int, "Normal" or "AutoFinish", Default to "Normal".
-    :param dxil_path: str, path to dxil.dll, defaults to ``None``. None looks in the resource directory.
     :param dxc_path: str, path to dxcompiler.dll, defaults to ``None``. None looks in the resource directory.
     :param dxc_max_shader_model: float between 6.0 and 6.7, Maximum shader model the given dll supports. Defaults to 6.5.
+    :param budget_for_device_creation: Optional[int], between 0 and 100, to specify memory budget threshold for when creating resources (buffer, textures...) will fail. Defaults to None.
+    :param budget_for_device_loss: Optional[int], between 0 and 100, to specify memory budget threshold when the device will be lost. Defaults to None.
 
 Use like the following before the instance is created, which happens during request_adapter or enumerate_adapters.
 

examples/extras_dxc.py

@@ -17,8 +17,11 @@
         "DX12"
     ],  # using the env var `WGPU_BACKEND_TYPE` happens later during request_device, so you can only select backends that are requested for the instance
     dx12_compiler="Dxc",  # request the Dxc compiler to be used
-    # dxil_path and dxc_path can be set for a custom Dxc location
+    # dxc_path can be set for a custom Dxc location
     dxc_max_shader_model=6.7,
+    # by setting these limits to percentages 0..100 you will get a Validation Error, should too much memory be requested.
+    budget_for_device_creation=99,
+    budget_for_device_loss=97,
 )
 
 

tests/test_wgpu_native_basics.py

@@ -414,8 +414,8 @@ def are_features_wgpu_legal(features):
 def test_features_are_legal():
     # A standard feature.  Probably exists
     assert are_features_wgpu_legal(["shader-f16"])
-    # Two common extension features
-    assert are_features_wgpu_legal(["multi-draw-indirect", "vertex-writable-storage"])
+    # A common extension feature
+    assert are_features_wgpu_legal(["vertex-writable-storage"])
     # An uncommon extension feature.  Certainly not on a mac.
     assert are_features_wgpu_legal(["pipeline-statistics-query"])
     assert are_features_wgpu_legal(
@@ -429,9 +429,7 @@ def test_features_are_legal():
 
 def test_features_are_illegal():
     # writable is misspelled
-    assert not are_features_wgpu_legal(
-        ["multi-draw-indirect", "vertex-writeable-storage"]
-    )
+    assert not are_features_wgpu_legal(["vertex-writeable-storage"])
     assert not are_features_wgpu_legal(["my-made-up-feature"])
 
 

tests/test_wgpu_native_errors.py

@@ -3,7 +3,6 @@
 from testutils import run_tests
 from pytest import raises
 
-
 dedent = lambda s: s.replace("\n        ", "\n").strip()
 
 
@@ -36,9 +35,6 @@ def test_parse_shader_error1(caplog):
           │
         9 │     out.invalid_attr = vec4<f32>(0.0, 0.0, 1.0);
           │         ^^^^^^^^^^^^ invalid accessor
-
-
-              invalid field accessor `invalid_attr`
     """
 
     code = dedent(code)
@@ -47,6 +43,7 @@ def test_parse_shader_error1(caplog):
         device.create_shader_module(code=code)
 
     error = err.value.message
+    error = error.rstrip("\n")
     assert error == expected, f"Expected:\n\n{expected}"
 
 
@@ -72,9 +69,6 @@ def test_parse_shader_error2(caplog):
           │
         2 │     @location(0) texcoord : vec2<f32>;
           │                                      ^ expected `,`
-
-
-              expected `,`, found ";"
     """
 
     code = dedent(code)
@@ -83,6 +77,7 @@ def test_parse_shader_error2(caplog):
         device.create_shader_module(code=code)
 
     error = err.value.message
+    error = error.rstrip("\n")
     assert error == expected, f"Expected:\n\n{expected}"
 
 
@@ -108,9 +103,6 @@ def test_parse_shader_error3(caplog):
           │
         3 │     @builtin(position) position: vec4<f3>,
           │                                       ^^ unknown type
-
-
-              unknown type: `f3`
     """
 
     code = dedent(code)
@@ -119,6 +111,7 @@ def test_parse_shader_error3(caplog):
         device.create_shader_module(code=code)
 
     error = err.value.message
+    error = error.rstrip("\n")
     assert error == expected, f"Expected:\n\n{expected}"
 
 
@@ -140,9 +133,6 @@ def test_parse_shader_error4(caplog):
           In wgpuDeviceCreateShaderModule
 
         Shader '' parsing error: Index 4 is out of bounds for expression [10]
-
-
-      Index 4 is out of bounds for expression [10]
     """
 
     code = dedent(code)
@@ -151,6 +141,7 @@ def test_parse_shader_error4(caplog):
         device.create_shader_module(code=code)
 
     error = err.value.message
+    error = error.rstrip("\n")  # seems to have tailing newlines sometimes?
     assert error == expected, f"Expected:\n\n{expected}"
 
 
@@ -191,9 +182,8 @@ def test_validate_shader_error1(caplog):
            = 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 } })
 
 
-              Entry point vs_main at Vertex is invalid
-                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 } })
+              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 } })
     """
 
     code = dedent(code)
@@ -227,7 +217,7 @@ def test_validate_shader_error2(caplog):
         }
     """
 
-    expected1 = """Returning Some(Vector { size: Tri, scalar: Scalar { kind: Float, width: 4 } }) where Some(Vector { size: Quad, scalar: Scalar { kind: Float, width: 4 } }) is expected"""
+    expected1 = """Returning Some(Handle([3])) where Some([0]) is expected"""
     expected2 = """
         Validation Error
 
@@ -240,11 +230,10 @@ def test_validate_shader_error2(caplog):
         9 │         return vec3<f32>(1.0, 0.0, 1.0);
           │                ^^^^^^^^^^^^^^^^^^^^^^^^ naga::ir::Expression [8]
           │
-          = The `return` value Some([8]) does not match the function return value
+          = The `return` expression Some([8]) does not match the declared return type Some([0])
 
 
-              Entry point fs_main at Vertex is invalid
-                The `return` value Some([8]) does not match the function return value
+              The `return` expression Some([8]) does not match the declared return type Some([0])
     """
 
     code = dedent(code)

tests/test_wgpu_vertex_instance.py

@@ -70,7 +70,7 @@
 
 class Runner:
     REQUIRED_FEATURES = ["indirect-first-instance"]
-    OPTIONAL_FEATURES = ["multi-draw-indirect", "multi-draw-indirect-count"]
+    OPTIONAL_FEATURES = ["multi-draw-indirect-count"]
 
     @classmethod
     def is_usable(cls):
@@ -263,9 +263,6 @@ def draw(encoder):
 
 
 def test_multi_draw_indirect(runner):
-    if "multi-draw-indirect" not in runner.device.features:
-        pytest.skip("Must have 'multi-draw-indirect' to run")
-
     def draw(encoder):
         multi_draw_indirect(encoder, runner.draw_data_buffer, offset=8, count=2)
 
@@ -329,9 +326,6 @@ def draw(encoder):
 
 
 def test_multi_draw_indexed_indirect(runner):
-    if "multi-draw-indirect" not in runner.device.features:
-        pytest.skip("Must have 'multi-draw-indirect' to run")
-
     def draw(encoder):
         multi_draw_indexed_indirect(
             encoder, runner.draw_data_buffer_indexed, offset=8, count=2

tests_mem/test_destroy.py

@@ -28,17 +28,27 @@ def test_destroy_device(n):
     for i in range(n):
         d = adapter.request_device_sync()
         d.destroy()
-        # NOTE: destroy is not yet implemented in wgpu-native - this does not actually do anything yet
+        # d.destroy()  # fine to call multiple times
+
+        # Uncomment the following lines to see. These are commented because it makes wgpu-core create a buffer.
+        # error = None
+        # try:
+        #     d.create_buffer(size=128, usage=wgpu.BufferUsage.UNIFORM)
+        # except wgpu.GPUValidationError as err:
+        #     error = err
+        # assert error and "device is lost" in error.message.lower()
+
         yield d
 
 
 @create_and_release
 def test_destroy_query_set(n):
-    yield {}
+    yield {
+        "expected_counts_after_create": {"QuerySet": (n, 0)},
+    }
     for i in range(n):
         qs = DEVICE.create_query_set(type=wgpu.QueryType.occlusion, count=2)
         qs.destroy()
-        # NOTE: destroy is not yet implemented in wgpu-native - this does not actually do anything yet
         yield qs
 
 
@@ -56,11 +66,12 @@ def test_destroy_buffer(n):
         # can still be queries from wgpu-native, but it cannot be used.
 
         # Uncomment the following lines to see. These are commented because it makes wgpu-core create a command-buffer.
+        # error = None
         # try:
         #     b.map_sync("READ")
         # except wgpu.GPUValidationError as err:
         #     error = err
-        # assert "destroyed" in error.message.lower()
+        # assert error and "destroyed" in error.message.lower()
 
         yield b
 
@@ -77,11 +88,13 @@ def test_destroy_texture(n):
         t.destroy()
 
         # Uncomment the following lines to see. These are commented because the views are created at the native side, but we never store them, but we also don't release them.
+        # error = None
         # try:
         #     t.create_view()
         # except wgpu.GPUValidationError as err:
         #     error = err
-        # assert "destroyed" in error.message.lower()
+        # assert error and "destroyed" in error.message.lower()
+
         yield t
 
 

tests_mem/test_objects.py

@@ -126,7 +126,7 @@ def test_release_command_encoder(n):
     yield {
         "expected_counts_after_create": {
             "CommandEncoder": (n, 0),
-            "CommandBuffer": (0, n),
+            # "CommandBuffer": (0, n),
         },
     }
 

tools/download_dxc.py

@@ -59,11 +59,8 @@ def main(version=None):
     print(f"Downloading {url}")
     download_file(url, zip_filename)
     compiler_file = "dxcompiler.dll"
-    signing_file = "dxil.dll"  # in v26 this won't be needed anymore
     print(f"Extracting {compiler_file} to {RESOURCE_DIR}")
     extract_file(zip_filename, compiler_file, RESOURCE_DIR)
-    print(f"Extracting {signing_file} to {RESOURCE_DIR}")
-    extract_file(zip_filename, signing_file, RESOURCE_DIR)
 
     # cleanup of tempfile?
     # os.remove(zip_filename)