Struct ccthw::graphics::vulkan_api::FramesInFlight

pub struct FramesInFlight { /* private fields */ }

A utility for synchronizing graphics commands and submission for multiple in-flight frames.

Implementations

impl FramesInFlight

pub unsafe fn new( render_device: Arc<RenderDevice>, framebuffer_size: (i32, i32), frame_count: usize ) -> Result<Self, GraphicsError>

Create resources for synchronizing multiple in-flight frames.

Params

• render_device - used to create all Vulkan resources
• framebuffer_size - the size of the framebuffer in pixels. This is used to create the swapchain and acompanying images.
• frame_count - the number of in-flight frames to support. Typically this is 2 for double-buffering or 3 for triple-buffering in-filght frames.

Safety

Unsafe because the application must destroy this struct prior to exiting. Furthermore, destruction of Vulkan resources which are used by in-flight frames should be delayed until all frames have finished executing or until the device is idle.

pub unsafe fn wait_for_all_frames_to_complete( &self ) -> Result<(), GraphicsError>

Wait for every frame’s commands to finish executing on the GPU.

Params

• render_device - the render device used to create the frames in flight.

Safety

It is an error to wait for frames while recording commands for a frame. e.g. do not call this function between calls to acquire_frame and present_frame.

pub unsafe fn stall_and_rebuild_swapchain( &mut self, framebuffer_size: (i32, i32) ) -> Result<(), GraphicsError>

Wait for every frame to finish executing then rebuild the swapchain.

Safety

Unsafe because:

• it is invalid to rebuild the swapchain while recording a frame. In other words, never call this function after getting a frame from acquire_frame and before returning that frame with present_frame.

pub fn swapchain(&self) -> &Swapchain

Get the current swapchain.

pub fn invalidate_swapchain(&mut self)

Manually invalidate the swapchain so it is forced to be rebuilt the next time a frame is requested.

This can be useful in cases where it’s known that the swapchain will need to be rebuilt (like when the application window is resized).

pub fn frame_count(&self) -> usize

The maximum number of in-flight frames.

pub fn acquire_frame(&mut self) -> Result<FrameStatus, GraphicsError>

Acquire the next frame for rendering.

Params

• render_device - the render device used to create the frames in flight.

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

Submit a frame’s commands to the graphics queue and schedule the swapchain image for presentation.

Params

• render_device - the render device used to create the frames in flight.
• frame - the frame to present

Trait Implementations

impl Drop for FramesInFlight

fn drop(&mut self)

Destroy all frame resources.

Safety

Unsafe because:

• The application should drop this before any resources which are used by any frames.