vka 0.0.3

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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
#![allow(unused)]

use std::borrow::Cow;
use std::cell::{Cell, Ref, RefMut};
use std::ops::DerefMut;
use std::{cell::RefCell, ffi::CStr, mem::ManuallyDrop, ops::Deref, rc::Rc, sync::LazyLock};

use ash::ext::debug_utils;
use ash::vk;
use gpu_allocator::vulkan::{Allocator, AllocatorCreateDesc};
use itertools::Itertools;
use std::sync::Mutex as StdMutex;

mod belt;
mod buffer;
mod desc;
mod descriptor;
mod image;
mod pass;
mod pipeline;
mod resource;
mod surface;
mod swapchain;
mod utils;

pub use buffer::*;
pub use desc::*;
pub use descriptor::*;
pub use image::*;
pub use pass::*;
pub use pipeline::*;
pub use resource::*;
pub use surface::*;
pub use swapchain::*;
pub use utils::*;

pub use log;
pub use ash;
pub use ash_window;
pub use anyhow;
pub use raw_window_handle;
pub use gpu_allocator;

pub use gpu_allocator::MemoryLocation;
pub use gpu_allocator::vulkan::Allocation;
pub use gpu_allocator::vulkan::AllocationScheme;

use crate::belt::StagingBelt;

pub type Result<T> = anyhow::Result<T>;

pub static ENTRY: LazyLock<ash::Entry> = LazyLock::new(|| unsafe { ash::Entry::load().expect("Failed to load Vulkan library") });

/// Holds indices for the different Vulkan queue families used by the device.
#[derive(Debug, Clone, Copy)]
pub struct QueueFamilies {
    pub present: u32,
    pub graphics: u32,
    pub compute: u32,
    pub transfer: u32,
}

impl Default for QueueFamilies {
    fn default() -> Self {
        Self {
            present: vk::QUEUE_FAMILY_IGNORED,
            graphics: vk::QUEUE_FAMILY_IGNORED,
            compute: vk::QUEUE_FAMILY_IGNORED,
            transfer: vk::QUEUE_FAMILY_IGNORED,
        }
    }
}

/// Represents resources required for rendering a single frame in flight.
pub struct Frame {
    pub cmd_pool: vk::CommandPool,
    pub active_cmd: Cell<vk::CommandBuffer>,
    pub used_cmd: Cell<vk::CommandBuffer>,

    pub fence: Cell<vk::Fence>,
    pub fence_signalled: Cell<bool>,
    pub belt: RefCell<StagingBelt>,
}

pub struct Presentation {
    pub surface: Surface,
    pub surface_config: SurfaceConfig,
    pub swapchain: Swapchain,

    pub acquire_semaphores: Vec<vk::Semaphore>,
    pub present_semaphores: Vec<vk::Semaphore>,

    pub image_index: usize,
    pub image_acquired: bool,

    pub invalid: bool,
    pub suboptimal: bool,
}

/// The inner state of a Vulkan rendering device containing the instance, physical device, logical device, and other core resources.
pub struct RenderingDeviceImpl {
    pub instance: ash::Instance,
    pub device: ash::Device,
    pub phy_device: vk::PhysicalDevice,
    pub properties: vk::PhysicalDeviceProperties,
    pub mem_properties: vk::PhysicalDeviceMemoryProperties,
    pub features: vk::PhysicalDeviceFeatures,
    pub features11: vk::PhysicalDeviceVulkan11Features<'static>,
    pub features12: vk::PhysicalDeviceVulkan12Features<'static>,
    pub features13: vk::PhysicalDeviceVulkan13Features<'static>,

    pub enabled_extensions: Vec<&'static CStr>,
    pub enabled_layers: Vec<&'static CStr>,
    pub enabled_instance_exts: Vec<&'static CStr>,

    pub allocator: ManuallyDrop<StdMutex<Allocator>>,

    debug_utils: Option<DebugUtils>,
    presentation: RefCell<Option<Presentation>>,

    pub queue_families: QueueFamilies,
    pub graphics_queue: vk::Queue,
    pub present_queue: vk::Queue,

    pub frames: Vec<Frame>,
    pub frame_index: Cell<usize>,
}

/// A reference-counted wrapper around `RenderingDeviceImpl`, providing convenient access to Vulkan operations.
#[derive(Clone)]
#[repr(transparent)]
pub struct RenderingDevice(Rc<RenderingDeviceImpl>);

