Struct Queue 

pub struct Queue {
    raw: Queue,
    device: Arc<DeviceShared>,
    family_index: u32,
    relay_semaphores: Mutex<RelaySemaphores>,
    signal_semaphores: Mutex<SemaphoreList>,
    wait_semaphores: Mutex<SemaphoreList>,
    next_submit_chain: Mutex<Option<PnextChain>>,
}

Available on vulkan only.

Fields

raw: Queue

device: Arc<DeviceShared>

family_index: u32

relay_semaphores: Mutex<RelaySemaphores>

signal_semaphores: Mutex<SemaphoreList>

wait_semaphores: Mutex<SemaphoreList>

next_submit_chain: Mutex<Option<PnextChain>>

A caller-provided pNext chain to attach to the [vk::SubmitInfo] of the next call to submit().

Set only through Queue::set_next_submit_chain().

Implementations

impl Queue

pub fn as_raw(&self) -> Queue

impl Queue

pub fn raw_device(&self) -> &Device

pub fn add_signal_semaphore( &self, semaphore: Semaphore, semaphore_value: Option<u64>, )

pub fn remove_signal_semaphore(&self, semaphore: Semaphore) -> bool

Remove semaphore from the pending signal list if it is still present.

Returns true if the semaphore was found and removed. If the submit already consumed it, this is a harmless no-op that returns false.

pub fn add_wait_semaphore( &self, semaphore: Semaphore, semaphore_value: Option<u64>, stage: PipelineStageFlags, )

Stage a semaphore wait on the next crate::Queue::submit call.

semaphore_value selects the kind of payload the wait targets:

• Some(value) - wait until semaphore (a timeline semaphore) has been signalled to at least value.
• None - wait on a binary semaphore signal.

stage is the pipeline stage at which the wait blocks downstream work (e.g. vk::PipelineStageFlags::TOP_OF_PIPE to gate the entire submission, or a more specific stage when only that stage reads the synchronised resource).

pub fn remove_wait_semaphore(&self, semaphore: Semaphore) -> bool

Remove semaphore from the pending wait list if it is still present.

Returns true if the semaphore was found and removed. If the submit already consumed it, this is a no-op that returns false.

pub unsafe fn set_next_submit_chain(&self, chain: *mut c_void)

Set a pNext chain of extension structs to attach to the [vk::SubmitInfo] of the next submit() on this queue.

This supports submission extensions that wgpu-hal has no dedicated support for. One example is VkLatencySubmissionPresentIdNV from VK_NV_low_latency2. The device extension itself must be enabled at device creation, for example with Adapter::open_with_callback().

The next submission on this queue consumes the chain, and a later call replaces a chain that hasn’t been submitted yet. One wgpu or wgpu-core submit maps to one submission here, but layers above wgpu-hal also make housekeeping submissions of their own, for example when a buffer is mapped, and those consume the chain too. Set the chain right before the submission it applies to, with no other queue or buffer-mapping work in between.

Safety

• chain must point to a valid pNext chain of structs that can extend [vk::SubmitInfo]. The extensions in the chain must be enabled on this queue’s device.
• The chain must stay valid until the next submission on this queue is made or the queue is dropped. Don’t read or write the chain during that time. Fields the driver wrote during submission may be read afterwards.

Trait Implementations

impl Debug for Queue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Queue

fn drop(&mut self)

Executes the destructor for this type.

impl DynResource for Queue

fn as_any(&self) -> &dyn Any

fn as_any_mut(&mut self) -> &mut dyn Any

impl Queue for Queue

type A = Api

unsafe fn submit( &self, command_buffers: &[&CommandBuffer], surface_textures: &[&SurfaceTexture], (signal_fence, signal_value): (&Fence, FenceValue), ) -> Result<(), DeviceError>

Submit command_buffers for execution on GPU.

unsafe fn present( &self, surface: &Surface, texture: SurfaceTexture, ) -> Result<(), SurfaceError>

Present a surface texture to the screen.

unsafe fn get_timestamp_period(&self) -> f32

unsafe fn wait_for_idle(&self) -> Result<(), DeviceError>

Block until all previously submitted work on this queue has completed, including any pending presentations.