From feab2f79ef3776448ea4ddd23c03b6ed7c4e49ec Mon Sep 17 00:00:00 2001 From: Sam <16504129+sagudev@users.noreply.github.com> Date: Wed, 19 Aug 2026 12:06:10 +0200 Subject: [PATCH] Add `DeviceDescriptor::default_queue: QueueDescriptor` to support setting label to queue (#10109) Signed-off-by: sagudev <16504129+sagudev@users.noreply.github.com> --- CHANGELOG.md | 18 +++++++++++ benches/benches/wgpu-benchmark/main.rs | 1 + deno_webgpu/adapter.rs | 12 ++++++++ .../features/src/cooperative_matrix/mod.rs | 3 ++ examples/features/src/error_scope/mod.rs | 1 + examples/features/src/framework.rs | 1 + .../features/src/hello_synchronization/mod.rs | 1 + examples/features/src/hello_triangle/mod.rs | 1 + examples/features/src/hello_windows/mod.rs | 1 + examples/features/src/hello_workgroups/mod.rs | 1 + .../features/src/render_to_texture/mod.rs | 1 + examples/features/src/repeated_compute/mod.rs | 1 + examples/features/src/storage_texture/mod.rs | 1 + .../features/src/timestamp_queries/mod.rs | 1 + examples/features/src/uniform_values/mod.rs | 1 + .../standalone/01_hello_compute/src/main.rs | 1 + player/tests/player/main.rs | 1 + tests/src/init.rs | 1 + wgpu-core/src/device/mod.rs | 1 + wgpu-core/src/device/queue.rs | 18 +++++------ wgpu-core/src/instance.rs | 9 +++++- wgpu-types/src/device.rs | 30 +++++++++++++++++-- wgpu/src/api/device.rs | 9 ++++++ wgpu/src/backend/webgpu.rs | 6 ++++ 24 files changed, 108 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 404a44895..1966ff209 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -42,6 +42,24 @@ Bottom level categories: ## Unreleased +### Major changes + +#### `DeviceDescriptor` has new field `default_queue` + +`DeviceDescriptor` has new field `default_queue` of type `QueueDescriptor`, which allows setting label for default device queue: + +```diff + wgpu::DeviceDescriptor { + label: None + required_features: adapter.features(), + required_limits: adapter.limits(), ++ default_queue: wgpu::QueueDescriptor { label: None }, + // ... + } +``` + +By @sagudev in [#10109](https://github.com/gfx-rs/wgpu/pull/10109). + ### Added/New Features #### General diff --git a/benches/benches/wgpu-benchmark/main.rs b/benches/benches/wgpu-benchmark/main.rs index 4140e3c2d..426678954 100644 --- a/benches/benches/wgpu-benchmark/main.rs +++ b/benches/benches/wgpu-benchmark/main.rs @@ -47,6 +47,7 @@ impl DeviceState { let (device, queue) = block_on(adapter.request_device(&wgpu::DeviceDescriptor { required_features: adapter.features(), required_limits: adapter.limits(), + default_queue: wgpu::QueueDescriptor { label: None }, memory_hints: wgpu::MemoryHints::Performance, experimental_features: unsafe { wgpu::ExperimentalFeatures::enabled() }, label: None, diff --git a/deno_webgpu/adapter.rs b/deno_webgpu/adapter.rs index 71257b548..4f8bb4f47 100644 --- a/deno_webgpu/adapter.rs +++ b/deno_webgpu/adapter.rs @@ -35,6 +35,13 @@ pub(crate) enum GPUPowerPreference { HighPerformance, } +#[derive(WebIDL)] +#[webidl(dictionary)] +struct GPUQueueDescriptor { + #[webidl(default = String::new())] + label: String, +} + #[derive(WebIDL)] #[webidl(dictionary)] struct GPUDeviceDescriptor { @@ -46,6 +53,8 @@ struct GPUDeviceDescriptor { #[webidl(default = Default::default())] #[options(enforce_range = true)] required_limits: indexmap::IndexMap>, + #[webidl(default = GPUQueueDescriptor { label: String::new() })] + default_queue: GPUQueueDescriptor, } pub struct GPUAdapter { @@ -149,6 +158,9 @@ impl GPUAdapter { label: crate::transform_label(descriptor.label.clone()), required_features, required_limits, + default_queue: wgpu_types::QueueDescriptor { + label: crate::transform_label(descriptor.default_queue.label), + }, experimental_features: wgpu_types::ExperimentalFeatures::disabled(), memory_hints: Default::default(), trace, diff --git a/examples/features/src/cooperative_matrix/mod.rs b/examples/features/src/cooperative_matrix/mod.rs index 18793a9ae..7d3a9fdc8 100644 --- a/examples/features/src/cooperative_matrix/mod.rs +++ b/examples/features/src/cooperative_matrix/mod.rs @@ -155,6 +155,9 @@ async fn run() { label: Some("Cooperative Matrix Device"), required_features, required_limits: wgpu::Limits::downlevel_defaults(), + default_queue: wgpu::QueueDescriptor { + label: Some("Cooperative Matrix Queue"), + }, experimental_features: wgpu::ExperimentalFeatures::enabled(), memory_hints: wgpu::MemoryHints::Performance, trace: wgpu::Trace::Off, diff --git a/examples/features/src/error_scope/mod.rs b/examples/features/src/error_scope/mod.rs index 1c55dcb2d..46675c175 100644 --- a/examples/features/src/error_scope/mod.rs +++ b/examples/features/src/error_scope/mod.rs @@ -56,6 +56,7 @@ async fn run() { label: None, required_features: wgpu::Features::empty(), required_limits: wgpu::Limits::downlevel_webgl2_defaults(), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::MemoryUsage, trace: wgpu::Trace::Off, diff --git a/examples/features/src/framework.rs b/examples/features/src/framework.rs index 967646fee..a181f8a0d 100644 --- a/examples/features/src/framework.rs +++ b/examples/features/src/framework.rs @@ -290,6 +290,7 @@ impl ExampleContext { required_features: (E::optional_features() & adapter.features()) | E::required_features(), required_limits: needed_limits, + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: unsafe { wgpu::ExperimentalFeatures::enabled() }, memory_hints: wgpu::MemoryHints::MemoryUsage, trace: match std::env::var_os("WGPU_TRACE") { diff --git a/examples/features/src/hello_synchronization/mod.rs b/examples/features/src/hello_synchronization/mod.rs index 140da957b..260d95cda 100644 --- a/examples/features/src/hello_synchronization/mod.rs +++ b/examples/features/src/hello_synchronization/mod.rs @@ -16,6 +16,7 @@ async fn run() { label: None, required_features: wgpu::Features::empty(), required_limits: wgpu::Limits::downlevel_defaults(), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::Performance, trace: wgpu::Trace::Off, diff --git a/examples/features/src/hello_triangle/mod.rs b/examples/features/src/hello_triangle/mod.rs index 53c207303..62cf17220 100644 --- a/examples/features/src/hello_triangle/mod.rs +++ b/examples/features/src/hello_triangle/mod.rs @@ -144,6 +144,7 @@ impl ApplicationHandler for App { // so we can support images the size of the swapchain. required_limits: wgpu::Limits::downlevel_webgl2_defaults() .using_resolution(adapter.limits()), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::MemoryUsage, trace: wgpu::Trace::Off, diff --git a/examples/features/src/hello_windows/mod.rs b/examples/features/src/hello_windows/mod.rs index 9d8c5f4cf..585e52bdd 100644 --- a/examples/features/src/hello_windows/mod.rs +++ b/examples/features/src/hello_windows/mod.rs @@ -147,6 +147,7 @@ impl ApplicationHandler for App { label: None, required_features: wgpu::Features::empty(), required_limits: wgpu::Limits::downlevel_defaults(), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::MemoryUsage, trace: wgpu::Trace::Off, diff --git a/examples/features/src/hello_workgroups/mod.rs b/examples/features/src/hello_workgroups/mod.rs index d8a05078c..c5d6e9866 100644 --- a/examples/features/src/hello_workgroups/mod.rs +++ b/examples/features/src/hello_workgroups/mod.rs @@ -31,6 +31,7 @@ async fn run() { label: None, required_features: wgpu::Features::empty(), required_limits: wgpu::Limits::downlevel_defaults(), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::MemoryUsage, trace: wgpu::Trace::Off, diff --git a/examples/features/src/render_to_texture/mod.rs b/examples/features/src/render_to_texture/mod.rs index ed60f05e1..cdd996c3e 100644 --- a/examples/features/src/render_to_texture/mod.rs +++ b/examples/features/src/render_to_texture/mod.rs @@ -20,6 +20,7 @@ async fn run(_path: Option) { label: None, required_features: wgpu::Features::empty(), required_limits: wgpu::Limits::downlevel_defaults(), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::MemoryUsage, trace: wgpu::Trace::Off, diff --git a/examples/features/src/repeated_compute/mod.rs b/examples/features/src/repeated_compute/mod.rs index 929e30cc8..4319336eb 100644 --- a/examples/features/src/repeated_compute/mod.rs +++ b/examples/features/src/repeated_compute/mod.rs @@ -168,6 +168,7 @@ impl WgpuContext { label: None, required_features: wgpu::Features::empty(), required_limits: wgpu::Limits::downlevel_defaults(), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::Performance, trace: wgpu::Trace::Off, diff --git a/examples/features/src/storage_texture/mod.rs b/examples/features/src/storage_texture/mod.rs index 67a8e2f52..33dab1b9e 100644 --- a/examples/features/src/storage_texture/mod.rs +++ b/examples/features/src/storage_texture/mod.rs @@ -34,6 +34,7 @@ async fn run(_path: Option) { label: None, required_features: wgpu::Features::empty(), required_limits: wgpu::Limits::downlevel_defaults(), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::MemoryUsage, trace: wgpu::Trace::Off, diff --git a/examples/features/src/timestamp_queries/mod.rs b/examples/features/src/timestamp_queries/mod.rs index ff0a51788..1c4ba306b 100644 --- a/examples/features/src/timestamp_queries/mod.rs +++ b/examples/features/src/timestamp_queries/mod.rs @@ -211,6 +211,7 @@ async fn run() { label: None, required_features: features, required_limits: wgpu::Limits::downlevel_defaults(), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::MemoryUsage, trace: wgpu::Trace::Off, diff --git a/examples/features/src/uniform_values/mod.rs b/examples/features/src/uniform_values/mod.rs index d9d5def4d..209672b5e 100644 --- a/examples/features/src/uniform_values/mod.rs +++ b/examples/features/src/uniform_values/mod.rs @@ -132,6 +132,7 @@ impl WgpuContext { label: None, required_features: wgpu::Features::empty(), required_limits: wgpu::Limits::downlevel_defaults(), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::MemoryUsage, trace: wgpu::Trace::Off, diff --git a/examples/standalone/01_hello_compute/src/main.rs b/examples/standalone/01_hello_compute/src/main.rs index b6559ae0f..b2f6efed9 100644 --- a/examples/standalone/01_hello_compute/src/main.rs +++ b/examples/standalone/01_hello_compute/src/main.rs @@ -70,6 +70,7 @@ fn main() { label: None, required_features: wgpu::Features::empty(), required_limits: wgpu::Limits::downlevel_defaults(), + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: wgpu::ExperimentalFeatures::disabled(), memory_hints: wgpu::MemoryHints::MemoryUsage, trace: wgpu::Trace::Off, diff --git a/player/tests/player/main.rs b/player/tests/player/main.rs index 109d3c0c1..38a200409 100644 --- a/player/tests/player/main.rs +++ b/player/tests/player/main.rs @@ -80,6 +80,7 @@ impl Test<'_> { label: None, required_features: self.features, required_limits: wgt::Limits::default(), + default_queue: wgt::QueueDescriptor { label: None }, experimental_features: unsafe { wgt::ExperimentalFeatures::enabled() }, memory_hints: wgt::MemoryHints::default(), trace: wgt::Trace::Off, diff --git a/tests/src/init.rs b/tests/src/init.rs index 2cba63db1..35870a8e9 100644 --- a/tests/src/init.rs +++ b/tests/src/init.rs @@ -202,6 +202,7 @@ pub async fn initialize_device( label: None, required_features: features, required_limits: limits, + default_queue: wgpu::QueueDescriptor { label: None }, experimental_features: unsafe { wgpu::ExperimentalFeatures::enabled() }, memory_hints: wgpu::MemoryHints::MemoryUsage, trace: wgpu::Trace::Off, diff --git a/wgpu-core/src/device/mod.rs b/wgpu-core/src/device/mod.rs index b5e4b9b36..aaa10e717 100644 --- a/wgpu-core/src/device/mod.rs +++ b/wgpu-core/src/device/mod.rs @@ -38,6 +38,7 @@ pub(crate) const ZERO_BUFFER_SIZE: BufferAddress = 512 << 10; pub(crate) const ENTRYPOINT_FAILURE_ERROR: &str = "The given EntryPoint is Invalid"; pub type DeviceDescriptor<'a> = wgt::DeviceDescriptor>; +pub type QueueDescriptor<'a> = wgt::QueueDescriptor>; #[repr(C)] #[derive(Clone, Copy, Debug, Eq, PartialEq)] diff --git a/wgpu-core/src/device/queue.rs b/wgpu-core/src/device/queue.rs index f7da650da..60a9c30e4 100644 --- a/wgpu-core/src/device/queue.rs +++ b/wgpu-core/src/device/queue.rs @@ -1,6 +1,6 @@ #[cfg(feature = "trace")] use alloc::string::ToString as _; -use alloc::{boxed::Box, sync::Arc, vec, vec::Vec}; +use alloc::{boxed::Box, string::String, sync::Arc, vec, vec::Vec}; use core::{ iter, mem::{self, ManuallyDrop}, @@ -26,7 +26,7 @@ use crate::{ CommandAllocator, CommandBuffer, CommandEncoder, CommandEncoderError, CopySide, TransferError, }, - device::{DeviceError, WaitIdleError}, + device::{DeviceError, QueueDescriptor, WaitIdleError}, get_lowest_common_denom, hal_label, init_tracker::{has_copy_partial_init_tracker_coverage, TextureInitRange}, lock::{rank, Mutex, MutexGuard, RwLock, RwLockWriteGuard}, @@ -42,7 +42,7 @@ use crate::{ scratch::ScratchBuffer, snatch::{SnatchGuard, Snatchable}, track::{self, Tracker, TrackerIndex}, - FastHashMap, SubmissionIndex, + FastHashMap, LabelHelpers, SubmissionIndex, }; use crate::{device::resource::CommandIndices, resource::RawResourceAccess}; @@ -50,6 +50,7 @@ pub struct Queue { raw: Box, pub(crate) pending_writes: Mutex, life_tracker: Mutex, + label: String, // The device needs to be dropped last (`Device.zero_buffer` might be referenced by the encoder in pending writes). pub(crate) device: Arc, } @@ -58,6 +59,7 @@ impl Queue { pub(crate) fn new( device: Arc, raw: Box, + desc: QueueDescriptor, instance_flags: wgt::InstanceFlags, ) -> Result { let pending_encoder = device @@ -103,6 +105,7 @@ impl Queue { Ok(Queue { raw, device, + label: desc.label.to_string(), pending_writes: Mutex::new(rank::QUEUE_PENDING_WRITES, pending_writes), life_tracker: Mutex::new(rank::QUEUE_LIFE_TRACKER, LifetimeTracker::new()), }) @@ -262,12 +265,7 @@ impl Queue { } crate::impl_resource_type!(Queue); -// TODO: https://github.com/gfx-rs/wgpu/issues/4014 -impl Labeled for Queue { - fn label(&self) -> &str { - "" - } -} +crate::impl_labeled!(Queue); crate::impl_parent_device!(Queue); crate::impl_storage_item!(Queue); @@ -1468,7 +1466,7 @@ impl Queue { &self, submit_index: SubmissionIndex, commands: Option>>, - error: alloc::string::String, + error: String, ) { if let Some(ref mut trace) = *self.device.trace.lock() { trace.add(Action::FailedCommands { diff --git a/wgpu-core/src/instance.rs b/wgpu-core/src/instance.rs index c7fcecc2a..5f85c1015 100644 --- a/wgpu-core/src/instance.rs +++ b/wgpu-core/src/instance.rs @@ -1187,10 +1187,17 @@ impl Adapter { profiling::scope!("Adapter::create_device_and_queue_from_hal"); api_log!("Adapter::create_device_and_queue_from_hal"); + let default_queue_desc = desc.default_queue.clone(); + let device = Device::new(hal_device.device, self, desc, self.instance.flags)?; let device = Arc::new(device); - let queue = Queue::new(device.clone(), hal_device.queue, self.instance.flags)?; + let queue = Queue::new( + device.clone(), + hal_device.queue, + default_queue_desc, + self.instance.flags, + )?; let queue = Arc::new(queue); device.set_queue(&queue); diff --git a/wgpu-types/src/device.rs b/wgpu-types/src/device.rs index 0550c6687..3df776357 100644 --- a/wgpu-types/src/device.rs +++ b/wgpu-types/src/device.rs @@ -7,6 +7,27 @@ use crate::ConstDefault; #[cfg(any(feature = "serde", test))] use serde::{Deserialize, Serialize}; +/// Describes a [`Queue`](../wgpu/struct.Queue.html). +/// +/// Corresponds to [WebGPU `GPUQueueDescriptor`]( +/// https://gpuweb.github.io/gpuweb/#gpuqueuedescriptor). +#[derive(Clone, Debug, Default)] +#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] +pub struct QueueDescriptor { + /// Debug label for the queue. + pub label: L, +} + +impl QueueDescriptor { + /// Takes a closure and maps the label of the queue descriptor into another. + #[must_use] + pub fn map_label<'a, K>(&'a self, fun: impl FnOnce(&'a L) -> K) -> QueueDescriptor { + QueueDescriptor { + label: fun(&self.label), + } + } +} + /// Describes a [`Device`](../wgpu/struct.Device.html). /// /// Corresponds to [WebGPU `GPUDeviceDescriptor`]( @@ -28,6 +49,10 @@ pub struct DeviceDescriptor { /// Exactly the specified limits, and no better or worse, /// will be allowed in validation of API calls on the resulting device. pub required_limits: crate::Limits, + /// Specifies the descriptor of the default queue for the device request. + /// + /// Corresponds to [WebGPU `GPUDeviceDescriptor.defaultQueue`](https://gpuweb.github.io/gpuweb/#dom-gpudevicedescriptor-defaultqueue). + pub default_queue: QueueDescriptor, /// Specifies whether `self.required_features` is allowed to contain experimental features. #[cfg_attr(feature = "serde", serde(skip))] pub experimental_features: crate::ExperimentalFeatures, @@ -39,13 +64,14 @@ pub struct DeviceDescriptor { } impl DeviceDescriptor { - /// Takes a closure and maps the label of the device descriptor into another. + /// Takes a closure and maps the labels of the descriptors into another. #[must_use] - pub fn map_label<'a, K>(&'a self, fun: impl FnOnce(&'a L) -> K) -> DeviceDescriptor { + pub fn map_label<'a, K>(&'a self, fun: impl Fn(&'a L) -> K) -> DeviceDescriptor { DeviceDescriptor { label: fun(&self.label), required_features: self.required_features, required_limits: self.required_limits.clone(), + default_queue: self.default_queue.map_label(fun), experimental_features: self.experimental_features, memory_hints: self.memory_hints.clone(), trace: self.trace.clone(), diff --git a/wgpu/src/api/device.rs b/wgpu/src/api/device.rs index a20f99a2f..0124fa64e 100644 --- a/wgpu/src/api/device.rs +++ b/wgpu/src/api/device.rs @@ -34,6 +34,15 @@ crate::cmp::impl_eq_ord_hash_proxy!(Device => .inner); pub type DeviceDescriptor<'a> = wgt::DeviceDescriptor>; static_assertions::assert_impl_all!(DeviceDescriptor<'_>: Send, Sync); +/// Describes a [`Queue`]. +/// +/// For use within a [`DeviceDescriptor`]. +/// +/// Corresponds to [WebGPU `GPUQueueDescriptor`]( +/// https://gpuweb.github.io/gpuweb/#dictdef-gpuqueuedescriptor). +pub type QueueDescriptor<'a> = wgt::QueueDescriptor>; +static_assertions::assert_impl_all!(QueueDescriptor<'_>: Send, Sync); + impl Device { #[cfg(custom)] /// Returns custom implementation of Device (if custom backend and is internally T) diff --git a/wgpu/src/backend/webgpu.rs b/wgpu/src/backend/webgpu.rs index 8a22a02c9..043b9a4bd 100644 --- a/wgpu/src/backend/webgpu.rs +++ b/wgpu/src/backend/webgpu.rs @@ -1824,6 +1824,12 @@ impl dispatch::AdapterInterface for WebAdapter { mapped_desc.set_label(label); } + if let Some(default_queue_label) = desc.default_queue.label { + let default_queue_desc = webgpu_sys::GpuQueueDescriptor::new(); + default_queue_desc.set_label(default_queue_label); + mapped_desc.set_default_queue(&default_queue_desc); + } + let device_promise = self.inner.request_device_with_descriptor(&mapped_desc); Box::pin(MakeSendFuture::new(