impl Deref for RenderingDevice {
    type Target = RenderingDeviceImpl;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl RenderingDevice {
    /// Initializes a new Vulkan rendering device, instances, and necessary Queues/Allocators according to `RenderingDeviceDesc`.
    pub fn new(desc: &RenderingDeviceDesc) -> Result<Self> {
        unsafe {
            let vulkan_version = ENTRY.try_enumerate_instance_version()?.unwrap_or(vk::API_VERSION_1_0);
            let enum_layer_props = ENTRY.enumerate_instance_layer_properties()?;
            let enum_ext_props = ENTRY.enumerate_instance_extension_properties(None)?;

            let available_layers = enum_layer_props.iter().map(|x| x.layer_name_as_c_str().unwrap()).collect_vec();
            let available_exts = enum_ext_props.iter().map(|x| x.extension_name_as_c_str().unwrap()).collect_vec();

            let app_info = vk::ApplicationInfo::default()
                .engine_name(desc.app_name)
                .application_name(desc.app_name)
                .application_version(vk::make_api_version(0, 1, 0, 0))
                .api_version(vulkan_version);

            let mut enabled_layers = Vec::new();
            let mut enabled_instance_exts = vec![vk::KHR_GET_PHYSICAL_DEVICE_PROPERTIES2_NAME];

            if let Some(surface) = desc.surface {
                enabled_instance_exts.extend(ash_window::enumerate_required_extensions(surface.0).unwrap().iter().map(|&x| CStr::from_ptr(x)));
            }
            let validation_layers_enabled = desc.gpu_validation && available_layers.contains(&c"VK_LAYER_KHRONOS_validation") && available_exts.contains(&vk::EXT_DEBUG_UTILS_NAME);

            if validation_layers_enabled {
                enabled_layers.push(c"VK_LAYER_KHRONOS_validation");
                enabled_instance_exts.push(vk::EXT_DEBUG_UTILS_NAME);
            }
            if cfg!(any(target_os = "macos", target_os = "ios")) {
                enabled_instance_exts.push(vk::KHR_PORTABILITY_ENUMERATION_NAME)
            }

            let inst_layers_ptr = enabled_layers.iter().map(|x| x.as_ptr()).collect_vec();
            let inst_exts_ptr = enabled_instance_exts.iter().map(|x| x.as_ptr()).collect_vec();
            let mut instance_info = vk::InstanceCreateInfo::default()
                .application_info(&app_info)
                .enabled_layer_names(&inst_layers_ptr)
                .enabled_extension_names(&inst_exts_ptr);
            if cfg!(any(target_os = "macos", target_os = "ios")) {
                instance_info.flags |= vk::InstanceCreateFlags::ENUMERATE_PORTABILITY_KHR;
            }

            log::info!("Creating vulkan instance:");
            log::info!("App name: {}", desc.app_name.to_str()?);
            log::info!("Vulkan Version: {}", vulkan_version_str(vulkan_version));
            log::info!("Extensions: {}", enabled_instance_exts.iter().map(|&v| v.to_str().unwrap()).join(", "));
            log::info!("Layers: {}", enabled_layers.iter().map(|&v| v.to_str().unwrap()).join(", "));
            let instance = ENTRY.create_instance(&instance_info, None)?;

            let mut enabled_device_exts = vec![vk::KHR_DYNAMIC_RENDERING_NAME];
            if cfg!(any(target_os = "macos", target_os = "ios")) {
                enabled_device_exts.push(vk::KHR_PORTABILITY_SUBSET_NAME);
            }

            let found_devices = instance
                .enumerate_physical_devices()?
                .iter()
                .map(|&pd| (pd, instance.get_physical_device_properties(pd)))
                .collect_vec();
            log::info!("Found devices: {}", found_devices.clone().iter().map(|f| utils::device_full_name(&f.1)).join(", "));

            let (mut phy_device, mut properties, _) = found_devices
                .iter()
                .map(|&(pd, props)| {
                    // TODO: better scoring system
                    let score = match props.device_type {
                        vk::PhysicalDeviceType::DISCRETE_GPU => 5,
                        vk::PhysicalDeviceType::INTEGRATED_GPU => 4,
                        vk::PhysicalDeviceType::VIRTUAL_GPU => 3,
                        vk::PhysicalDeviceType::CPU => 2,
                        _ => 1,
                    };
                    (pd, props, score)
                })
                .sorted_by(|a, b| Ord::cmp(&b.2, &a.2))
                .next()
                .ok_or(vk::Result::ERROR_UNKNOWN)?;

            if let Some(idx) = desc.pick_device {
                if let Some((pd, props)) = found_devices.get(idx) {
                    log::info!("Picking device at specified index {}", idx);
                    phy_device = *pd;
                    properties = *props;
                } else {
                    log::warn!("Specified device index {} is out of bounds, ignoring", idx);
                }
            }

            let mut features = vk::PhysicalDeviceFeatures2::default();
            let mut features11 = vk::PhysicalDeviceVulkan11Features::default();
            let mut features12 = vk::PhysicalDeviceVulkan12Features::default();
            let mut features13 = vk::PhysicalDeviceVulkan13Features::default();

            features = features.push_next(&mut features11).push_next(&mut features12).push_next(&mut features13);
            instance.get_physical_device_features2(phy_device, &mut features);

            features.features.robust_buffer_access &= desc.gpu_validation as u32;

            let surface = if let Some((rdh, rwh)) = desc.surface {
                enabled_device_exts.push(vk::KHR_SWAPCHAIN_NAME);
                Some(make_surface(&instance, rdh, rwh)?)
            } else {
                None
            };

            let queue_props = instance.get_physical_device_queue_family_properties(phy_device);
            let mut queue_families = QueueFamilies::default();
            for (i, props) in queue_props.iter().enumerate() {
                let i = i as u32;
                if props.queue_flags.contains(vk::QueueFlags::GRAPHICS) && queue_families.graphics == vk::QUEUE_FAMILY_IGNORED {
                    queue_families.graphics = i;
                }
                if let Some(surface) = &surface {
                    if surface.instance.get_physical_device_surface_support(phy_device, i, surface.handle).unwrap_or(false) {
                        queue_families.present = i;
                    }
                }
                if props.queue_flags.contains(vk::QueueFlags::COMPUTE) {
                    queue_families.compute = i;
                }
                if props.queue_flags.contains(vk::QueueFlags::TRANSFER) {
                    queue_families.transfer = i;
                }
            }

            if queue_families.present == vk::QUEUE_FAMILY_IGNORED {
                queue_families.present = queue_families.graphics;
                log::warn!("No present queue found, falling back to graphics queue");
            }

            let features10 = features.features;
            log::info!("Creating logical device");
            log::info!("Picked device: {}", utils::device_full_name(&properties));
            log::info!("Enabled Extensions: {}", &enabled_device_exts.iter().map(|x| x.to_str().unwrap()).join(","));

            let queue_create_infos = [queue_families.present, queue_families.graphics, queue_families.compute, queue_families.transfer]
                .iter()
                .unique()
                .filter(|&&i| i != vk::QUEUE_FAMILY_IGNORED)
                .map(|&i| vk::DeviceQueueCreateInfo::default().queue_family_index(i).queue_priorities(&[1.0]))
                .collect_vec();
            let device = instance.create_device(
                phy_device,
                &vk::DeviceCreateInfo::default()
                    .enabled_extension_names(&enabled_device_exts.iter().map(|x| x.as_ptr()).collect_vec())
                    .queue_create_infos(&queue_create_infos)
                    .push_next(&mut features),
                None,
            )?;
            let mem_properties = instance.get_physical_device_memory_properties(phy_device);
            let debug_utils = if validation_layers_enabled { Some(make_debug_utils(&instance, &device)?) } else { None };

            let graphics_queue = device.get_device_queue(queue_families.graphics, 0);
            let present_queue = device.get_device_queue(queue_families.present, 0);
            // TODO: more on that later
            let allocator = StdMutex::new(
                Allocator::new(&AllocatorCreateDesc {
                    instance: instance.clone(),
                    device: device.clone(),
                    physical_device: phy_device,
                    debug_settings: Default::default(),
                    buffer_device_address: features12.buffer_device_address != 0 || enabled_device_exts.contains(&vk::EXT_BUFFER_DEVICE_ADDRESS_NAME),
                    allocation_sizes: Default::default(),
                })
                .unwrap(),
            );

            let frames = (0..desc.n_frames)
                .map(|_| unsafe {
                    let cmd_pool = device
                        .create_command_pool(
                            &vk::CommandPoolCreateInfo::default()
                                .queue_family_index(queue_families.graphics)
                                .flags(vk::CommandPoolCreateFlags::RESET_COMMAND_BUFFER),
                            None,
                        )
                        .unwrap();
                    let cmds = device
                        .allocate_command_buffers(
                            &vk::CommandBufferAllocateInfo::default()
                                .command_buffer_count(2)
                                .command_pool(cmd_pool)
                                .level(vk::CommandBufferLevel::PRIMARY),
                        )
                        .unwrap();
                    device
                        .begin_command_buffer(cmds[0], &vk::CommandBufferBeginInfo::default().flags(vk::CommandBufferUsageFlags::ONE_TIME_SUBMIT))
                        .unwrap();
                    device
                        .begin_command_buffer(cmds[1], &vk::CommandBufferBeginInfo::default().flags(vk::CommandBufferUsageFlags::ONE_TIME_SUBMIT))
                        .unwrap();

                    let fence = device.create_fence(&vk::FenceCreateInfo::default().flags(vk::FenceCreateFlags::SIGNALED), None).unwrap();
                    Frame {
                        cmd_pool,
                        active_cmd: Cell::new(cmds[0]),
                        used_cmd: Cell::new(cmds[1]),
                        fence: Cell::new(fence),
                        fence_signalled: Cell::new(true),
                        belt: RefCell::new(StagingBelt::new(4 * 1024 * 1024)), // 4 MB per chunk
                    }
                })
                .collect_vec();

            let rd = RenderingDevice(Rc::new(RenderingDeviceImpl {
                instance,
                device,
                phy_device,
                properties,
                mem_properties,
                features: features10,
                features11,
                features12,
                features13,

                enabled_extensions: enabled_device_exts,
                enabled_layers,
                enabled_instance_exts,

                allocator: ManuallyDrop::new(allocator),

                debug_utils,
                presentation: RefCell::new(None),

                queue_families,
                graphics_queue,
                present_queue,

                frames,
                frame_index: Cell::new(0),
            }));

            rd.wait_device()?;

            let presentation = surface.map(|s| {
                let config = SurfaceConfig::default();
                let swapchain = swapchain::make_swapchain(&rd, &s, config, None).unwrap();
                let acquire_semaphores = (0..rd.frames.len())
                    .map(|_| rd.device.create_semaphore(&vk::SemaphoreCreateInfo::default(), None).unwrap())
                    .collect_vec();
                let present_semaphores = (0..swapchain.images.len())
                    .map(|_| rd.device.create_semaphore(&vk::SemaphoreCreateInfo::default(), None).unwrap())
                    .collect_vec();
                Presentation {
                    surface: s,
                    surface_config: config,
                    swapchain: swapchain,

                    acquire_semaphores,
                    present_semaphores,

                    image_index: 0,
                    image_acquired: false,

                    invalid: false,
                    suboptimal: false,
                }
            });
            rd.presentation.replace(presentation);

            Result::Ok(rd)
        }
    }

    /// Updates the swapchain surface configuration and recreates the swapchain.
    pub fn configure_surface(&self, config: SurfaceConfig) {
        if let Some(p) = self.presentation.borrow_mut().as_mut() {
            p.surface_config = config;
        }
        self.recreate_swapchain();
    }

    pub fn recreate_swapchain(&self) {
        unsafe {
            if let Some(p) = self.presentation.borrow_mut().as_mut() {
                self.wait_device();

                p.suboptimal = false;
                p.invalid = false;
                p.image_acquired = false;
                p.swapchain = swapchain::make_swapchain(self, &p.surface, p.surface_config, Some(p.swapchain.handle)).unwrap();

                for s in &p.acquire_semaphores {
                    self.device.destroy_semaphore(*s, None);
                }
                for s in &p.present_semaphores {
                    self.device.destroy_semaphore(*s, None);
                }
                p.acquire_semaphores = (0..self.frames.len())
                    .map(|_| self.device.create_semaphore(&vk::SemaphoreCreateInfo::default(), None).unwrap())
                    .collect_vec();
                p.present_semaphores = (0..p.swapchain.images.len())
                    .map(|_| self.device.create_semaphore(&vk::SemaphoreCreateInfo::default(), None).unwrap())
                    .collect_vec();
                for frame in self.frames.iter() {
                    self.device.destroy_fence(frame.fence.get(), None);
                    frame.fence.set(self.device.create_fence(&vk::FenceCreateInfo::default().flags(vk::FenceCreateFlags::SIGNALED), None).unwrap());
                }
            }
        }
    }

    /// Gets the resources for the current frame.
    pub fn frame(&self) -> &Frame {
        &self.frames[self.frame_index.get()]
    }

    pub fn frame_wait_idle(&self, frame: &Frame) -> Result<()> {
        if frame.fence_signalled.get() {
            return Ok(());
        }
        unsafe {
            self.device.wait_for_fences(&[frame.fence.get()], true, u64::MAX)?;
            frame.fence_signalled.set(true);
            Ok(())
        }
    }

    /// Acquires the next available image from the swapchain for rendering. Recreates swapchain if necessary.
    pub fn acquire_swapchain_image(&self) -> Option<Image> {
        let mut borrow = self.presentation.borrow_mut();
        let p = match borrow.as_mut() {
            Some(p) => p,
            None => return None,
        };
        if p.invalid {
            drop(borrow);
            log::info!("Swapchain is invalid, recreating");
            self.recreate_swapchain();
            return None;
        }
        let frame = self.frame();
        self.frame_wait_idle(frame);

        let (image_index, suboptimal) = match unsafe {
            p.swapchain
                .device
                .acquire_next_image(p.swapchain.handle, u64::MAX, p.acquire_semaphores[self.frame_index.get()], vk::Fence::null())
        } {
            Ok((index, suboptimal)) => (index, suboptimal),
            Err(e) => {
                p.invalid = true;
                return None;
            }
        };
        p.suboptimal = p.suboptimal || suboptimal;
        p.image_acquired = true;
        p.image_index = image_index as usize;

        Some(p.swapchain.images[image_index as usize].clone())
    }

    pub fn debug_utils(&self) -> Option<&DebugUtils> {
        self.debug_utils.as_ref()
    }

    pub fn presentation(&self) -> Ref<'_, Option<Presentation>> {
        self.presentation.borrow()
    }

