dacho 0.2.0

ECS Game Engine
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

// dacho/src/renderer/buffers/mod.rs

// modules
mod index;
mod staging;
mod vertex;

#[allow(clippy::wildcard_imports)]
pub(super) use {index::*, staging::*, vertex::*};

// crates
use {
    anyhow::Result,
    ash::vk
};

// super
use super::{
    commands::CommandPool,
    devices::{Device, PhysicalDevice},
    images::Image,
    setup::Instance,
    VulkanDrop
};

// crate
use crate::fatal;

#[derive(Hash)]
pub struct Buffer {
    pub raw:    vk::Buffer,
    pub memory: vk::DeviceMemory
}

impl Buffer {
    pub fn new(
        instance:        &Instance,
        physical_device: &PhysicalDevice,
        device:          &Device,
        size:             vk::DeviceSize,
        usage:            vk::BufferUsageFlags,
        properties:       vk::MemoryPropertyFlags
    ) -> Result<Self> {
        let raw = {
            let create_info = vk::BufferCreateInfo::builder()
                .size(size)
                .usage(usage)
                .sharing_mode(vk::SharingMode::EXCLUSIVE);

            unsafe { device.raw.create_buffer(&create_info, None) }?
        };

        let memory = {
            let memory_requirements = unsafe { device.raw.get_buffer_memory_requirements(raw) };
            let memory_properties   = unsafe { instance.raw.get_physical_device_memory_properties(physical_device.raw) };

            let memory_type_index = {
                let mut found  = false;
                let mut result = 0;

                for i in 0..memory_properties.memory_type_count {
                    let req = (memory_requirements.memory_type_bits & (1 << i)) != 0;
                    let mem = (memory_properties.memory_types[i as usize].property_flags & properties) == properties;

                    if req && mem {
                        found  = true;
                        result = i;
                        break;
                    }
                }

                if !found {
                    fatal!("Failed to find a suitable memory type");
                }

                result
            };

            let allocate_info = vk::MemoryAllocateInfo::builder()
                .allocation_size(memory_requirements.size)
                .memory_type_index(memory_type_index);

            unsafe { device.raw.allocate_memory(&allocate_info, None) }?
        };

        unsafe { device.raw.bind_buffer_memory(raw, memory, 0) }?;

        Ok(Self { raw, memory })
    }

    pub fn copy(
        device:       &Device,
        command_pool: &CommandPool,
        src_buffer:   &Self,
        dst_buffer:   &Self,
        size:          vk::DeviceSize
    ) -> Result<()> {
        let command_buffer = command_pool.begin_single_time_commands(device)?;

        {
            let copy_region = vk::BufferCopy::builder().size(size);

            unsafe { device.raw.cmd_copy_buffer(command_buffer, src_buffer.raw, dst_buffer.raw, &[*copy_region]); }
        }

        command_pool.end_single_time_commands(device, command_buffer)?;

        Ok(())
    }

    #[allow(dead_code)]
    pub fn copy_to_image(
        &self,
        device:       &Device,
        command_pool: &CommandPool,
        image:        &Image,
        width:         u32,
        height:        u32
    ) -> Result<()> {
        let command_buffer = command_pool.begin_single_time_commands(device)?;

        let subresource_range = vk::ImageSubresourceLayers::builder()
            .aspect_mask(vk::ImageAspectFlags::COLOR)
            .mip_level(0)
            .base_array_layer(0)
            .layer_count(1)
            .build();

        let region = vk::BufferImageCopy::builder()
            .buffer_offset(0)
            .buffer_row_length(0)
            .buffer_image_height(0)
            .image_subresource(subresource_range)
            .image_offset(vk::Offset3D { x: 0,  y: 0,   z:     0 })
            .image_extent(vk::Extent3D { width, height, depth: 1 });

        unsafe {
            device.raw.cmd_copy_buffer_to_image(
                command_buffer,
                self.raw,
                image.raw,
                vk::ImageLayout::TRANSFER_DST_OPTIMAL,
                &[*region]
            );
        }

        command_pool.end_single_time_commands(device, command_buffer)?;

        Ok(())
    }
}

impl VulkanDrop for Buffer {
    fn drop(&self, device: &Device) {
        unsafe {
            device.raw.destroy_buffer(self.raw, None);
            device.raw.free_memory(self.memory, None);
        }
    }
}