Trait gfx_hal::queue::CommandQueue

pub trait CommandQueue<B: Backend>: Debug + Any + Send + Sync {
    unsafe fn submit<'a, T, Ic, S, Iw, Is>(
        &mut self, 
        submission: Submission<Ic, Iw, Is>, 
        fence: Option<&B::Fence>
    )
    where
        T: 'a + Borrow<B::CommandBuffer>,
        Ic: IntoIterator<Item = &'a T>,
        S: 'a + Borrow<B::Semaphore>,
        Iw: IntoIterator<Item = (&'a S, PipelineStage)>,
        Is: IntoIterator<Item = &'a S>;
    unsafe fn present<'a, W, Is, S, Iw>(
        &mut self, 
        swapchains: Is, 
        wait_semaphores: Iw
    ) -> Result<Option<Suboptimal>, PresentError>
    where
        Self: Sized,
        W: 'a + Borrow<B::Swapchain>,
        Is: IntoIterator<Item = (&'a W, SwapImageIndex)>,
        S: 'a + Borrow<B::Semaphore>,
        Iw: IntoIterator<Item = &'a S>;
    unsafe fn present_surface(
        &mut self, 
        surface: &mut B::Surface, 
        image: <B::Surface as PresentationSurface<B>>::SwapchainImage, 
        wait_semaphore: Option<&B::Semaphore>
    ) -> Result<Option<Suboptimal>, PresentError>;
    fn wait_idle(&self) -> Result<(), OutOfMemory>;

    unsafe fn submit_without_semaphores<'a, T, Ic>(
        &mut self, 
        command_buffers: Ic, 
        fence: Option<&B::Fence>
    )
    where
        T: 'a + Borrow<B::CommandBuffer>,
        Ic: IntoIterator<Item = &'a T>,
    { ... }
    unsafe fn present_without_semaphores<'a, W, Is>(
        &mut self, 
        swapchains: Is
    ) -> Result<Option<Suboptimal>, PresentError>
    where
        Self: Sized,
        W: 'a + Borrow<B::Swapchain>,
        Is: IntoIterator<Item = (&'a W, SwapImageIndex)>,
    { ... }
}

RawCommandQueue are abstractions to the internal GPU execution engines. Commands are executed on the the device by submitting command buffers to queues.

Required methods

unsafe fn submit<'a, T, Ic, S, Iw, Is>(
    &mut self,
    submission: Submission<Ic, Iw, Is>,
    fence: Option<&B::Fence>
) where
    T: 'a + Borrow<B::CommandBuffer>,
    Ic: IntoIterator<Item = &'a T>,
    S: 'a + Borrow<B::Semaphore>,
    Iw: IntoIterator<Item = (&'a S, PipelineStage)>,
    Is: IntoIterator<Item = &'a S>, 

Submit command buffers to queue for execution. fence must be in unsignalled state, and will be signalled after all command buffers in the submission have finished execution.

Unsafe because it's not checked that the queue can process the submitted command buffers. Trying to submit compute commands to a graphics queue will result in undefined behavior. Each queue implements safer wrappers according to their supported functionalities!

unsafe fn present<'a, W, Is, S, Iw>(
    &mut self,
    swapchains: Is,
    wait_semaphores: Iw
) -> Result<Option<Suboptimal>, PresentError> where
    Self: Sized,
    W: 'a + Borrow<B::Swapchain>,
    Is: IntoIterator<Item = (&'a W, SwapImageIndex)>,
    S: 'a + Borrow<B::Semaphore>,
    Iw: IntoIterator<Item = &'a S>, 

Presents the result of the queue to the given swapchains, after waiting on all the semaphores given in wait_semaphores. A given swapchain must not appear in this list more than once.

Unsafe for the same reasons as submit().

unsafe fn present_surface(
    &mut self,
    surface: &mut B::Surface,
    image: <B::Surface as PresentationSurface<B>>::SwapchainImage,
    wait_semaphore: Option<&B::Semaphore>
) -> Result<Option<Suboptimal>, PresentError>

Present the a

fn wait_idle(&self) -> Result<(), OutOfMemory>

Wait for the queue to idle.

Loading content...

Provided methods

unsafe fn submit_without_semaphores<'a, T, Ic>(
    &mut self,
    command_buffers: Ic,
    fence: Option<&B::Fence>
) where
    T: 'a + Borrow<B::CommandBuffer>,
    Ic: IntoIterator<Item = &'a T>, 

Simplified version of submit that doesn't expect any semaphores.

unsafe fn present_without_semaphores<'a, W, Is>(
    &mut self,
    swapchains: Is
) -> Result<Option<Suboptimal>, PresentError> where
    Self: Sized,
    W: 'a + Borrow<B::Swapchain>,
    Is: IntoIterator<Item = (&'a W, SwapImageIndex)>, 

Simplified version of present that doesn't expect any semaphores.

Loading content...

Implementors

Loading content...