despero 0.1.0

Rusty game engine, using API Vulkan and implementing paradigm of ECS
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

use ash::vk;
use gpu_allocator::vulkan::*;
use gpu_allocator::MemoryLocation;

use crate::render::renderer::Renderer;
use crate::error::DesperoResult;

pub trait ScreenshotExt {
    fn screenshot(&mut self, path: &str) -> DesperoResult<()>;
}

impl ScreenshotExt for Renderer {
    fn screenshot(&mut self, path: &str) -> DesperoResult<()> {
        // Create CommandBuffer
        let commandbuf_allocate_info = vk::CommandBufferAllocateInfo::builder()
            .command_pool(self.commandbuffer_pools.commandpool_graphics)
            .command_buffer_count(1);
        let copybuffer = unsafe {
            self.device.allocate_command_buffers(&commandbuf_allocate_info)
        }.unwrap()[0];
        // Begin CommandBuffer
        let cmd_begin_info = vk::CommandBufferBeginInfo::builder()
            .flags(vk::CommandBufferUsageFlags::ONE_TIME_SUBMIT);
        unsafe { self.device.begin_command_buffer(copybuffer, &cmd_begin_info) }?;
        
        // Create Image to store
        let ici = vk::ImageCreateInfo::builder()
            .format(vk::Format::R8G8B8A8_UNORM)
            .image_type(vk::ImageType::TYPE_2D)
            .extent(vk::Extent3D {
                width: self.swapchain.extent.width,
                height: self.swapchain.extent.height,
                depth: 1,
            })
            .array_layers(1)
            .mip_levels(1)
            .samples(vk::SampleCountFlags::TYPE_1)
            .tiling(vk::ImageTiling::LINEAR)
            .usage(vk::ImageUsageFlags::TRANSFER_DST)
            .initial_layout(vk::ImageLayout::UNDEFINED);
        let image = unsafe { 
            self.device.create_image(&ici, None)
        }.unwrap();
        
        // Image allocation
        //
        // Image memory requirements
        let requirements = unsafe { self.device.get_image_memory_requirements(image) };
        // Allocation info
        let allocation_info = &AllocationCreateDesc {
            name: "Screenshot allocation",
            requirements,
            location: MemoryLocation::GpuToCpu,
            linear: true,
        };
        // Create memory allocation
        let allocation = (*self.allocator.lock().unwrap()).allocate(allocation_info).unwrap();
        // Bind memory allocation to image
        unsafe { self.device.bind_image_memory(
            image,
            allocation.memory(), 
            allocation.offset())
        }.unwrap();
        
        // ImageMemoryBarrier
        let barrier = vk::ImageMemoryBarrier::builder()
            .image(image)
            .src_access_mask(vk::AccessFlags::empty())
            .dst_access_mask(vk::AccessFlags::TRANSFER_WRITE)
            .old_layout(vk::ImageLayout::UNDEFINED)
            .new_layout(vk::ImageLayout::TRANSFER_DST_OPTIMAL)
            .subresource_range(vk::ImageSubresourceRange {
                aspect_mask: vk::ImageAspectFlags::COLOR,
                base_mip_level: 0,
                level_count: 1,
                base_array_layer: 0,
                layer_count: 1,
            })
            .build();
        // Bind IMB to CommandBuffer
        unsafe {
            self.device.cmd_pipeline_barrier(
                copybuffer,
                vk::PipelineStageFlags::TRANSFER,
                vk::PipelineStageFlags::TRANSFER,
                vk::DependencyFlags::empty(),
                &[],
                &[],
                &[barrier],
            )
        };
        
        // Layout transition
        let source_image = self.swapchain.images[self.swapchain.current_image];
        let barrier = vk::ImageMemoryBarrier::builder()
            .image(source_image)
            .src_access_mask(vk::AccessFlags::MEMORY_READ)
            .dst_access_mask(vk::AccessFlags::TRANSFER_READ)
            .old_layout(vk::ImageLayout::PRESENT_SRC_KHR)
            .new_layout(vk::ImageLayout::TRANSFER_SRC_OPTIMAL)
            .subresource_range(vk::ImageSubresourceRange {
                aspect_mask: vk::ImageAspectFlags::COLOR,
                base_mip_level: 0,
                level_count: 1,
                base_array_layer: 0,
                layer_count: 1,
            })
            .build();
        unsafe {
            self.device.cmd_pipeline_barrier(
                copybuffer,
                vk::PipelineStageFlags::TRANSFER,
                vk::PipelineStageFlags::TRANSFER,
                vk::DependencyFlags::empty(),
                &[],
                &[],
                &[barrier],
            )
        };
        
        // Copying
        //
        // Copying description
        let copy_area = vk::ImageCopy::builder()
            .src_subresource(vk::ImageSubresourceLayers {
                aspect_mask: vk::ImageAspectFlags::COLOR,
                mip_level: 0,
                base_array_layer: 0,
                layer_count: 1,
            })
            .src_offset(vk::Offset3D::default())
            .dst_subresource(vk::ImageSubresourceLayers {
                aspect_mask: vk::ImageAspectFlags::COLOR,
                mip_level: 0,
                base_array_layer: 0,
                layer_count: 1,
            })
            .dst_offset(vk::Offset3D::default())
            .extent(vk::Extent3D {
                width: self.swapchain.extent.width,
                height: self.swapchain.extent.height,
                depth: 1,
            })
            .build();
        // Copy Command
        unsafe {
            self.device.cmd_copy_image(
                copybuffer,
                source_image,
                vk::ImageLayout::TRANSFER_SRC_OPTIMAL,
                image,
                vk::ImageLayout::TRANSFER_DST_OPTIMAL,
                &[copy_area],
            )
        };
        
        // Next layout (to read)
        let barrier = vk::ImageMemoryBarrier::builder()
            .image(image)
            .src_access_mask(vk::AccessFlags::TRANSFER_WRITE)
            .dst_access_mask(vk::AccessFlags::MEMORY_READ)
            .old_layout(vk::ImageLayout::TRANSFER_DST_OPTIMAL)
            .new_layout(vk::ImageLayout::GENERAL)
            .subresource_range(vk::ImageSubresourceRange {
                aspect_mask: vk::ImageAspectFlags::COLOR,
                base_mip_level: 0,
                level_count: 1,
                base_array_layer: 0,
                layer_count: 1,
            })
            .build();
        unsafe {
            self.device.cmd_pipeline_barrier(
                copybuffer,
                vk::PipelineStageFlags::TRANSFER,
                vk::PipelineStageFlags::TRANSFER,
                vk::DependencyFlags::empty(),
                &[],
                &[],
                &[barrier],
            )
        };
        
        // Turn back `source_image` layout
        let barrier = vk::ImageMemoryBarrier::builder()
            .image(source_image)
            .src_access_mask(vk::AccessFlags::TRANSFER_READ)
            .dst_access_mask(vk::AccessFlags::MEMORY_READ)
            .old_layout(vk::ImageLayout::TRANSFER_SRC_OPTIMAL)
            .new_layout(vk::ImageLayout::PRESENT_SRC_KHR)
            .subresource_range(vk::ImageSubresourceRange {
                aspect_mask: vk::ImageAspectFlags::COLOR,
                base_mip_level: 0,
                level_count: 1,
                base_array_layer: 0,
                layer_count: 1,
            })
            .build();
        unsafe {
            self.device.cmd_pipeline_barrier(
                copybuffer,
                vk::PipelineStageFlags::TRANSFER,
                vk::PipelineStageFlags::TRANSFER,
                vk::DependencyFlags::empty(),
                &[],
                &[],
                &[barrier],
            )
        };
        // End CommandBuffer
        unsafe { self.device.end_command_buffer(copybuffer) }?;
        
        // Submit CommandBuffer
        //
        // Submit info
        let submit_infos = [
            vk::SubmitInfo::builder()
                .command_buffers(&[copybuffer])
                .build()
        ];
        // Create fence (to wait until CommandBuffer is finished)
        let fence = unsafe {
            self.device.create_fence(&vk::FenceCreateInfo::default(), None)
        }?;
        // Submit
        unsafe { self.device.queue_submit(
            self.queue_families.graphics_queue, 
            &submit_infos, 
            fence
        )? };
        // Wait for fences
        unsafe { self.device.wait_for_fences(&[fence], true, std::u64::MAX) }?;
        
        // Remove CommandBuffer and Fence
        unsafe { self.device.destroy_fence(fence, None) };
        unsafe {
            self.device.free_command_buffers(
                self.commandbuffer_pools.commandpool_graphics, 
                &[copybuffer]
            )
        };
        
        // Save Image
        //
        // Pointer to image
        let source_ptr = allocation.mapped_ptr().unwrap().as_ptr() as *mut u8;
        // Size of the image in bytes (usize)
        let image_size = unsafe {
            self.device.get_image_subresource_layout(
                image,
                vk::ImageSubresource {
                    aspect_mask: vk::ImageAspectFlags::COLOR,
                    mip_level: 0,
                    array_layer: 0,
                },
            ).size as usize
        };
        // Image to bytes
        let mut data = Vec::<u8>::with_capacity(image_size);
        unsafe {
            std::ptr::copy(
                source_ptr,
                data.as_mut_ptr(),
                image_size,
            );
            data.set_len(image_size);
        }
        let data = bgra_to_rgba(&data);
        // Destroy VulkanImage
        (*self.allocator.lock().unwrap()).free(allocation)?;
        unsafe { self.device.destroy_image(image, None); }
        // Create ImageBuffer
        let screen: image::ImageBuffer<image::Rgba<u8>, _> = image::ImageBuffer::from_raw(
            self.swapchain.extent.width,
            self.swapchain.extent.height,
            data,
        )
        .expect("Failed create ImageBuffer");
        // Save image
        let screen_image = image::DynamicImage::ImageRgba8(screen);
        screen_image.save(path)?;        
        
        Ok(())
    }
}

fn bgra_to_rgba(data: &Vec<u8>) -> Vec<u8> {
    let mut rgba: Vec<u8> = data.clone();
    for mut i in 0..data.len()/4 {
        i = i*4;
        rgba[i]   = data[i+2];
        rgba[i+1] = data[i+1];
        rgba[i+2] = data[i];
        rgba[i+3] = data[i+3];
    }
    return rgba;
}