Skip to content

Releases: gfx-rs/wgpu

v0.14.2

30 Nov 23:03
@cwfitzgerald cwfitzgerald
v0.14.2
628a25e
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.14.2

This release includes wgpu, and wgpu-core. The crates wgpu-hal and wgpu-types are still at 0.14.1.

Bug Fixes

  • Fix incorrect offset in get_mapped_range by @nical in #3233

Contributors

nical
Assets 2

v0.14.1

02 Nov 21:43
@cwfitzgerald cwfitzgerald
v0.14.1
77b9a99
This commit was signed with the committer’s verified signature.
cwfitzgerald Connor Fitzgerald
GPG key ID: 7D3FA445BAD3008D
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.14.1

This release includes wgpu-hal, and wgpu-types. The crates wgpu and wgpu-core are still at 0.14.0.

Bug Fixes

  • Make wgpu::TextureFormat::Depth24PlusStencil8 available on all backends by making the feature unconditionally available and the feature unneeded to use the format. By @Healthire and @cwfitzgerald in #3165

Contributors

HexyWitch and cwfitzgerald
Assets 2

v0.14.0

05 Oct 23:12
@cwfitzgerald cwfitzgerald
v0.14.0
261069d
Compare
Choose a tag to compare
v0.14.0

Major Changes

@invariant Warning

When using CompareFunction::Equal or CompareFunction::NotEqual on a pipeline, there is now a warning logged if the vertex
shader does not have a @invariant tag on it. On some machines, rendering the same triangles multiple times without an
@invariant tag will result in slightly different depths for every pixel. Because the *Equal functions rely on depth being
the same every time it is rendered, we now warn if it is missing.

-@vertex
-fn vert_main(v_in: VertexInput) -> @builtin(position) vec4<f32> {...}
+@vertex
+fn vert_main(v_in: VertexInput) -> @builtin(position) @invariant vec4<f32> {...}

Surface Alpha and PresentModes

Surface supports alpha_mode now. When alpha_mode is equal to PreMultiplied or PostMultiplied,
the alpha channel of framebuffer is respected in the compositing process, but which mode is available depends on
the different API and Device. If don't care about alpha_mode, you can set it to Auto.

SurfaceConfiguration {
// ...
+ alpha_mode: surface.get_supported_alpha_modes(&adapter)[0],
}

The function to enumerate supported presentation modes changed:

- pub fn wgpu::Surface::get_supported_modes(&self, adapter: &wgpu::Adapter) -> Vec<PresentMode>
+ pub fn wgpu::Surface::get_supported_present_modes(&self, adapter: &wgpu::Adapter) -> Vec<PresentMode>

Updated raw-window-handle to 0.5

This will allow use of the latest version of winit. As such the bound on create_surface is now RWH 0.5 and requires
both raw_window_handle::HasRawWindowHandle and raw_window_handle::HasRawDisplayHandle.

Added/New Features

  • Add Buffer::size() and Buffer::usage(); by @kpreid in #2923
  • Split Blendability and Filterability into Two Different TextureFormatFeatureFlags; by @stakka in #3012
  • Expose alpha_mode on SurfaceConfiguration, by @jinleili in #2836
  • Introduce fields for driver name and info in AdapterInfo, by @i509VCB in #3037
  • Implemented copy_external_image_to_texture on WebGPU, by @ybiletskyi in #2781

Bug Fixes

General

  • Free StagingBuffers even when an error occurs in the operation that consumes them. By @jimblandy in #2961
  • Avoid overflow when checking that texture copies fall within bounds. By @jimblandy in #2963
  • Improve the validation and error reporting of buffer mappings by @nical in #2848
  • Fix compilation errors when using wgpu-core in isolation while targetting wasm32-unknown-unknown by @Seamooo in #2922
  • Fixed opening of RenderDoc library by @ABuffSeagull in #2930
  • Added missing validation for BufferUsages mismatches when Features::MAPPABLE_PRIMARY_BUFFERS is not
    enabled. By @Imberflur in #3023
  • Fixed CommandEncoder not being Send and Sync on web by @i509VCB in #3025
  • Document meaning of vendor in AdapterInfo if the vendor has no PCI id.
  • Fix missing resource labels from some Errors by @scoopr in #3066

