All Versions
48
Latest Version
Avg Release Cycle
24 days
Latest Release
704 days ago

Changelog History
Page 1

  • v0.14.0 Changes

    October 05, 2022

    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
    • โž• Add way to create gles hal textures from raw gl names to allow externally managed textures. By @i509VCB #3046
    • 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]](https://github.com/gfx-rs/wgpu/pull/2971)
    • โšก๏ธ Update to Naga b209d911 (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
    • Report vendor id for Mesa and Apple GPUs. By @i509VCB #3036
    • Report Apple M2 gpu as integrated. By @i509VCB #3036
    WebGPU
    • ๐Ÿ‘ท When called in a web worker, Context::init() now uses web_sys::WorkerGlobalContext to create a wgpu::Instance instead of trying to access the unavailable web_sys::Window by @JolifantoBambla in #2858

    ๐Ÿ”„ 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
    • โšก๏ธ Updated the maximum binding index to match the WebGPU specification by @nical in #2957
    Metal
    • Extract the generic code into get_metal_layer by @jinleili in #2826
    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
    • ๐Ÿšš DropGuard has been moved to the root of the wgpu-hal crate. By @i509VCB #3046
    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::get_supported_alpha_modes(&self, adapter: &wgpu::Adapter) -> Vec<CompositeAlphaMode>
    +pub fn wgpu::Surface::get_supported_present_modes(&self, adapter: &wgpu::Adapter) -> Vec<PresentMode>
    +#[repr(C)] pub enum wgpu::CompositeAlphaMode
    +impl RefUnwindSafe for wgpu::CompositeAlphaMode
    +impl Send for wgpu::CompositeAlphaMode
    +impl Sync for wgpu::CompositeAlphaMode
    +impl Unpin for wgpu::CompositeAlphaMode
    +impl UnwindSafe for wgpu::CompositeAlphaMode
    +pub const wgpu::Features::DEPTH24PLUS_STENCIL8: Self
    +pub const wgpu::TextureFormatFeatureFlags::BLENDABLE: Self
    +pub enum variant wgpu::CompositeAlphaMode::Auto = 0
    +pub enum variant wgpu::CompositeAlphaMode::Inherit = 4
    +pub enum variant wgpu::CompositeAlphaMode::Opaque = 1
    +pub enum variant wgpu::CompositeAlphaMode::PostMultiplied = 3
    +pub enum variant wgpu::CompositeAlphaMode::PreMultiplied = 2
    +pub enum variant wgpu::TextureFormat::Depth16Unorm
    +pub fn wgpu::CompositeAlphaMode::clone(&self) -> wgpu::CompositeAlphaMode
    +pub fn wgpu::CompositeAlphaMode::eq(&self, other: &wgpu::CompositeAlphaMode) -> bool
    +pub fn wgpu::CompositeAlphaMode::fmt(&self, f: &mut $crate::fmt::Formatter<'_>) -> $crate::fmt::Result
    +pub fn wgpu::CompositeAlphaMode::hash<__H: $crate::hash::Hasher>(&self, state: &mut __H) -> ()
    +pub struct field wgpu::AdapterInfo::driver: String
    +pub struct field wgpu::AdapterInfo::driver_info: String
    +pub struct field wgpu::SurfaceConfiguration::alpha_mode: wgpu_types::CompositeAlphaMode
    
  • v0.13.2 Changes

    July 13, 2022

    ๐Ÿ› 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
    • ๐Ÿ›  Fix out-of-bound write in map_buffer with non-zero offset by @nical in #2916
    • Validate the number of color attachments in create_render_pipeline by @nical in #2913
    • Validate against the maximum binding index in create_bind_group_layout by @nical in #2892
    • Validate that map_async's range is not negative by @nical in #2938
    • Fix calculation/validation of layer/mip ranges in create_texture_view by @nical in #2955
    • Validate the sample count and mip level in copy_texture_to_buffer by @nical in #2958
    • ๐Ÿ”ฆ Expose the cause of the error in the map_async callback in #2939
    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
    Vulkan
    • Vulkan 1.0 drivers that support VK_KHR_multiview now properly report the MULTIVIEW feature as supported by @i509VCB in #2934.
    • Stop using VkPhysicalDevice11Features in Vulkan 1.1 which is confusingly provided in Vulkan 1.2 by @i509VCB in #2934.
    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
    • ๐Ÿ‘‰ Make AdapterContext a publicly accessible type in the gles hal by @i509VCB in #2870
  • v0.13.1 Changes

    July 02, 2022

    ๐Ÿ› Bug Fixes

    General
    • ๐Ÿ›  Fix out of bounds access when surface texture is written to by multiple command buffers by @cwfitzgerald in #2843
    GLES
    • AutoNoVSync now correctly falls back to Fifo by @simbleau in #2842
    • Fix GL_EXT_color_buffer_float detection on native by @cwfitzgerald in #2843
  • v0.13 Changes

    June 30, 2022

    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
  • v0.12.4 Changes

    January 24, 2022
    • Metal:
      • check for MSL-2.3
  • v0.12.3 Changes

    January 20, 2022
    • Metal:
      • preserve vertex invariance
    • Vulkan
      • fix stencil read/write masks
    • Gles:
      • reset index binding properly
    • DX12:
      • fix copies into 1D textures
  • v0.12.2 Changes

    January 10, 2022
    • ๐Ÿ›  fix tracy compile error
    • ๐Ÿ›  fix buffer binding limits beyond 2Gb
    • ๐Ÿ›  fix zero initialization of 3D textures
    • Metal:
      • fix surface texture views
    • Gles:
      • extend libwayland search paths
  • v0.12.1 Changes

    December 29, 2021
    • zero initialization uses now render target clears when possible (faster and doesn't enforce COPY_DST internally if not necessary)
      • fix use of MSAA targets in WebGL
      • fix not providing COPY_DST flag for textures causing assertions in some cases
      • fix surface textures not getting zero initialized
      • clear_texture supports now depth/stencil targets
    • error message on creating depth/stencil volume texture
    • Vulkan:
      • fix validation error on debug message types
    • DX12:
      • fix check for integrated GPUs
      • fix stencil subresource transitions
    • Metal:
      • implement push constants
  • v0.12 Changes

    December 18, 2021
    • API:
      • MULTIVIEW feature
      • DEPTH_CLIP_CONTROL feature to replace the old DEPTH_CLAMP
      • TEXTURE_FORMAT_16BIT_NORM feature
      • push/pop error scopes on the device
      • more limits for compute shaders
      • SamplerBindingType instead of booleans
      • sampler arrays are supported by TEXTURE_BINDING_ARRAY feature
      • "glsl" cargo feature for accepting GLSL shader code
      • enforced MSRV-1.53
    • correctness:
      • textures are zero-initialized
      • lots and lots of fixes
    • validation:
      • match texture-sampler pairs
      • check min_binding_size late at draw
      • check formats to match in copy_texture_to_texture
      • allow strip_index_format to be none if unused
      • check workgroup sizes and counts
    • shaders:
  • v0.11.3 Changes

    December 01, 2021
    • Core:
      • validate device descriptor before actually creating it
      • fix validation of texture-sampler pairs
    • Vulkan:
      • fix running on Vulkan-1.1 instance
      • improve detection of workaround for Intel+Nvidia on Linux
      • fix resource limits on Vulkan-1.2
      • fix the check for storage buffer requirement
      • change internal semaphore logic to work around Linux+Intel bugs
      • fix enabling extension-provided features
    • GLES:
      • fix running on old and bogus drivers
      • fix stale samplers on bindings change
      • fix integer textures
      • fix querying work group parameters
      • fix stale PBO bindings caused by resource copies
      • fix rendering to cubemap faces
      • fix Rgba16Float format
      • fix stale vertex attributes when changing the pipeline
    • Metal:
      • fix window resizing for running in multiple processes
    • Web:
      • fix set_index_buffer and set_vertex_buffer to have optional sizes