Struct vulkano::command_buffer::submit::SubmitPresentBuilder

pub struct SubmitPresentBuilder<'a> { /* fields omitted */ }

Prototype for a submission that presents a swapchain on the screen.

Methods

impl<'a> SubmitPresentBuilder<'a>

pub fn new() -> SubmitPresentBuilder<'a>

Builds a new empty SubmitPresentBuilder.

pub unsafe fn add_wait_semaphore(&mut self, semaphore: &'a Semaphore)

Adds a semaphore to be waited upon before the presents are executed.

Safety

• If you submit this builder, the semaphore must be kept alive until you are guaranteed that the GPU has presented the swapchains.

• If you submit this builder, no other queue must be waiting on these semaphores. In other words, each semaphore signal can only correspond to one semaphore wait.

• If you submit this builder, the semaphores must be signaled when the queue execution reaches this submission, or there must be one or more submissions in queues that are going to signal these semaphores. In other words, you must not block the queue with semaphores that can't get signaled.

• The swapchains and semaphores must all belong to the same device.

pub unsafe fn add_swapchain<W>(
    &mut self,
    swapchain: &'a Swapchain<W>,
    image_num: u32,
    present_region: Option<&'a PresentRegion>
)

Adds an image of a swapchain to be presented.

Allows to specify a present region. Areas outside the present region can be ignored by the Vulkan implementation for optimizations purposes.

If VK_KHR_incremental_present is not enabled, the present_region parameter is ignored.

Safety

• If you submit this builder, the swapchain must be kept alive until you are guaranteed that the GPU has finished presenting.

• The swapchains and semaphores must all belong to the same device.

pub fn submit(self, queue: &Queue) -> Result<(), SubmitPresentError>

Submits the command. Calls vkQueuePresentKHR.

Panic

Panics if no swapchain image has been added to the builder.

Trait Implementations

impl<'a> Into<SubmitPresentBuilder<'a>> for SubmitSemaphoresWaitBuilder<'a>

fn into(self) -> SubmitPresentBuilder<'a>

Performs the conversion.

impl<'a> Debug for SubmitPresentBuilder<'a>

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.