wgpu v0.13 release notes (2022-06-30)

« Changelog History

wgpu v0.13 Release Notes

Release Date: 2022-06-30 // almost 2 years ago

Major Changes

WGSL Syntax

WGSL syntax has changed in a couple ways. The new syntax is easier to read and work with.

Attribute declarations are written differently:
```
- [[group(1), binding(0)]]
+ @group(1) @binding(0)
```
Stage declarations are now separate attributes rather than part of the stage attribute:
```
- [[stage(vertex)]]
+ @vertex
```
Structs now use , as field separator and no longer need semicolons after the declaration:
```
- struct MyStruct {
-     my_member: u32;
- };
+ struct MyStruct {
+     my_member: u32,
+ }
```
Surface API

👍 The method of getting the preferred swapchain format has changed to allow viewing all formats supported by the surface.
```
- let format = surface.get_preferred_format(&adapter).unwrap();
+ let format = surface.get_supported_formats(&adapter)[0];
```
Presentation modes now need to match exactly what the surface supports. FIFO is always supported, 👍 but all other modes vary from API to API and Device to Device. To get a list of all supported modes, call the following. The order does not indicate preference.
```
let modes = surface.get_supported_present_modes(&adapter);
```
Timestamp Queries

Timestamp queries are now restricted behind multiple features to allow implementation on TBDR (Tile-Based Deferred Rendering) based GPUs, such as mobile devices and Apple's M chips.

Features::TIMESTAMP_QUERIES now allows for calling write_timestamp only on CommandEncoders.

Features::WRITE_TIMESTAMP_INSIDE_PASSES is needed to call write_timestamp on RenderPassEncoders or ComputePassEncoders.

map_async

The function for mapping buffers no longer returns a future, and instead calls a callback when the buffer is mapped.

This aligns with the use of the API more clearly - you aren't supposed to block and wait on the future to resolve, you are supposed to keep rendering and wait until the buffer maps on its own. Mapping and the flow of mapping is an under-documented area that we hope to improve in the future.
```
- let future = buffer.slice(..).map_async(MapMode::Read);
+ buffer.slice(..).map_async(MapMode::Read, || {
+     // Called when buffer is mapped.
+ })
```
Submission Indexes

Calling queue.submit now returns an opaque submission index that can be used as an argument to 📊 device.poll to say which submission to wait to complete.

Other Breaking Changes