    pub fn is_image_acquired(&self) -> bool {
        self.presentation.borrow().as_ref().map(|p| p.image_acquired).unwrap_or(false)
    }

    pub fn get_swapchain_extent(&self) -> vk::Extent2D {
        self.presentation.borrow().as_ref().map(|p| p.swapchain.extent).unwrap_or_default()
    }

    /// Gets the current frame's command buffer where rendering commands should be recorded.
    pub fn get_cmd_buffer(&self) -> vk::CommandBuffer {
        self.frame().active_cmd.get()
    }

    /// Records commands to the current frame's command buffer via a closure.
    pub fn record(&self, record_fn: impl FnOnce(&ash::Device, vk::CommandBuffer)) {
        let cmd = self.get_cmd_buffer();
        record_fn(&self.device, cmd);
    }

    /// Submits the current frame's command buffer to the graphics queue and advances to the next frame.
    pub fn submit(&self) -> Result<()> {
        unsafe {
            let frame = self.frame();

            self.frame_wait_idle(frame);
            self.device.reset_fences(&[frame.fence.get()])?;
            frame.fence_signalled.set(false);

            frame.belt.borrow_mut().reset();
            self.device.end_command_buffer(frame.active_cmd.get()).unwrap();

            let pborrow = self.presentation.borrow();
            let p = pborrow.as_ref();
            let cmd_buffers = [frame.active_cmd.get()];
            let wait_semaphores = self.is_image_acquired().then(|| p.map(|p| p.acquire_semaphores[self.frame_index.get()]).unwrap());
            let signal_semaphores = self.is_image_acquired().then(|| p.map(|p| p.present_semaphores[p.image_index]).unwrap());

            let mut submit_info = vk::SubmitInfo::default()
                .command_buffers(&cmd_buffers)
                .wait_dst_stage_mask(&[vk::PipelineStageFlags::ALL_COMMANDS])
                .wait_semaphores(wait_semaphores.as_slice())
                .signal_semaphores(signal_semaphores.as_slice());

            self.device.queue_submit(self.graphics_queue, &[submit_info], frame.fence.get())?;

            self.device.reset_command_buffer(frame.used_cmd.get(), vk::CommandBufferResetFlags::empty())?;
            frame.active_cmd.swap(&frame.used_cmd);
            self.device.begin_command_buffer(
                frame.active_cmd.get(),
                &vk::CommandBufferBeginInfo::default().flags(vk::CommandBufferUsageFlags::ONE_TIME_SUBMIT),
            )?;

            self.frame_index.set((self.frame_index.get() + 1) % self.frames.len());
            Result::Ok(())
        }
    }

