Struct demo_vk::graphics::vulkan::FramesInFlight

pub struct FramesInFlight { /* private fields */ }

The primary synchronization mechanism for managing multiple in-flight frames.

There can be 1-N frames in flight for the application, decided at the time of construction. This is independent from the number of swapchain images, though there is little-to-no benefit to having more frames in flight than swapchain images.

Synchronization is performed such that when Self::start_frame returns, all commands submitted to that frame are guaranteed to be complete. Thus, the application can keep N copies of a resource and use the frame_index to prevent synchronization errors.

Implementations

impl FramesInFlight

pub fn new(cxt: Arc<VulkanContext>, frame_count: usize) -> Result<Self>

Creates a new instance with frame_count frames.

pub fn frame_count(&self) -> usize

Get the total number of configured frames in flight.

pub fn wait_for_all_frames_to_complete(&self) -> Result<()>

Blocks until all submitted commands for all frames have completed.

pub fn start_frame(&mut self, swapchain: &Swapchain) -> Result<FrameStatus>

Starts the next frame in flight.

This method can block if all frames are in flight. It will block until the next frame is available.

Returns

A FrameStatus containing one of:

• A Frame that must be returned to Self::present_frame
• A flag indicating that the Swapchain needs to be rebuilt before the next frame.

pub fn present_frame( &mut self, swapchain: &Swapchain, frame: Frame, ) -> Result<PresentImageStatus>

Queues the Frame’s command buffer and swapchain presentation.

Trait Implementations

impl Debug for FramesInFlight

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

Formats the value using the given formatter.

impl Drop for FramesInFlight

fn drop(&mut self)

Executes the destructor for this type.