Device::create_shader_module now takes the shader descriptor by value:
```
- device.create_shader_module(&shader_module_descriptor)
+ device.create_shader_module(shader_module_descriptor)
```
📜 Color attachments can be sparse, so they are now optional:
```
FragmentState {
-  targets: &[color_target_state]
+  targets: &[Some(color_target_state)]
  // ..
}
```
```
RenderPassDescriptor {
-  color_attachments: &[render_pass_color_attachment]
+  color_attachments: &[Some(render_pass_color_attachment)]
  // ..
}
```
```
RenderBundleEncoderDescriptor {
-  color_formats: &[texture_format]
+  color_formats: &[Some(texture_format)]
  // ..
}
```
Extent3d::max_mips now requires you to pass a TextureDimension to specify whether or not depth_or_array_layers should be ignored:
```
Extent3d {
  width: 1920,
  height: 1080,
  depth_or_array_layers: 6,
- }.max_mips()
+ }.max_mips(wgpu::TextureDimension::D3)
```
Limits has a new field, max_buffer_size (not an issue if you don't define limits manually):
```
Limits {
  // ...
+ max_buffer_size: 256 * 1024 * 1024, // adjust as you see fit
}
```
Features::CLEAR_COMMANDS is now unnecessary and no longer exists. The feature to clear buffers and textures is now part of upstream WebGPU.
```
DeviceDescriptor {
  // ...
  features: wgpu::Features::VERTEX_WRITABLE_STORAGE
    | wgpu::Features::MAPPABLE_PRIMARY_BUFFERS
    | wgpu::Features::TEXTURE_BINDING_ARRAY
    | wgpu::Features::BUFFER_BINDING_ARRAY
    | wgpu::Features::STORAGE_RESOURCE_BINDING_ARRAY
-    | wgpu::Features::CLEAR_COMMANDS
  ,
}
```
ComputePass::dispatch has been renamed to ComputePass::dispatch_workgroups
```
- cpass.dispatch(self.work_group_count, 1, 1)
+ cpass.dispatch_workgroups(self.work_group_count, 1, 1)
```
➕ Added/New Features

General
- ➕ Add util::indirect::* helper structs by @IcanDivideBy0 in #2365
- ➕ Add AddressMode::ClampToZero by @laptou in #2364
- ➕ Add MULTISAMPLED_SHADING downlevel flag by @jinleili in #2425
- 👍 Allow non struct buffers in wgsl by @IcanDivideBy0 in #2451
- Prefix every wgpu-generated label with (wgpu). by @kpreid in #2590
- Permit non-struct, non-array types as buffers. by @jimblandy in #2584
- 📊 Return queue_empty for Device::poll by @xiaopengli89 in #2643
- ➕ Add SHADER_FLOAT16 feature by @jinleili in #2646
- ➕ Add DEPTH32FLOAT_STENCIL8 featue by @jinleili in #2664
- ➕ Add DEPTH24UNORM_STENCIL8 feature by @jinleili in #2689
- Implement submission indexes by @cwfitzgerald in #2700
- [WebGL] Add a downlevel capability for rendering to floating point textures by @expenses in #2729
- 👍 allow creating wgpu::Instance from wgpu_core::Instance by @i509VCB in #2763
- 👮 Force binding sizes to be multiples of 16 on webgl by @cwfitzgerald in #2808
- ➕ Add Naga variant to ShaderSource by @rttad in #2801
- Implement Queue::write_buffer_with by @teoxoy in #2777
Vulkan
- Re-allow vk backend on Apple platforms via vulkan-portability feature by @jinleili in #2488
- 👍 vulkan: HDR ASTC formats support by @jinleili in #2496
Metal
- Implement push constants for metal backend by @TheOnlyMrCat in #2314
- 👍 Metal backend ASTC HDR formats support by @jinleili in #2477
- ➕ Add COPY_DST to Metal's surface usage bits by @vl4dimir in #2491
- Add Features::MULTI_DRAW_INDIRECT to Metal by @expenses in #2737
GLES
- 👌 Support externally initialized contexts by @kvark in #2350
- 🍎 Angle support on macOS by @jinleili in #2461
- 👉 Use EGL surfaceless platform when windowing system is not found by @sh7dm in #2339
- Do a downlevel check for anisotrophy and enable it in the webgl backend by @expenses in #2616
- 👍 OffscreenCanvas Support for WebGL Backend by @haraldreingruber-dedalus in #2603
DX12
- 👌 Support to create surface from visual on Windows by @xiaopengli89 in #2434
- ➕ Add raw_queue for d3d12 device by @xiaopengli89 in #2600
DX11
- Skeleton of a DX11 backend - not working yet by @cwfitzgerald in #2443
Hal
- Adapter and Instance as_hal functions by @i509VCB in #2663
- 🔦 expose some underlying types in Vulkan hal by @i509VCB in #2667
- ➕ Add raw_device method for dx12, vulkan hal by @xiaopengli89 in #2360
- 🔦 expose egl display in gles Instance hal by @i509VCB in #2670
- ➕ Add raw_adapter method for dx12 hal adapter by @xiaopengli89 in #2714
- Acquire texture: Option<std::time::Duration> timeouts by @rib in #2724
- 🔦 expose vulkan physical device capabilities, enabled device extensions by @i509VCB in #2688
Emscripten
- 🔋 feature: emscripten by @caiiiycuk in #2422
- 🔋 feature = emscripten, compability fixes for wgpu-native by @caiiiycuk in #2450
🔄 Changes

General
- 👉 Make ShaderSource #[non_exhaustive] by @fintelia in #2312
- 👉 Make execute_bundles() receive IntoIterator by @maku693 in #2410
- Raise wgpu_hal::MAX_COLOR_TARGETS to 8. by @jimblandy in #2640
- 📇 Rename dispatch -> dispatch_workgroups by @jinleili in #2619
- Update texture_create_view logic to match spec by @jinleili in #2621
- Move TEXTURE_COMPRESSION_ETC2 | ASTC_LDR to web section to match spec by @jinleili in #2671
- Check that all vertex outputs are consumed by the fragment shader by @cwfitzgerald in #2704
- Convert map_async from being async to being callback based by @cwfitzgerald in #2698
- Align the validation of Device::create_texture with the WebGPU spec by @nical in #2759
- Add InvalidGroupIndex validation at create_shader_module by @jinleili in #2775
- Rename MAX_COLOR_TARGETS to MAX_COLOR_ATTACHMENTS to match spec by @jinleili in #2780
- Change get_preferred_format to get_supported_formats by @stevenhuyn in #2783
- Restrict WriteTimestamp Inside Passes by @cwfitzgerald in #2802
- 👍 Flip span labels to work better with tools by @cwfitzgerald in #2820
Gles
- 0️⃣ Make GLES DeviceType unknown by default by @PolyMeilex in #2647
Metal
- metal: check if in the main thread when calling create_surface by @jinleili in #2736
Hal
- limit binding sizes to i32 by @kvark in #2363
🐛 Bug Fixes

General
- 🛠 Fix trac(y/ing) compile issue by @cwfitzgerald in #2333
- 👌 Improve detection and validation of cubemap views by @kvark in #2331
- Don't create array layer trackers for 3D textures. by @ElectronicRU in #2348
- Limit 1D texture mips to 1 by @kvark in #2374
- Texture format MSAA capabilities by @kvark in #2377
- 🛠 Fix write_buffer to surface texture @kvark in #2385
- 👌 Improve some error messages by @cwfitzgerald in #2446
- Don't recycle indices that reach EOL by @kvark in #2462
- Validated render usages for 3D textures by @kvark in #2482
- 🔊 Wrap all validation logs with catch_unwinds by @cwfitzgerald in #2511
- 🛠 Fix clippy lints by @a1phyr in #2560
- 🆓 Free the raw device when wgpu::Device is dropped. by @jimblandy in #2567
- wgpu-core: Register new pipelines with device's tracker. by @jimblandy in #2565
- impl Debug for StagingBelt by @kpreid in #2572
- 👉 Use fully qualified syntax for some calls. by @jimblandy in #2655
- 🛠 fix: panic in Storage::get by @SparkyPotato in #2657
- Report invalid pipelines in render bundles as errors, not panics. by @jimblandy in #2666
- Perform "valid to use with" checks when recording render bundles. by @jimblandy in #2690
- Stop using storage usage for sampling by @cwfitzgerald in #2703
- Track depth and stencil writability separately. by @jimblandy in #2693
- 👌 Improve InvalidScissorRect error message by @jinleili in #2713
- 👌 Improve InvalidViewport error message by @jinleili in #2723
- Don't dirty the vertex buffer for stride/rate changes on bundles. by @jimblandy in #2744
- Clean up render bundle index buffer tracking. by @jimblandy in #2743
- 👌 Improve read-write and read-only texture storage error message by @jinleili in #2745
- Change WEBGPU_TEXTURE_FORMAT_SUPPORT to 1 << 14 instead of 1 << 15 by @expenses in #2772
- 🛠 fix BufferMapCallbackC & SubmittedWorkDoneClosureC by @rajveermalviya in #2787
- 🛠 Fix formatting of TextureDimensionError::LimitExceeded. by @kpreid in #2799
- ✂ Remove redundant #[cfg] conditions from backend/direct.rs. by @jimblandy in #2811
- Replace android-properties with android_system_properties. by @nical in #2815
- 😌 Relax render pass color_attachments validation by @jinleili in #2778
- Properly Barrier Compute Indirect Buffers by @cwfitzgerald in #2810
- 👉 Use numeric constants to define wgpu_types::Features values. by @jimblandy in #2817
Metal
- 🛠 Fix surface texture clear view by @kvark in #2341
- Set preserveInvariance for shader options by @scoopr in #2372
- 👍 Properly set msl version to 2.3 if supported by @cwfitzgerald in #2418
- Identify Apple M1 GPU as integrated by @superdump in #2429
- 🛠 Fix M1 in macOS incorrectly reports supported compressed texture formats by @superdump in #2453
- 👍 Msl: support unsized array not in structures by @kvark in #2459
- 🛠 Fix Surface::from_uiview can not guarantee set correct contentScaleFactor by @jinleili in #2470
- Set max_buffer_size by the correct physical device restriction by @jinleili in #2502
- 🔨 Refactor PrivateCapabilities creation by @jinleili in #2509
- Refactor texture_format_capabilities function by @jinleili in #2522
- Improve push | pop_debug_marker by @jinleili in #2537
- 🛠 Fix some supported limits by @jinleili in #2608
- Don't skip incomplete binding resources. by @dragostis in #2622
- Fix Rgb9e5Ufloat capabilities and sampler_lod_average support by @jinleili in #2656
- 🛠 Fix Depth24Plus | Depth24PlusStencil8 capabilities by @jinleili in #2686
- 👌 Get_supported_formats: sort like the old get_preferred_format and simplify return type by @victorvde in #2786
- Restrict hal::TextureUses::COLOR_TARGET condition within create_texture by @jinleili in #2818
DX12
- 🛠 Fix UMA check by @kvark in #2305
- 🛠 Fix partial texture barrier not affecting stencil aspect by @Wumpf in #2308
- 👌 Improve RowPitch computation by @kvark in #2409
Vulkan
- Explicitly set Vulkan debug message types instead of !empty() by @victorvde in #2321
- 👉 Use stencil read/write masks by @kvark in #2382
- Vulkan: correctly set INDEPENDENT_BLEND，make runable on Android 8.x by @jinleili in #2498
- 🛠 Fix ASTC format mapping by @kvark in #2476
- 👌 Support flipped Y on VK 1.1 devices by @cwfitzgerald in #2512
- 🛠 Fixed builtin(primitive_index) for vulkan backend by @kwillemsen in #2716
- Fix PIPELINE_STATISTICS_QUERY feature support by @jinleili in #2750
- ➕ Add a vulkan workaround for large buffers. by @nical in #2796
GLES
- 🛠 Fix index buffer state not being reset in reset_state by @rparrett in #2391
- 👍 Allow push constants trough emulation by @JCapucho in #2400
- Hal/gles: fix dirty vertex buffers that are unused by @kvark in #2427
- 🛠 Fix texture description for bgra formats by @JCapucho in #2520
- ✂ Remove a log::error! debugging statement from the gles queue by @expenses in #2630
- 🛠 Fix clearing depth and stencil at the same time by @expenses in #2675
- 🖐 Handle cubemap copies by @expenses in #2725
- 👍 Allow clearing index buffers by @grovesNL in #2740
- 🛠 Fix buffer-texture copy for 2d arrays by @tuchs in #2809
Wayland
- Search for different versions of libwayland by @sh7dm in #2336
WebGPU
- 🛠 Fix compilation on wasm32-unknown-unknown without webgl feature by @jakobhellermann in #2355
- Solve crash on WebGPU by @cwfitzgerald in #2807
Emscripten
- 🛠 Fix emscripten by @cwfitzgerald in #2494
🐎 Performance
- Do texture init via clear passes when possible by @Wumpf in #2307
- Bind group deduplication by @cwfitzgerald in #2623
- Tracking Optimization and Rewrite by @cwfitzgerald in #2662
📚 Documentation
- ➕ Add defaults to new limits and correct older ones by @MultisampledNight in #/2303
- 👌 Improve shader source documentation by @grovesNL in #2315
- 🛠 Fix typo by @rustui in #2393
- ➕ Add a :star: to the feature matrix of examples README by @yutannihilation in #2457
- Fix get_timestamp_period type in docs by @superdump in #2478
- 🛠 Fix mistake in Access doc comment by @nical in #2479
- 👌 Improve shader support documentation by @cwfitzgerald in #2501
- Document the gfx_select! macro. by @jimblandy in #2555
- ➕ Add Windows 11 to section about DX12 by @HeavyRain266 in #2552
- Document some aspects of resource tracking. by @jimblandy in #2558
- 📚 Documentation for various things. by @jimblandy in #2566
- 🛠 Fix doc links. by @jimblandy in #2579
- 🛠 Fixed misspelling in documentation by @zenitopires in #2634
- ⚡️ Update push constant docs to reflect the API by @Noxime in #2637
- 📚 Exclude dependencies from documentation by @yutannihilation in #2642
- Document GpuFuture. by @jimblandy in #2644
- Document random bits and pieces. by @jimblandy in #2651
- ➕ Add cross-references to each wgpu type's documentation. by @kpreid in #2653
- RenderPassDescriptor: make label lifetime match doc, and make names descriptive. by @kpreid in #2654
- Document VertexStepMode. by @jimblandy in #2685
- ➕ Add links for SpirV documents. by @huandzh in #2697
- ➕ Add symlink LICENSE files into crates. by @dskkato in #2604
- 🛠 Fix documentation links. by @jimblandy in #2756
- 👌 Improve push constant documentation, including internal docs. by @jimblandy in #2764
- Clarify docs for wgpu_core's Id and gfx_select!. by @jimblandy in #2766
- ⚡️ Update the Supported Platforms table in README by @jinleili in #2770
- ✂ Remove depth image from readme - we don't dictate direction of depth by @cwfitzgerald in #2812
⚡️ Dependency Updates
- ⚡️ Update ash to 0.37 by @a1phyr in #2557
- ⚡️ Update parking_lot to 0.12. by @emilio in #2639
- 🏁 Accept both parking-lot 0.11 and 0.12, to avoid windows-rs. by @jimblandy in #2660
- ⚡️ Update web-sys to 0.3.58, sparse attachments support by @jinleili in #2813
- ✂ Remove use of inplace_it by @mockersf in #2889
deno-webgpu
- Clean up features in deno by @crowlKats in #2445
- Dont panic when submitting same commandbuffer multiple times by @crowlKats in #2449
- 🖐 Handle error sources to display full errors by @crowlKats in #2454
- Pull changes from deno repo by @crowlKats in #2455
- 🛠 Fix cts_runner by @crowlKats in #2456
- ⚡️ Update deno_webgpu by @crowlKats in #2539
- Custom op arity by @crowlKats in #2542
Examples
- 🛠 Fix conserative-raster low res target getting zero sized on resize by @Wumpf in #2318
- Replace run-wasm-example.sh with aliased rust crate (xtask) by @rukai in #2346
- Get cargo-run-wasm from crates.io by @rukai in #2415
- 🛠 Fix msaa-line example's unnecessary MSAA data store by @jinleili in #2421
- 👉 Make shadow example runnable on iOS Android devices by @jinleili in #2433
- Blit should only draw one triangle by @CurryPseudo in #2474
- 🛠 Fix wasm examples failing to compile by @Liamolucko in #2524
- 🛠 Fix incorrect filtering used in mipmap generation by @LaylBongers in #2525
- Correct program output ("Steps", not "Times") by @skierpage in #2535
- 🛠 Fix resizing behaviour of hello-triangle example by @FrankenApps in #2543
- Switch from cgmath to glam in examples by @a1phyr in #2544
- Generate 1x1 mip level by @davidar in #2551
- Wgpu/examples/shadow: Don't run on llvmpipe. by @jimblandy in #2595
- Avoid new WGSL reserved words in wgpu examples. by @jimblandy in #2606
- 🚚 Move texture-array example over to wgsl by @cwfitzgerald in #2618
- ✂ Remove the default features from wgpu-info by @jinleili in #2753
- 🛠 Fix bunnymark test screenshot and replace rand with nanorand by @stevenhuyn in #2746
- 👉 Use FIFO swapchain in examples by @cwfitzgerald in #2790
✅ Testing/Internal
- ✅ Test WebGPU backend with extra features by @kvark in #2362
- 👕 Lint deno_webgpu & wgpu-core by @AaronO in #2403
- IdentityManager: from_index method is unneeded. by @jimblandy in #2424
- ➕ Added id32 feature by @caiiiycuk in #2464
- ⚡️ Update dev deps by @rukai in #2493
- ✅ Use cargo nextest for running our tests by @cwfitzgerald in #2495
- ✅ Many Steps Towards GL Testing Working by @cwfitzgerald in #2504
- 📇 Rename ci.txt to ci.yml by @simon446 in #2510
- 👷 Re-enable GL testing in CI by @cwfitzgerald in #2508
- Expect shadow example to pass on GL by @kvark in #2541
- Simplify implementation of RefCount and MultiRefCount. by @jimblandy in #2548
- Provide a proper new method for RefCount. by @jimblandy in #2570
- ➕ Add logging to LifetimeTracker::triage_suspected. by @jimblandy in #2569
- ↪ wgpu-hal: Work around cbindgen bug: ignore gles::egl module. by @jimblandy in #2576
- Specify an exact wasm-bindgen-cli version in publish.yml. by @jimblandy in #2624
- ⏱ Rename timeout_us to timeout_ns, to match actual units. by @jimblandy in #2645
- Move set_index_buffer FFI functions back into wgpu. by @jimblandy in #2661
- New function: Global::create_buffer_error. by @jimblandy in #2673
- Actually use RenderBundleEncoder::set_bind_group in tests. by @jimblandy in #2678
- Eliminate wgpu_core::commands::bundle::State::raw_dynamic_offsets. by @jimblandy in #2684
- 🚚 Move RenderBundleEncoder::finish's pipeline layout id into the state. by @jimblandy in #2755
- Expect shader_primitive_index tests to fail on AMD RADV POLARIS12. by @jimblandy in #2754
- Introduce VertexStep: a stride and a step mode. by @jimblandy in #2768
- ✅ Increase max_outliers on wgpu water example reftest. by @jimblandy in #2767
- wgpu_core::command::bundle: Consolidate pipeline and vertex state. by @jimblandy in #2769
- ➕ Add type annotation to render pass code, for rust-analyzer. by @jimblandy in #2773
- 🔦 Expose naga span location helpers by @nical in #2752
- Add create_texture_error by @nical in #2800

wgpu v0.13

Version Release Notes from June 30, 2022 (almost 2 years ago)

« Changelog History

wgpu v0.13 Release Notes

Major Changes

WGSL Syntax

Surface API

Timestamp Queries

map_async

Submission Indexes

Other Breaking Changes

➕ Added/New Features

General

Vulkan

Metal

GLES

DX12

DX11

Hal

Emscripten

🔄 Changes

General

Gles

Metal

Hal

🐛 Bug Fixes

General

Metal

DX12

Vulkan

GLES

Wayland

WebGPU

Emscripten

🐎 Performance

📚 Documentation

⚡️ Dependency Updates

deno-webgpu

Examples

✅ Testing/Internal