Struct ccthw::graphics::vulkan_api::Swapchain

pub struct Swapchain { /* private fields */ }

The Vulkan swapchain, loader, images, image views, and related data.

It’s often useful to keep the raw Vulkan swapchain together with all of it’s related information. It’s also helpful to have a newtype which can define some helper functions for working with swapchain resources.

Implementations

impl Swapchain

pub unsafe fn acquire_swapchain_image( &self, semaphore: Semaphore, fence: Fence ) -> Result<SwapchainStatus, GraphicsError>

Acquire the next swapchain image.

Params

• semaphore - a semaphore to signal when the swapchain image is available.

Safety

The application must correctly handle a swapchain acquisition failure and rebuild the swapchain on demand.

pub unsafe fn present_swapchain_image( &self, index: usize, wait_semaphores: &[Semaphore] ) -> Result<SwapchainStatus, GraphicsError>

Present a swapchain image to the screen.

Safety

Unsafe because:

• the application must correctly handle a swapchain acquisition failure and rebuild the swapchain on demand
• the application must transition the swapchain image to the correct image layout. Typically this is done with a Render Pass.

impl Swapchain

pub unsafe fn new( render_device: Arc<RenderDevice>, framebuffer_size: (u32, u32), previous_swapchain: Option<Self> ) -> Result<Self, GraphicsError>

Create a new swapchain and acompanying resources.

Params

• render_device - the device used to create vulkan resources
• framebuffer_size - the size of the window’s framebuffer in device pixels.
• previous_swapchain - the previous swapchain (if any). This is provided to the new swapchain and will be destroyed inside this method.

Safety

Unsafe because:

• the application must destroy the swapchain before the render device
• the application must synchronize access to GPU resources
• the application is responsible for ensuring no GPU resources still reference the previous swapchain when it is provided to this method. The previous swapchain will be destroyed when the new swapchain is constructed.

pub unsafe fn images(&self) -> &[Image]

Access the raw Swapchain images.

Safety

Unsafe because:

• the application must synchronize access to swapchain images
• the images are destroyed when the swapchain is replaced, the application must ensure the image handles are not referenced after any calls to destroy.

pub fn image_format(&self) -> Format

The format used by images in the swapchain.

pub fn extent(&self) -> Extent2D

The extent for all swapchain images.

pub fn present_mode(&self) -> PresentModeKHR

The presentation mode used by this swapchain.

Trait Implementations

impl Debug for Swapchain

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

Formats the value using the given formatter.

impl Display for Swapchain

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

Formats the value using the given formatter.

impl Drop for Swapchain

fn drop(&mut self)

Destroy the swapchain.

Safety

Unsafe because:

• the application must drop the swapchain before the logical device and vulkan instance
• the application must synchronize access to GPU resources and ensure no pending operations still depend on the swapchain

impl VulkanHandle for Swapchain

type Handle = SwapchainKHR

unsafe fn raw(&self) -> &Self::Handle

Get the raw resource handle.