    /// Blocks until the graphics queue goes idle.
    pub fn wait_queue(&self) -> Result<()> {
        unsafe { Ok(self.device.queue_wait_idle(self.graphics_queue)?) }
    }

    /// Blocks until the device goes idle
    pub fn wait_device(&self) -> Result<()> {
        unsafe { Ok(self.device.device_wait_idle()?) }
    }

    /// Submits the current frame and waits for it to complete.
    pub fn submit_wait(&self) -> Result<()> {
        self.submit()?;
        self.wait_queue()
    }

    /// Presents the last rendered frame to the swapchain.
    pub fn present(&self) -> Result<()> {
        if let Some(p) = self.presentation.borrow_mut().as_mut() {
            let image_index = p.image_index;
            let result = unsafe {
                p.swapchain.device.queue_present(
                    self.present_queue,
                    &vk::PresentInfoKHR::default()
                        .wait_semaphores(&[p.present_semaphores[image_index]])
                        .swapchains(&[p.swapchain.handle])
                        .image_indices(&[image_index as u32]),
                )
            };
            p.image_acquired = false;
            match result {
                Ok(suboptimal) => {
                    p.suboptimal = p.suboptimal || suboptimal;
                }
                Err(e) => {
                    match e {
                        vk::Result::ERROR_OUT_OF_DATE_KHR | vk::Result::ERROR_SURFACE_LOST_KHR | vk::Result::ERROR_NATIVE_WINDOW_IN_USE_KHR => {
                            log::warn!("Surface lost during presentation");
                            p.invalid = true;
                        }
                        _ => {}
                    }
                    anyhow::bail!("Failed to present swapchain image: {}", e)
                }
            }
        }
        Result::Ok(())
    }

