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
162
163
164
165
166
167

// dacho/src/renderer/images/image.rs

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

// crate
use crate::{
    renderer::{
        commands::CommandPool,
        devices::{Device, PhysicalDevice},
        setup::Instance,
        VulkanDrop
    },
    fatal
};

pub struct Image {
    pub raw:    vk::Image,
        memory: vk::DeviceMemory
}

impl Image {
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        device:          &Device,
        instance:        &Instance,
        physical_device: &PhysicalDevice,
        extent_2d:        vk::Extent2D,
        format:           vk::Format,
        usage:            vk::ImageUsageFlags,
        properties:       vk::MemoryPropertyFlags,
        samples:          vk::SampleCountFlags
    ) -> Result<Self> {
        let extent = vk::Extent3D::builder()
            .width(extent_2d.width)
            .height(extent_2d.height)
            .depth(1)
            .build();

        let create_info = vk::ImageCreateInfo::builder()
            .extent(extent)
            .format(format)
            .usage(usage)
            .image_type(vk::ImageType::TYPE_2D)
            .mip_levels(1)
            .array_layers(1)
            .tiling(vk::ImageTiling::OPTIMAL)
            .initial_layout(vk::ImageLayout::UNDEFINED)
            .samples(samples)
            .sharing_mode(vk::SharingMode::EXCLUSIVE);

        let raw = unsafe { device.raw.create_image(&create_info, None) }?;

        let memory_requirements = unsafe { device.raw.get_image_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);

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

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

        Ok(Self { raw, memory })
    }

    #[allow(dead_code)]
    pub fn transition_layout(
        &self,
        device:       &Device,
        command_pool: &CommandPool,
        old_layout:    vk::ImageLayout,
        new_layout:    vk::ImageLayout
    ) -> Result<()> {
        let command_buffer = command_pool.begin_single_time_commands(device)?;

        let (src_am, dst_am, src_stage, dst_stage) = match (old_layout, new_layout) {
            (vk::ImageLayout::UNDEFINED, vk::ImageLayout::TRANSFER_DST_OPTIMAL) => {
                (
                    vk::AccessFlags::empty(),
                    vk::AccessFlags::TRANSFER_WRITE,
                    vk::PipelineStageFlags::TOP_OF_PIPE,
                    vk::PipelineStageFlags::TRANSFER
                )
            },
            (vk::ImageLayout::TRANSFER_DST_OPTIMAL, vk::ImageLayout::SHADER_READ_ONLY_OPTIMAL) => {
                (
                    vk::AccessFlags::TRANSFER_WRITE,
                    vk::AccessFlags::SHADER_READ,
                    vk::PipelineStageFlags::TRANSFER,
                    vk::PipelineStageFlags::FRAGMENT_SHADER
                )
            },
            _ => { fatal!("Invalid vk::ImageLayout transition"); }
        };

        let subresource_range = vk::ImageSubresourceRange::builder()
            .aspect_mask(vk::ImageAspectFlags::COLOR)
            .base_mip_level(0)
            .level_count(1)
            .base_array_layer(0)
            .layer_count(1)
            .build();

        let barrier = vk::ImageMemoryBarrier::builder()
            .old_layout(old_layout)
            .new_layout(new_layout)
            .src_queue_family_index(vk::QUEUE_FAMILY_IGNORED)
            .dst_queue_family_index(vk::QUEUE_FAMILY_IGNORED)
            .image(self.raw)
            .subresource_range(subresource_range)
            .src_access_mask(src_am)
            .dst_access_mask(dst_am);

        unsafe {
            device.raw.cmd_pipeline_barrier(
                command_buffer,
                src_stage,
                dst_stage,
                vk::DependencyFlags::empty(),
                &[],
                &[],
                &[*barrier]
            );
        }

        command_pool.end_single_time_commands(device, command_buffer)?;

        Ok(())
    }
}

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