Add DeviceDescriptor::default_queue: QueueDescriptor to support setting label to queue (#10109)

Signed-off-by: sagudev <16504129+sagudev@users.noreply.github.com>
This commit is contained in:
Sam authored and GitHub committed 2026-08-19 10:06:10 +00:00
1 parent b4ced71d93
commit feab2f79ef
24 files changed
+108 -13

No files matched your search

+18
View File
@@ -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
+1
View File
@@ -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,
+12
View File
@@ -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<String, Option<u64>>,
#[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,
@@ -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,
+1
View File
@@ -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,
+1
View File
@@ -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") {
@@ -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,
@@ -144,6 +144,7 @@ impl ApplicationHandler<TriangleAction> 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,
@@ -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,
@@ -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,
@@ -20,6 +20,7 @@ async fn run(_path: Option<String>) {
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,
@@ -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,
@@ -34,6 +34,7 @@ async fn run(_path: Option<String>) {
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,
@@ -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,
@@ -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,
@@ -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,
+1
View File
@@ -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,
+1
View File
@@ -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,
+1
View File
@@ -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<Label<'a>>;
pub type QueueDescriptor<'a> = wgt::QueueDescriptor<Label<'a>>;
#[repr(C)]
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
+8 -10
View File
@@ -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<dyn hal::DynQueue>,
pub(crate) pending_writes: Mutex<PendingWrites>,
life_tracker: Mutex<LifetimeTracker>,
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<Device>,
}
@@ -58,6 +59,7 @@ impl Queue {
pub(crate) fn new(
device: Arc<Device>,
raw: Box<dyn hal::DynQueue>,
desc: QueueDescriptor,
instance_flags: wgt::InstanceFlags,
) -> Result<Self, DeviceError> {
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<Vec<crate::command::Command<crate::command::PointerReferences>>>,
error: alloc::string::String,
error: String,
) {
if let Some(ref mut trace) = *self.device.trace.lock() {
trace.add(Action::FailedCommands {
+8 -1
View File
@@ -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);
+28 -2
View File
@@ -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<L> {
/// Debug label for the queue.
pub label: L,
}
impl<L> QueueDescriptor<L> {
/// 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<K> {
QueueDescriptor {
label: fun(&self.label),
}
}
}
/// Describes a [`Device`](../wgpu/struct.Device.html).
///
/// Corresponds to [WebGPU `GPUDeviceDescriptor`](
@@ -28,6 +49,10 @@ pub struct DeviceDescriptor<L> {
/// 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<L>,
/// 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<L> {
}
impl<L> DeviceDescriptor<L> {
/// 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<K> {
pub fn map_label<'a, K>(&'a self, fun: impl Fn(&'a L) -> K) -> DeviceDescriptor<K> {
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(),
+9
View File
@@ -34,6 +34,15 @@ crate::cmp::impl_eq_ord_hash_proxy!(Device => .inner);
pub type DeviceDescriptor<'a> = wgt::DeviceDescriptor<Label<'a>>;
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<Label<'a>>;
static_assertions::assert_impl_all!(QueueDescriptor<'_>: Send, Sync);
impl Device {
#[cfg(custom)]
/// Returns custom implementation of Device (if custom backend and is internally T)
+6
View File
@@ -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(