    pub fn read_buffer(&self, buffer: &Buffer, data: &mut [u8], offset: u64) -> Result<()> {
        let (staging_buffer, ptr) = self.frame().belt.borrow_mut().download(self, data.len() as u64)?;
        self.copy_buffer(
            buffer,
            &staging_buffer,
            &[vk::BufferCopy {
                src_offset: offset,
                dst_offset: 0,
                size: data.len() as u64,
            }],
        );
        self.submit_wait()?;
        let read = unsafe { std::slice::from_raw_parts(ptr, data.len()) };
        data.copy_from_slice(read);
        Result::Ok(())
    }

    pub fn read_image(
        &self,
        image: &Image,
        data: &mut [u8],
        offset: vk::Offset3D,
        extent: vk::Extent3D,
        bytes_per_pixel: u64,
        subresource: vk::ImageSubresourceLayers,
    ) -> Result<()> {
        let size = extent.width as u64 * extent.height as u64 * extent.depth as u64 * bytes_per_pixel * subresource.layer_count as u64;
        if size != data.len() as u64 {
            return Err(anyhow::anyhow!("Data buffer size does not match image region size"));
        }
        let (staging_buffer, ptr) = self.frame().belt.borrow_mut().download(self, size)?;

        self.record(|dev, cmd| unsafe {
            let prev = self.barrier_image(cmd, image, vk::ImageLayout::TRANSFER_SRC_OPTIMAL);
            dev.cmd_copy_image_to_buffer(
                cmd,
                image.handle,
                vk::ImageLayout::TRANSFER_SRC_OPTIMAL,
                staging_buffer.handle,
                &[vk::BufferImageCopy::default()
                    .image_offset(offset)
                    .image_extent(vk::Extent3D {
                        width: extent.width,
                        height: extent.height,
                        depth: extent.depth,
                    })
                    .image_subresource(subresource)],
            );
            self.barrier_image(cmd, image, prev);
        });
        let read = unsafe { std::slice::from_raw_parts(ptr, data.len()) };
        self.submit_wait()?;
        data.copy_from_slice(read);
        Result::Ok(())
    }

