Enum rafx_api::RafxQueue

pub enum RafxQueue {
    Empty(RafxQueueEmpty),
}

A queue allows work to be submitted to the GPU

Work that has been submitted to the same queue has some ordering guarantees.

Resources may only be accessed from one queue type at a time. If a resource is to be used by a different queue, a memory barrier on both the “sending” and “receiving” queue is required.

The default configuration is to return the same underlying queue every time create_queue() is called. A mutex protects against multiple threads submitting work to the queue at the same time.

Most applications can just create and use graphics queues freely, relying on the API returning the same underlying queue every time.

Variants

Empty(RafxQueueEmpty)

Implementations

impl RafxQueue

pub fn device_context(&self) -> RafxDeviceContext

pub fn queue_id(&self) -> u32

Returns an opaque ID associated with this queue. It may be used to hash which queue a command pool is associated with

pub fn queue_type(&self) -> RafxQueueType

Get the type of queue that this is

pub fn create_command_pool(
    &self,
    command_pool_def: &RafxCommandPoolDef
) -> RafxResult<RafxCommandPool>

Create a command pool for use with this queue

pub fn submit(
    &self,
    command_buffers: &[&RafxCommandBuffer],
    wait_semaphores: &[&RafxSemaphore],
    signal_semaphores: &[&RafxSemaphore],
    signal_fence: Option<&RafxFence>
) -> RafxResult<()>

Submit command buffers for processing by the GPU.

Execution will not begin until all wait_semaphores are signaled.

After execution, the given signal_semaphores and signal_fence are signaled as completed.

pub fn present(
    &self,
    swapchain: &RafxSwapchain,
    wait_semaphores: &[&RafxSemaphore],
    image_index: u32
) -> RafxResult<RafxPresentSuccessResult>

Presents an image in the swapchain.

Execution will not begin until all wait_semaphores are signaled.

pub fn wait_for_queue_idle(&self) -> RafxResult<()>

Wait until all work submitted to this queue is completed

pub fn empty_queue(&self) -> Option<&RafxQueueEmpty>

Get the underlying metal API object. This provides access to any internally created metal objects.

Trait Implementations

impl Clone for RafxQueue

fn clone(&self) -> RafxQueue

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RafxQueue

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

Formats the value using the given formatter.