Update to latest Webgpu (#166)

* new idl

* apply

* update changelog

* fix

* fix docs

* black

Author: almarklein

CHANGELOG.md

@@ -33,6 +33,7 @@ Added:
 
 Changed:
 
+* Renamed `renderpass.set_blend_color` -> `set_blend_constant`.
 * Stricter validation of SpirV shaders.
 * Float32 texture formats must now use a non-filtering sampler and texture-sample-type.
 * Integer texture formats can no longer use a texture (use `textureLoad` instead).

codegen/README.md

@@ -24,7 +24,8 @@ tests, because we are the only users. If it breaks, we fix it.
 
 ## Links
 
-* Spec and IDL: https://gpuweb.github.io/gpuweb/
+* WebGPU Spec: https://gpuweb.github.io/gpuweb/
+* IDL: https://gpuweb.github.io/gpuweb/webgpu.idl
 * C header: https://github.com/gfx-rs/wgpu/blob/master/ffi/wgpu.h
 
 

codegen/idlparser.py

@@ -224,6 +224,10 @@ def resolve_type(self, typename):
             return name  # ok
         elif name in self.classes:
             return f"'{name}'"  # ok, but wrap in string because can be declared later
+        elif name.startswith("HTML"):
+            return "object"  # anything, we ignore this stuff anyway
+        elif name in ["OffscreenCanvas"]:
+            return "object"
         else:
             assert name.startswith("GPU")
             name = name[3:]

docs/reference_wgpu.rst

@@ -245,3 +245,6 @@ Other
 
 .. autoclass:: wgpu.GPUUncapturedErrorEvent
     :members:
+
+.. autoclass:: wgpu.GPUExternalTexture
+    :members:

tests/test_rs_render.py

@@ -422,7 +422,7 @@ def test_render_orange_square_scissor():
     def cb(renderpass):
         renderpass.set_scissor_rect(0, 0, 32, 32)
         # Alse set blend color. Does not change outout, but covers the call.
-        renderpass.set_blend_color((0, 0, 0, 1))
+        renderpass.set_blend_constant((0, 0, 0, 1))
 
     # Bindings and layout
     bind_group = None

wgpu/backends/rs.py

@@ -588,6 +588,8 @@ def create_bind_group_layout(
                 raise ValueError(
                     "Bind group layout entry did not contain field 'buffer', 'sampler', 'texture', nor 'storage_texture'"
                 )
+                # Unreachable - fool the codegen
+                check_struct("ExternalTextureBindingLayout", info)
             # H: nextInChain: WGPUChainedStruct *, binding: int, visibility: WGPUShaderStageFlags/int, buffer: WGPUBufferBindingLayout, sampler: WGPUSamplerBindingLayout, texture: WGPUTextureBindingLayout, storageTexture: WGPUStorageTextureBindingLayout
             c_entry = new_struct(
                 "WGPUBindGroupLayoutEntry",
@@ -1802,7 +1804,7 @@ def set_scissor_rect(self, x, y, width, height):
             self._internal, int(x), int(y), int(width), int(height)
         )
 
-    def set_blend_color(self, color):
+    def set_blend_constant(self, color):
         color = _tuple_from_tuple_or_dict(color, "rgba")
         # H: r: float, g: float, b: float, a: float
         c_color = new_struct_p(
@@ -2034,18 +2036,18 @@ def read_texture(self, source, data_layout, size):
 
         return data
 
-    # FIXME: new method to implement -> does not exist in wgpu-native
-    def copy_image_bitmap_to_texture(self, source, destination, copy_size):
-        raise NotImplementedError()
-
     # FIXME: new method to implement
     def on_submitted_work_done(self):
         raise NotImplementedError()
 
 
 class GPUSwapChain(base.GPUSwapChain, GPUObjectBase):
-    def __init__(self, label, internal, device, canvas, format, usage):
-        super().__init__(label, internal, device, canvas, format, usage)
+    def __init__(
+        self, label, internal, device, canvas, format, usage, compositing_alpha_mode
+    ):
+        super().__init__(
+            label, internal, device, canvas, format, usage, compositing_alpha_mode
+        )
         assert internal is None  # we set it later
         self._surface_size = (-1, -1)
         self._surface_id = None
@@ -2137,6 +2139,10 @@ class GPUUncapturedErrorEvent(base.GPUUncapturedErrorEvent):
     pass
 
 
+class GPUExternalTexture(base.GPUExternalTexture, GPUObjectBase):
+    pass
+
+
 # %%
 
 

wgpu/base.py

@@ -30,13 +30,14 @@
     "GPUBuffer",
     "GPUTexture",
     "GPUTextureView",
+    "GPUExternalTexture",
     "GPUSampler",
     "GPUBindGroupLayout",
     "GPUBindGroup",
     "GPUPipelineLayout",
+    "GPUShaderModule",
     "GPUCompilationMessage",
     "GPUCompilationInfo",
-    "GPUShaderModule",
     "GPUPipelineBase",
     "GPUComputePipeline",
     "GPURenderPipeline",
@@ -125,17 +126,21 @@ def configure_swap_chain(
         device: "GPUDevice",
         format: "enums.TextureFormat",
         usage: "flags.TextureUsage" = 0x10,
+        compositing_alpha_mode: "enums.CanvasCompositingAlphaMode" = "opaque",
     ):
         """Get a :class:`GPUSwapChain` object for this canvas.
 
         Arguments:
             device (WgpuDevice): The GPU device object.
             format (TextureFormat): The texture format, e.g. "bgra8unorm-srgb".
             usage (TextureUsage): Default ``TextureUsage.OUTPUT_ATTACHMENT``.
+            compositing_alpha_mode (CanvasCompositingAlphaMode): Default opaque.
         """
         usage = usage or flags.TextureUsage.RENDER_ATTACHMENT
         GPUSwapChain = sys.modules[device.__module__].GPUSwapChain  # noqa: N806
-        return GPUSwapChain(label, None, device, self, format, usage)
+        return GPUSwapChain(
+            label, None, device, self, format, usage, compositing_alpha_mode
+        )
 
     # IDL: GPUTextureFormat getSwapChainPreferredFormat(GPUAdapter adapter);
     def get_swap_chain_preferred_format(self, adapter):
@@ -543,7 +548,7 @@ def create_shader_module(self, *, label="", code: str, source_map: dict = None):
         Arguments:
             label (str): A human readable label. Optional.
             code (str | bytes): The shader code, as WGSL text or binary SpirV
-            (or an object implementing ``to_spirv()`` or ``to_bytes()``).
+                (or an object implementing ``to_spirv()`` or ``to_bytes()``).
         """
         raise NotImplementedError()
 
@@ -781,6 +786,17 @@ def push_error_scope(self, filter):
     def pop_error_scope(self):
         raise NotImplementedError()
 
+    # IDL: GPUExternalTexture importExternalTexture(GPUExternalTextureDescriptor descriptor);
+    @apidiff.hide("Specific to browsers.")
+    def import_external_texture(
+        self,
+        *,
+        label="",
+        source: object,
+        color_space: "enums.PredefinedColorSpace" = "srgb",
+    ):
+        raise NotImplementedError()
+
 
 class GPUBuffer(GPUObjectBase):
     """
@@ -1494,8 +1510,8 @@ def set_scissor_rect(self, x, y, width, height):
         """
         raise NotImplementedError()
 
-    # IDL: undefined setBlendColor(GPUColor color);
-    def set_blend_color(self, color):
+    # IDL: undefined setBlendConstant(GPUColor color);
+    def set_blend_constant(self, color):
         """Set the blend color for the render pass.
 
         Arguments:
@@ -1592,13 +1608,6 @@ def submit(self, command_buffers):
         """
         raise NotImplementedError()
 
-    # IDL: undefined copyImageBitmapToTexture( GPUImageCopyImageBitmap source, GPUImageCopyTexture destination, GPUExtent3D copySize);
-    def copy_image_bitmap_to_texture(self, source, destination, copy_size):
-        """
-        TODO: not yet available in wgpu-native
-        """
-        raise NotImplementedError()
-
     # IDL: undefined writeBuffer( GPUBuffer buffer, GPUSize64 bufferOffset, [AllowShared] BufferSource data, optional GPUSize64 dataOffset = 0, optional GPUSize64 size);
     def write_buffer(self, buffer, buffer_offset, data, data_offset=0, size=None):
         """Takes the data contents and schedules a write operation of
@@ -1683,6 +1692,11 @@ def on_submitted_work_done(self):
         """TODO"""
         raise NotImplementedError()
 
+    # IDL: undefined copyExternalImageToTexture( GPUImageCopyExternalImage source, GPUImageCopyTexture destination, GPUExtent3D copySize);
+    @apidiff.hide("Specific to browsers.")
+    def copy_external_image_to_texture(self, source, destination, copy_size):
+        raise NotImplementedError()
+
 
 @apidiff.change(
     "the swapchain should be used as a context manager to obtain the texture view"
@@ -1714,11 +1728,14 @@ class GPUSwapChain(GPUObjectBase):
     You can obtain a swap chain using :func:`device.configure_swap_chain() <GPUDevice.configure_swap_chain>`.
     """
 
-    def __init__(self, label, internal, device, canvas, format, usage):
+    def __init__(
+        self, label, internal, device, canvas, format, usage, compositing_alpha_mode
+    ):
         super().__init__(label, internal, device)
         self._canvas = canvas
         self._format = format
         self._usage = usage
+        self._compositing_alpha_mode = compositing_alpha_mode
 
     # IDL: GPUTexture getCurrentTexture();
     def get_current_texture(self):
@@ -1813,6 +1830,18 @@ def line_pos(self):
         """The position on the line in the shader source."""
         raise NotImplementedError()
 
+    # IDL: readonly attribute unsigned long long offset;
+    @property
+    def offset(self):
+        """Offset of ..."""
+        raise NotImplementedError()
+
+    # IDL: readonly attribute unsigned long long length;
+    @property
+    def length(self):
+        """The length of the line?"""
+        raise NotImplementedError()
+
 
 # FIXME: new class to implement
 class GPUCompilationInfo:
@@ -1850,6 +1879,10 @@ def __init__(self, type, gpu_uncaptured_error_event_init_dict):
         pass
 
 
+class GPUExternalTexture(GPUObjectBase):
+    """Ignore this - specific to browsers."""
+
+
 # %%%%% Post processing
 
 apidiff.remove_hidden_methods(globals())

wgpu/enums.py

@@ -25,7 +25,12 @@ def __repr__(self):
         return f"<{self.__class__.__name__} {self._name}: {options}>"
 
 
-# There are 29 enums
+# There are 31 enums
+
+PredefinedColorSpace = Enum(
+    "PredefinedColorSpace",
+    srgb="srgb",
+)  #:
 
 PowerPreference = Enum(
     "PowerPreference",
@@ -215,17 +220,17 @@ def __repr__(self):
     "BlendFactor",
     zero="zero",
     one="one",
-    src_component="src-component",
-    one_minus_src_component="one-minus-src-component",
+    src="src",
+    one_minus_src="one-minus-src",
     src_alpha="src-alpha",
     one_minus_src_alpha="one-minus-src-alpha",
-    dst_component="dst-component",
-    one_minus_dst_component="one-minus-dst-component",
+    dst="dst",
+    one_minus_dst="one-minus-dst",
     dst_alpha="dst-alpha",
     one_minus_dst_alpha="one-minus-dst-alpha",
     src_alpha_saturated="src-alpha-saturated",
-    blendcolor_component="blendcolor-component",
-    one_minus_blendcolor_component="one-minus-blendcolor-component",
+    constant="constant",
+    one_minus_constant="one-minus-constant",
 )  #:
 
 BlendOperation = Enum(
@@ -322,6 +327,12 @@ def __repr__(self):
     compute_shader_invocations="compute-shader-invocations",
 )  #:
 
+CanvasCompositingAlphaMode = Enum(
+    "CanvasCompositingAlphaMode",
+    opaque="opaque",
+    premultiplied="premultiplied",
+)  #:
+
 DeviceLostReason = Enum(
     "DeviceLostReason",
     destroyed="destroyed",

wgpu/resources/codegen_report.md

@@ -1,40 +1,42 @@
 # Code generatation report
 ## Preparing
-* The webgpu.idl defines 33 classes with 81 functions
-* The webgpu.idl defines 5 flags, 29 enums, 50 structs
+* The webgpu.idl defines 34 classes with 82 functions
+* The webgpu.idl defines 5 flags, 31 enums, 52 structs
 * The wgpu.h defines 106 functions
 * The wgpu.h defines 5 flags, 36 enums, 58 structs
 ## Updating API
 * Wrote 5 flags to flags.py
-* Wrote 29 enums to enums.py
-* Wrote 50 structs to structs.py
+* Wrote 31 enums to enums.py
+* Wrote 52 structs to structs.py
 ### Patching API for base.py
 * Diffs for GPU: change request_adapter, change request_adapter_async
 * Diffs for GPUAdapter: add properties
-* Diffs for GPUDevice: add adapter, add create_buffer_with_data, hide pop_error_scope, hide push_error_scope
+* Diffs for GPUDevice: add adapter, add create_buffer_with_data, hide import_external_texture, hide pop_error_scope, hide push_error_scope
 * Diffs for GPUBuffer: add map_read, add map_write, add size, add usage, hide get_mapped_range, hide map_async, hide unmap
 * Diffs for GPUTexture: add dimension, add format, add mip_level_count, add sample_count, add size, add usage
 * Diffs for GPUTextureView: add size, add texture
 * Diffs for GPUComputePassEncoder: hide begin_pipeline_statistics_query, hide end_pipeline_statistics_query
 * Diffs for GPURenderPassEncoder: hide begin_pipeline_statistics_query, hide end_pipeline_statistics_query
-* Diffs for GPUQueue: add read_buffer, add read_texture
-* Validated 33 classes, 108 methods, 31 properties
+* Diffs for GPUQueue: add read_buffer, add read_texture, hide copy_external_image_to_texture
+* Validated 34 classes, 109 methods, 33 properties
 ### Patching API for backends/rs.py
 * Diffs for GPUAdapter: add request_device_tracing
-* Validated 33 classes, 96 methods, 0 properties
+* Validated 34 classes, 95 methods, 0 properties
 ## Validating rs.py
+* Enum PredefinedColorSpace missing in wgpu.h
 * Enum PowerPreference missing in wgpu.h
 * Enum FeatureName missing in wgpu.h
 * Enum field TextureFormat.depth16unorm missing in wgpu.h
 * Enum field TextureFormat.depth24unorm-stencil8 missing in wgpu.h
 * Enum field TextureFormat.depth32float-stencil8 missing in wgpu.h
 * Enum CompilationMessageType missing in wgpu.h
-* Enum field BlendFactor.src-component missing in wgpu.h
-* Enum field BlendFactor.one-minus-src-component missing in wgpu.h
-* Enum field BlendFactor.dst-component missing in wgpu.h
-* Enum field BlendFactor.one-minus-dst-component missing in wgpu.h
-* Enum field BlendFactor.blendcolor-component missing in wgpu.h
-* Enum field BlendFactor.one-minus-blendcolor-component missing in wgpu.h
+* Enum field BlendFactor.src missing in wgpu.h
+* Enum field BlendFactor.one-minus-src missing in wgpu.h
+* Enum field BlendFactor.dst missing in wgpu.h
+* Enum field BlendFactor.one-minus-dst missing in wgpu.h
+* Enum field BlendFactor.constant missing in wgpu.h
+* Enum field BlendFactor.one-minus-constant missing in wgpu.h
+* Enum CanvasCompositingAlphaMode missing in wgpu.h
 * Enum DeviceLostReason missing in wgpu.h
 * Wrote 169 enum mappings and 45 struct-field mappings to rs_mappings.py
 * Validated 65 C function calls