    pub fn write_buffer<T>(&self, buffer: &Buffer, data: &[T], offset: u64) -> Result<()> {
        let (staging_buf, cursor, size) = self.frame().belt.borrow_mut().upload(self, bytes_of(data))?;
        self.record(|dev, cmd| unsafe {
            dev.cmd_copy_buffer(
                cmd,
                staging_buf.handle,
                buffer.handle,
                &[vk::BufferCopy::default().src_offset(cursor).dst_offset(offset).size(size)],
            );
            self.barrier(cmd, vk::PipelineStageFlags::TRANSFER, vk::PipelineStageFlags::ALL_COMMANDS);
        });
        Result::Ok(())
    }

    pub fn write_image<T>(
        &self,
        image: &Image,
        data: &[T],
        offset: vk::Offset3D,
        extent: vk::Extent3D,
        subresource: vk::ImageSubresourceLayers,
        new_layout: Option<vk::ImageLayout>,
    ) -> Result<()> {
        let (staging_buf, cursor, size) = self.frame().belt.borrow_mut().upload(self, bytes_of(data))?;
        self.record(|dev, cmd| unsafe {
            let prev = self.barrier_image(cmd, image, vk::ImageLayout::TRANSFER_DST_OPTIMAL);
            dev.cmd_copy_buffer_to_image(
                cmd,
                staging_buf.handle,
                image.handle,
                vk::ImageLayout::TRANSFER_DST_OPTIMAL,
                &[vk::BufferImageCopy::default()
                    .buffer_offset(cursor)
                    .image_subresource(subresource)
                    .image_offset(offset)
                    .image_extent(extent)],
            );
            self.barrier_image(cmd, image, new_layout.unwrap_or(prev));
        });
        Result::Ok(())
    }

