Releases: gfx-rs/wgpu
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
overDeviceType::Other
forPowerPreference::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 theANISOTROPIC_FILTERING
flag set to true so DX12 listsANISOTROPIC_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
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
- 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.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 CommandEncoder
s.
Features::WRITE_TIMESTAMP_INSIDE_PASSES
is needed to call write_timestamp
on RenderPassEncoder
s or ComputePassEncoder
s.
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
- 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
- Dx11 Backend 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](https://github.com/gfx-rs/wgpu/pull/...