vka 0.0.1

A minimal vulkan wrapper
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

use ash::vk;
use ash::vk::SurfaceFormatKHR;
use itertools::Itertools;

use crate::AsExtent3D;
use crate::Image;
use crate::RenderingDevice;
use crate::Result;
use crate::Surface;
use crate::SurfaceConfig;

/// Encapsulates the Vulkan swapchain and its associated images for presentation to a window surface.
pub struct Swapchain {
    pub handle: vk::SwapchainKHR,
    pub device: ash::khr::swapchain::Device,
    pub images: Vec<Image>,

    pub extent: vk::Extent2D,
    pub format: vk::Format,
    pub color_space: vk::ColorSpaceKHR,
    pub present_mode: vk::PresentModeKHR,
}

fn present_mode_str(mode: vk::PresentModeKHR) -> &'static str {
    match mode {
        vk::PresentModeKHR::IMMEDIATE => "Immediate",
        vk::PresentModeKHR::MAILBOX => "Mailbox",
        vk::PresentModeKHR::FIFO => "Fifo",
        vk::PresentModeKHR::FIFO_RELAXED => "Fifo Relaxed",
        _ => "Unknown",
    }
}

/// Factory function to create or recreate a swapchain based on the current surface configuration.
pub fn make_swapchain(rd: &RenderingDevice, surface: &Surface, config: SurfaceConfig, old_swapchain: Option<vk::SwapchainKHR>) -> Result<Swapchain> {
    unsafe {
        let device = &rd.device;
        let instance = &rd.instance;

        let device = ash::khr::swapchain::Device::new(instance, device);
        let present_modes = surface.instance.get_physical_device_surface_present_modes(rd.phy_device, surface.handle)?;
        let caps = surface.instance.get_physical_device_surface_capabilities(rd.phy_device, surface.handle)?;
        let formats = surface.instance.get_physical_device_surface_formats(rd.phy_device, surface.handle)?;

        let SurfaceFormatKHR { format, color_space } = formats
            .iter()
            .find_map(|&f| {
                if f.format == vk::Format::B8G8R8A8_UNORM && f.color_space == vk::ColorSpaceKHR::SRGB_NONLINEAR {
                    Some(f)
                } else {
                    None
                }
            })
            .unwrap_or(formats[0]);

        let present_mode = if config.vsync {
            vk::PresentModeKHR::FIFO
        } else if present_modes.contains(&vk::PresentModeKHR::MAILBOX) {
            vk::PresentModeKHR::MAILBOX
        } else if present_modes.contains(&vk::PresentModeKHR::IMMEDIATE) {
            vk::PresentModeKHR::IMMEDIATE
        } else {
            present_modes[0]
        };

        let image_count = caps.min_image_count + 1;
        let extent = vk::Extent2D {
            width: if caps.max_image_extent.width > 0 {
                config.width.clamp(caps.min_image_extent.width, caps.max_image_extent.width)
            } else {
                config.width
            },
            height: if caps.max_image_extent.height > 0 {
                config.height.clamp(caps.min_image_extent.height, caps.max_image_extent.height)
            } else {
                config.height
            },
        };
        log::info!("Creating swapchain:");
        log::info!("Available present modes: {}", present_modes.iter().map(|&m| present_mode_str(m)).join(","));
        log::info!("Selected present mode: {}", present_mode_str(present_mode));
        log::info!("Surface Format: {}", format.as_raw());
        log::info!("Framebuffer Size: {}x{}", extent.width, extent.height);

        let swapchain = device.create_swapchain(
            &vk::SwapchainCreateInfoKHR::default()
                .surface(surface.handle)
                .min_image_count(image_count)
                .image_format(format)
                .image_color_space(color_space)
                .image_extent(extent)
                .image_array_layers(1)
                .image_usage(vk::ImageUsageFlags::COLOR_ATTACHMENT)
                .image_sharing_mode(vk::SharingMode::EXCLUSIVE)
                .pre_transform(caps.current_transform)
                .composite_alpha(vk::CompositeAlphaFlagsKHR::OPAQUE)
                .present_mode(present_mode)
                .clipped(true)
                .old_swapchain(old_swapchain.unwrap_or(vk::SwapchainKHR::null())),
            None,
        )?;
        let images = device
            .get_swapchain_images(swapchain)?
            .iter()
            .enumerate()
            .map(|(j, &image)| {
                let img = rd.image_from_raw(
                    image,
                    format,
                    extent.as_extent3d(1),
                    vk::SampleCountFlags::TYPE_1,
                    vk::ImageUsageFlags::COLOR_ATTACHMENT,
                    None,
                );
                img.set_name(format!("Swapchain Image {}", j));
                img
            })
            .collect_vec();

        Ok(Swapchain {
            handle: swapchain,
            device,
            images,
            extent,
            format,
            color_space,
            present_mode,
        })
    }
}