    pub fn init_image<T>(&self, image: &Image, data: &[T]) {
        self.write_image(
            image,
            data,
            vk::Offset3D::default(),
            image.extent,
            vk::ImageSubresourceLayers::default().aspect_mask(image.aspect).layer_count(1),
            Some(if image.usage.contains(vk::ImageUsageFlags::STORAGE) {
                vk::ImageLayout::GENERAL
            } else {
                vk::ImageLayout::SHADER_READ_ONLY_OPTIMAL
            }),
        );
    }

    pub fn copy_buffer(&self, src_buf: &Buffer, dst_buf: &Buffer, regions: &[vk::BufferCopy]) {
        self.record(|dev, cmd| unsafe {
            self.barrier(cmd, vk::PipelineStageFlags::ALL_COMMANDS, vk::PipelineStageFlags::TRANSFER);
            dev.cmd_copy_buffer(cmd, src_buf.handle, dst_buf.handle, regions);
            self.barrier(cmd, vk::PipelineStageFlags::TRANSFER, vk::PipelineStageFlags::ALL_COMMANDS);
        });
    }

    pub fn copy_image(&self, src_img: &Image, dst_img: &Image, regions: &[vk::ImageCopy]) {
        self.record(|dev, cmd| unsafe {
            let prev1 = self.barrier_image(cmd, src_img, vk::ImageLayout::TRANSFER_SRC_OPTIMAL);
            let prev2 = self.barrier_image(cmd, dst_img, vk::ImageLayout::TRANSFER_DST_OPTIMAL);

            dev.cmd_copy_image(
                cmd,
                src_img.handle,
                vk::ImageLayout::TRANSFER_SRC_OPTIMAL,
                dst_img.handle,
                vk::ImageLayout::TRANSFER_DST_OPTIMAL,
                regions,
            );

            self.barrier_image(cmd, src_img, prev1);
            self.barrier_image(cmd, dst_img, prev2);
        });
    }

    pub fn copy_buffer_image(&self, src_buf: &Buffer, dst_img: &Image, regions: &[vk::BufferImageCopy]) {
        self.record(|dev, cmd| unsafe {
            self.barrier(cmd, vk::PipelineStageFlags::ALL_COMMANDS, vk::PipelineStageFlags::TRANSFER);
            let prev = self.barrier_image(cmd, dst_img, vk::ImageLayout::TRANSFER_DST_OPTIMAL);
            dev.cmd_copy_buffer_to_image(cmd, src_buf.handle, dst_img.handle, vk::ImageLayout::TRANSFER_DST_OPTIMAL, regions);
            self.barrier_image(cmd, dst_img, prev);
            self.barrier(cmd, vk::PipelineStageFlags::TRANSFER, vk::PipelineStageFlags::ALL_COMMANDS);
        });
    }

    pub fn copy_image_buffer(&self, src_img: &Image, dst_buf: &Buffer, regions: &[vk::BufferImageCopy]) {
        self.record(|dev, cmd| unsafe {
            self.barrier(cmd, vk::PipelineStageFlags::ALL_COMMANDS, vk::PipelineStageFlags::TRANSFER);
            let prev = self.barrier_image(cmd, src_img, vk::ImageLayout::TRANSFER_SRC_OPTIMAL);
            dev.cmd_copy_image_to_buffer(cmd, src_img.handle, vk::ImageLayout::TRANSFER_SRC_OPTIMAL, dst_buf.handle, regions);
            self.barrier_image(cmd, src_img, prev);
            self.barrier(cmd, vk::PipelineStageFlags::TRANSFER, vk::PipelineStageFlags::ALL_COMMANDS);
        });
    }