Metal

  • Add the missing msg_send![view, retain] call within from_view by @jinleili in #2976
  • Fix max_buffer max_texture and max_vertex_buffers limits by @jinleili in #2978
  • Remove PrivateCapabilities's format_rgb10a2_unorm_surface field by @jinleili in #2981
  • Fix validation error when copying into a subset of a single-layer texture by @nical in #3063
  • Fix _buffer_sizes encoding by @dtiselice in #3047

Vulkan

  • Fix astc_hdr formats support by @jinleili in [#2971]](#2971)
  • Update to Naga b209d91 (2022-9-1) to avoid generating SPIR-V that
    violates Vulkan valid usage rules VUID-StandaloneSpirv-Flat-06202
    and VUID-StandaloneSpirv-Flat-04744. By @jimblandy in
    #3008
  • Fix bug where the Vulkan backend would panic when using a supported window and display handle but the
    dependent extensions are not available by @i509VCB in #3054.

GLES

Changes

General

  • Changed wgpu-hal and wgpu-core implementation to pass RawDisplayHandle and RawWindowHandle as separate
    parameters instead of passing an impl trait over both HasRawDisplayHandle and HasRawWindowHandle. By @i509VCB in #3022
  • Changed Instance::as_hal<A> to just return an Option<&A::Instance> rather than taking a callback. By @jimb in #2991
  • Added downlevel restriction error message for InvalidFormatUsages error by @Seamooo in #2886
  • Add warning when using CompareFunction::*Equal with vertex shader that is missing @invariant tag by @cwfitzgerald in #2887
  • Update Winit to version 0.27 and raw-window-handle to 0.5 by @wyatt-herkamp in #2918
  • Address Clippy 0.1.63 complaints. By @jimblandy in #2977
  • Don't use PhantomData for IdentityManager's Input type. By @jimblandy in #2972
  • Changed Naga variant in ShaderSource to Cow<'static, Module>, to allow loading global variables by @daxpedda in #2903

Metal

Vulkan

  • Remove use of Vulkan12Features/Properties types. By @i509VCB in #2936
  • Provide a means for wgpu users to access vk::Queue and the queue index. By @anlumo in #2950
  • Use the use effective api version for determining device features instead of wrongly assuming VkPhysicalDeviceProperties.apiVersion
    is the actual version of the device. By @i509VCB in #3011

GLES

  • Add Rgba16Float format support for color attachments. By @jinleili in #3045
  • TEXTURE_COMPRESSION_ASTC_HDR feature detection by @jinleili in #3042

Performance

  • Made StagingBelt::write_buffer() check more thoroughly for reusable memory; by @kpreid in #2906

Documentation

  • Add WGSL examples to complement existing examples written in GLSL by @norepimorphism in #2888
  • Document wgpu_core resource allocation. @jimblandy in #2973
  • Expanded StagingBelt documentation by @kpreid in #2905
  • Fixed documentation for Instance::create_surface_from_canvas and
    Instance::create_surface_from_offscreen_canvas regarding their
    safety contract. These functions are not unsafe. By @jimblandy #2990
  • Document that write_buffer_with() is sound but unwise to read from by @kpreid in #3006
  • Explain why Adapter::as_hal and Device::as_hal have to take callback functions. By @jimblandy in #2992

Dependency Updates

WebGPU

  • Update wasm32 dependencies, set alpha_mode on web target by @jinleili in #3040

Build Configuration

  • Add the "strict_asserts" feature, to enable additional internal
    run-time validation in wgpu-core. By @jimblandy in
    #2872.

Full API Diff

Manual concatination of cargo public-api --diff-git-checkouts v0.13.2 v0.14.0 -p wgpu and cargo public-api --diff-git-checkouts v0.13.2 v0.14.0 -p wgpu-types

Removed items from the public API
=================================
-pub fn wgpu::Surface::get_supported_modes(&self, adapter: &wgpu::Adapter) -> Vec<PresentMode>
-pub const wgpu::Features::DEPTH24UNORM_STENCIL8: Self
-pub enum variant wgpu::TextureFormat::Depth24UnormStencil8

Changed items in the public API
===============================
-pub unsafe fn wgpu::Instance::as_hal<A: wgc::hub::HalApi, F: FnOnce(Option<&<A as >::Instance>) -> R, R>(&self, hal_instance_callback: F) -> R
+pub unsafe fn wgpu::Instance::as_hal<A: wgc::hub::HalApi>(&self) -> Option<&<A as >::Instance>
-pub unsafe fn wgpu::Instance::create_surface<W: raw_window_handle::HasRawWindowHandle>(&self, window: &W) -> wgpu::Surface
+pub unsafe fn wgpu::Instance::create_surface<W: raw_window_handle::HasRawWindowHandle + raw_window_handle::HasRawDisplayHandle>(&self, window: &W) -> wgpu::Surface

Added items to the public API
=============================
+pub fn wgpu::Buffer::size(&self) -> wgt::BufferAddress
+pub fn wgpu::Buffer::usage(&self) -> BufferUsages
+pub fn wgpu::Surface:...
Read more

Contributors

scoopr, pilotmoon, and 15 other contributors
Assets 2

v0.13.2

14 Jul 02:30
@cwfitzgerald cwfitzgerald
v0.13.2
9f82504
Compare
Choose a tag to compare
v0.13.2

This release includes wgpu-core, wgpu-hal, and wgpu-types. The crate wgpu is still at 0.13.1.

Bug Fixes

General

  • Prefer DeviceType::DiscreteGpu over DeviceType::Other for PowerPreference::LowPower so Vulkan is preferred over OpenGL again by @Craig-Macomber in #2853
  • Allow running get_texture_format_features on unsupported texture formats (returning no flags) by @cwfitzgerald in #2856
  • Allow multi-sampled textures that are supported by the device but not WebGPU if TEXTURE_ADAPTER_SPECIFIC_FORMAT_FEATURES is enabled by @cwfitzgerald in #2856
  • get_texture_format_features only lists the COPY_* usages if the adapter actually supports that usage by @cwfitzgerald in #2856
  • Fix bind group / pipeline deduplication not taking into account RenderBundle execution resetting these values by @shoebe #2867
  • Fix panics that occur when using as_hal functions when the hal generic type does not match the hub being looked up in by @i509VCB #2871
  • Add some validation in map_async by @nical in #2876
  • Fix bugs when mapping/unmapping zero-sized buffers and ranges by @nical in #2877

DX12

  • DownlevelCapabilities::default() now returns the ANISOTROPIC_FILTERING flag set to true so DX12 lists ANISOTROPIC_FILTERING as true again by @cwfitzgerald in #2851
  • Properly query format features for UAV/SRV usages of depth formats by @cwfitzgerald in #2856

GLES

  • Fix depth stencil texture format capability by @jinleili in #2854
  • get_texture_format_features now only returns usages for formats it actually supports by @cwfitzgerald in #2856

Hal

  • Allow access to queue family index in Vulkan hal by @i509VCB in #2859
  • Allow access to the EGLDisplay and EGLContext pointer in Gles hal Adapter and Device by @i509VCB in #2860

Documentation

  • Update present_mode docs as most of them don't automatically fall back to Fifo anymore. by @Elabajaba in #2855

Hal

  • Document safety requirements for Adapter::from_external in gles hal by @i509VCB in #2863

Contributors

Elabajaba, Craig-Macomber, and 5 other contributors
Assets 2

v0.13.1

03 Jul 06:05
@cwfitzgerald cwfitzgerald
v0.13.1
076df1a
Compare
Choose a tag to compare
v0.13.1

This release includes wgpu, wgpu-core, and wgpu-hal. The crate wgpu-types is still at 0.13.0.

General

  • Fix out of bounds access when surface texture is written to by multiple command buffers by @cwfitzgerald in #2843

GLES

Contributors

cwfitzgerald and simbleau
Assets 2

v0.13.0

01 Jul 16:51
@cwfitzgerald cwfitzgerald
v0.13.0
e125321
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.13.0

This release includes wgpu, wgpu-core, wgpu-hal, and wgpu-types.

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
}

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

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

GLES

DX12

DX11

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

Changes

General

Read more

Contributors

scoopr, davidar, and 54 other contributors
Assets 2