gfx_hal/queue/
family.rs

1//! Queue family and groups.
2
3use crate::{queue::QueueType, Backend};
4
5use std::{any::Any, fmt::Debug};
6
7/// General information about a queue family, available upon adapter discovery.
8///
9/// Note that a backend can expose multiple queue families with the same properties.
10///
11/// Can be obtained from an [adapter][crate::adapter::Adapter] through its
12/// [`queue_families`][crate::adapter::Adapter::queue_families] field.
13pub trait QueueFamily: Debug + Any + Send + Sync {
14    /// Returns the type of queues.
15    fn queue_type(&self) -> QueueType;
16    /// Returns maximum number of queues created from this family.
17    fn max_queues(&self) -> usize;
18    /// Returns the queue family ID.
19    fn id(&self) -> QueueFamilyId;
20    /// Returns true if the queue family supports sparse binding
21    fn supports_sparse_binding(&self) -> bool;
22}
23
24/// Identifier for a queue family of a physical device.
25#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
26#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
27pub struct QueueFamilyId(pub usize);
28
29/// Bare-metal queue group.
30///
31/// Denotes all queues created from one queue family.
32#[derive(Debug)]
33pub struct QueueGroup<B: Backend> {
34    /// Family index for the queues in this group.
35    pub family: QueueFamilyId,
36    /// List of queues.
37    pub queues: Vec<B::Queue>,
38}
39
40impl<B: Backend> QueueGroup<B> {
41    /// Create a new, empty queue group for a queue family.
42    pub fn new(family: QueueFamilyId) -> Self {
43        QueueGroup {
44            family,
45            queues: Vec::new(),
46        }
47    }
48
49    /// Add a command queue to the group.
50    ///
51    /// The queue needs to be created from this queue family.
52    pub fn add_queue(&mut self, queue: B::Queue) {
53        self.queues.push(queue);
54    }
55}
gfx_hal/queue/family.rs

gfx_hal/queue/
family.rs