    pub fn fill_buffer(&self, buffer: &Buffer, clear_value: u32, offset: u64, size: u64) {
        self.record(|dev, cmd| unsafe {
            self.barrier(cmd, vk::PipelineStageFlags::ALL_COMMANDS, vk::PipelineStageFlags::TRANSFER);
            dev.cmd_fill_buffer(cmd, buffer.handle, offset, size, clear_value);
            self.barrier(cmd, vk::PipelineStageFlags::TRANSFER, vk::PipelineStageFlags::ALL_COMMANDS);
        });
    }

    pub fn clear_color_image(&self, image: &Image, color: vk::ClearColorValue, range: vk::ImageSubresourceRange) {
        self.record(|dev, cmd| unsafe {
            let prev = self.barrier_image(cmd, image, vk::ImageLayout::TRANSFER_DST_OPTIMAL);
            dev.cmd_clear_color_image(cmd, image.handle, vk::ImageLayout::TRANSFER_DST_OPTIMAL, &color, &[range]);
            self.barrier_image(cmd, image, prev);
        });
    }
}

impl Drop for RenderingDeviceImpl {
    fn drop(&mut self) {
        unsafe {
            self.device.device_wait_idle().unwrap();
            log::info!("Destroying device");
            if let Some(debug_utils) = &self.debug_utils {
                debug_utils.instance.destroy_debug_utils_messenger(debug_utils.messenger, None);
            }

            for frame in self.frames.iter() {
                self.device.destroy_fence(frame.fence.get(), None);
                self.device.destroy_command_pool(frame.cmd_pool, None);

                for chunk in frame.belt.borrow_mut().active_chunks.iter_mut() {
                    Rc::get_mut(&mut chunk.buffer).unwrap().destroy(self);
                }
                if let Some(mut readback) = frame.belt.borrow_mut().readback_buffer.take() {
                    Rc::get_mut(&mut readback).unwrap().destroy(self);
                }
            }
            if let Some(p) = self.presentation.borrow_mut().as_mut() {
                for &sem in p.acquire_semaphores.iter() {
                    self.device.destroy_semaphore(sem, None);
                }
                for &sem in p.present_semaphores.iter() {
                    self.device.destroy_semaphore(sem, None);
                }
                for image in p.swapchain.images.iter() {
                    for view in image.views.borrow().values() {
                        self.device.destroy_image_view(view.handle, None);
                    }
                }
                p.swapchain.device.destroy_swapchain(p.swapchain.handle, None);
                p.surface.instance.destroy_surface(p.surface.handle, None);
            }
            ManuallyDrop::drop(&mut self.allocator);
            self.device.destroy_device(None);
            self.instance.destroy_instance(None);
        }
    }
}

/// Handles Vulkan debug callbacks and messenger.
pub struct DebugUtils {
    pub instance: debug_utils::Instance,
    pub device: debug_utils::Device,
    pub messenger: vk::DebugUtilsMessengerEXT,
}

pub fn make_debug_utils(instance: &ash::Instance, device: &ash::Device) -> Result<DebugUtils> {
    unsafe {
        let debug_inst = debug_utils::Instance::new(&ENTRY, instance);
        let debug_dev = debug_utils::Device::new(instance, device);
        let messenger = debug_inst.create_debug_utils_messenger(
            &vk::DebugUtilsMessengerCreateInfoEXT::default()
                .message_severity(vk::DebugUtilsMessageSeverityFlagsEXT::ERROR | vk::DebugUtilsMessageSeverityFlagsEXT::WARNING | vk::DebugUtilsMessageSeverityFlagsEXT::INFO)
                .message_type(vk::DebugUtilsMessageTypeFlagsEXT::GENERAL | vk::DebugUtilsMessageTypeFlagsEXT::VALIDATION | vk::DebugUtilsMessageTypeFlagsEXT::PERFORMANCE)
                .pfn_user_callback(Some(self::vulkan_debug_callback)),
            None,
        )?;
        Result::Ok(DebugUtils {
            instance: debug_inst,
            device: debug_dev,
            messenger,
        })
    }
}

pub extern "system" fn vulkan_debug_callback(
    message_severity: vk::DebugUtilsMessageSeverityFlagsEXT,
    message_types: vk::DebugUtilsMessageTypeFlagsEXT,
    p_callback_data: *const vk::DebugUtilsMessengerCallbackDataEXT,
    _p_user_data: *mut std::ffi::c_void,
) -> vk::Bool32 {
    let message = unsafe { CStr::from_ptr((*p_callback_data).p_message) };
    log::error!("[{:?} {:?}] {:?}", message_severity, message_types, message);
    vk::FALSE
}