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
use ash::vk;
use crate::buffer::StagingBuffer;
use crate::vk_engine::VulkanEngine;
use ash::vk::{ImageLayout, ImageMemoryBarrier};
use ash::Device;
/// A Texture struct. Holds a vk::Image and information about its format, extent and number of layers.
pub struct Texture {
pub format: vk::Format,
pub image: vk::Image,
pub extent: vk::Extent3D,
pub num_array_layers: u32,
}
/// Utility function for copying the content of a buffer to an image.
/// The copy command is issued to the given command buffer.
/// # Safety
/// The image has to be in a format suitable for a transfer.
/// Access to the image must be synchronized properly.
pub unsafe fn copy_buffer_to_image(
device: &Device,
command_buffer: vk::CommandBuffer,
image_staging_buffer: vk::Buffer,
image: vk::Image,
image_extent: vk::Extent3D,
num_array_layers: u32,
) {
// compare with https://github.com/SaschaWillems/Vulkan/blob/master/examples/texturearray/texturearray.cpp#L161
device.cmd_copy_buffer_to_image(
command_buffer,
image_staging_buffer,
image,
vk::ImageLayout::TRANSFER_DST_OPTIMAL,
&[vk::BufferImageCopy {
buffer_offset: 0,
buffer_row_length: 0,
buffer_image_height: 0,
image_subresource: vk::ImageSubresourceLayers {
aspect_mask: vk::ImageAspectFlags::COLOR,
mip_level: 0,
base_array_layer: 0,
layer_count: num_array_layers,
},
image_offset: vk::Offset3D::default(),
image_extent,
}],
);
}
/// Utility function for transitioning the layout of the given images using a pipeline barrier.
/// # Safety
/// Pipeline barrier requirements must be met.
unsafe fn transition_layout(
device: &Device,
command_buffer: vk::CommandBuffer,
image_memory_barriers: &[ImageMemoryBarrier],
src_stage_mask: vk::PipelineStageFlags,
dst_stage_mask: vk::PipelineStageFlags,
) {
device.cmd_pipeline_barrier(
command_buffer,
src_stage_mask,
dst_stage_mask,
vk::DependencyFlags::empty(),
&[],
&[],
image_memory_barriers,
);
}
impl Texture {
/// Create a new texture.
/// # Safety
/// Device must be valid.
pub unsafe fn new(
vk_engine: &VulkanEngine,
format: vk::Format,
image_type: vk::ImageType,
extent: vk::Extent3D,
num_array_layers: u32,
) -> Result<Self, vk::Result> {
let image = vk_engine.device.create_image(
&vk::ImageCreateInfo::builder()
.image_type(image_type)
.format(format)
.extent(extent)
.usage(vk::ImageUsageFlags::SAMPLED | vk::ImageUsageFlags::TRANSFER_DST)
.tiling(vk::ImageTiling::OPTIMAL)
.samples(vk::SampleCountFlags::TYPE_1)
.mip_levels(1)
.array_layers(num_array_layers)
.sharing_mode(vk::SharingMode::EXCLUSIVE)
.build(),
None,
)?;
Ok(Self {
format,
image,
extent,
num_array_layers,
})
}
/// Get the memory requirements for this texture.
/// # Safety
/// Device and image must be valid.
pub unsafe fn get_memory_requirements(&self, device: &Device) -> vk::MemoryRequirements {
device.get_image_memory_requirements(self.image)
}
/// Bind the given memory to this texture.
/// # Safety
/// Device and memory region must be valid.
pub unsafe fn bind_memory(
&mut self,
vk_engine: &VulkanEngine,
memory: vk::DeviceMemory,
offset: vk::DeviceSize,
) -> Result<(), vk::Result> {
vk_engine
.device
.bind_image_memory(self.image, memory, offset)
}
/// Create an image memory barrier for the image resource held by `self`.
pub fn get_transition_layout_image_memory_barrier(
&self,
src_access_mask: vk::AccessFlags,
dst_access_mask: vk::AccessFlags,
old_layout: vk::ImageLayout,
new_layout: vk::ImageLayout,
) -> vk::ImageMemoryBarrier {
vk::ImageMemoryBarrier::builder()
.src_access_mask(src_access_mask)
.dst_access_mask(dst_access_mask)
.old_layout(old_layout)
.new_layout(new_layout)
.image(self.image)
.subresource_range(
vk::ImageSubresourceRange::builder()
.aspect_mask(vk::ImageAspectFlags::COLOR)
.base_mip_level(0)
.level_count(1)
.base_array_layer(0)
.layer_count(self.num_array_layers)
.build(),
)
.build()
}
/// Utility method for copying data from a staging buffer to `self`.
/// Performs a layout transition before and after copying with a single-use command buffer (using VulkanEngine::one_time_submit).
/// Assumes that the image will be used only as a sample source in a fragment shader.
/// This will use one pipeline barrier for every call.
/// When dealing with many images, a manual implementation may be beneficial for performance
/// by reducing the number of pipeline barriers
///
/// # Safety
/// Must be called on the thread able to submit command buffers to the given command pool.
/// The default values for synchronization used must match the actual usage of the buffer and
/// image; otherwise, race conditions on the device may occur.
pub unsafe fn copy_staging_to_image<T: Copy>(
&mut self,
vk_engine: &VulkanEngine,
command_pool: vk::CommandPool,
image_staging_buffer: &StagingBuffer<T>,
) {
vk_engine.one_time_submit(command_pool, |command_buffer| {
let barrier = self.get_transition_layout_image_memory_barrier(
vk::AccessFlags::empty(),
vk::AccessFlags::TRANSFER_WRITE,
ImageLayout::UNDEFINED,
ImageLayout::TRANSFER_DST_OPTIMAL,
);
transition_layout(
&vk_engine.device,
command_buffer,
&[barrier],
vk::PipelineStageFlags::TOP_OF_PIPE,
vk::PipelineStageFlags::TRANSFER,
);
// Copy buffer to image
copy_buffer_to_image(
&vk_engine.device,
command_buffer,
image_staging_buffer.buffer.buffer,
self.image,
self.extent,
self.num_array_layers,
);
let barrier = self.get_transition_layout_image_memory_barrier(
vk::AccessFlags::TRANSFER_WRITE,
vk::AccessFlags::SHADER_READ,
ImageLayout::TRANSFER_DST_OPTIMAL,
ImageLayout::SHADER_READ_ONLY_OPTIMAL,
);
transition_layout(
&vk_engine.device,
command_buffer,
&[barrier],
vk::PipelineStageFlags::TRANSFER,
vk::PipelineStageFlags::FRAGMENT_SHADER,
);
});
}
/// Free the image resource held by `self`.
/// # Safety
/// Image must not be used anymore.
pub unsafe fn destroy(&mut self, device: &Device) {
device.destroy_image(self.image, None);
}
}