A few small tweaks (#118)

* A few  minor fixes

* improve some docstrings related to buffer io

* fix tests

* revert change

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

Author: almarklein

tests/test_api.py

@@ -68,7 +68,10 @@ def test_base_wgpu_api():
 
     # Fake a device and an adapter
     adapter = wgpu.base.GPUAdapter("adapter07", [])
-    device = wgpu.base.GPUDevice("device08", -1, adapter, [42, 43], {}, None)
+    queue = wgpu.GPUQueue("", None, None)
+    device = wgpu.base.GPUDevice("device08", -1, adapter, [42, 43], {}, queue)
+
+    assert queue._device is device
 
     assert adapter.name == "adapter07"
     assert adapter.extensions == ()

wgpu/backends/rs.py

@@ -547,7 +547,7 @@ def _request_device(self, label, extensions, limits, trace_path):
 
         # Get the queue to which commands can be submitted
         queue_id = _lib.wgpu_device_get_default_queue(device_id)
-        queue = GPUQueue("", queue_id, self)
+        queue = GPUQueue("", queue_id, None)
 
         return GPUDevice(label, device_id, self, extensions, limits3, queue)
 
@@ -1206,7 +1206,7 @@ def create_view(
                 label=c_label,
                 format=format,
                 dimension=dimension,
-                aspect=aspect,
+                aspect=aspect or "all",
                 base_mip_level=base_mip_level,
                 level_count=mip_level_count,
                 base_array_layer=base_array_layer,
@@ -1736,7 +1736,7 @@ def write_buffer(self, buffer, buffer_offset, data, data_offset=0, size=None):
     def write_texture(self, destination, data, data_layout, size):
 
         m, address = _get_memoryview_and_address(data)
-        # todo: could we not derive the size from trhe shape of m?
+        # todo: could we not derive the size from the shape of m?
 
         # Checks
         if not m.contiguous:  # no-cover

wgpu/base.py

@@ -171,6 +171,7 @@ def __init__(self, label, internal, adapter, extensions, limits, default_queue):
         self._extensions = tuple(sorted([str(x) for x in extensions]))
         self._limits = limits.copy()
         self._default_queue = default_queue
+        default_queue._device = self  # because it could not be set earlier
 
     @property
     def extensions(self):
@@ -702,6 +703,7 @@ def read_data(self, offset=0, size=0):
         """ Read buffer data. Returns the mapped memory as a memoryview,
         which can be mapped to e.g. a ctypes array or numpy array.
         If size is zero, the remaining size (after offset) is used.
+        The buffer usage must include MAP_READ.
         """
         raise NotImplementedError()
 
@@ -711,7 +713,10 @@ async def read_data_async(self, offset=0, size=0):
 
     def write_data(self, data, offset=0):
         """ Write data to the buffer. The data can be any object
-        supporting the buffer protocol.
+        supporting the buffer protocol. The buffer usage must include MAP_WRITE.
+
+        Note: this method deviates from the WebGPU spec, and it could be deprecated.
+        Better use ``device.create_buffer_with_data()`` or ``queue.write_buffer()``.
         """
         raise NotImplementedError()
 
@@ -1441,7 +1446,7 @@ def write_buffer(self, buffer, buffer_offset, data, data_offset=0, size=None):
         Arguments:
             buffer: The :class:`GPUBuffer` object to write to.
             buffer_offset (int): The offset in the buffer to start writing at.
-            data: The data to write.
+            data: The data to write. Must be contiguous.
             data_offset: The byte offset in the data. Default 0.
             size: The number of bytes to write. Default all minus offset.
         """