vulk-ext 0.1.18

Vulkan bindings for Rust, except only the bleeding edge features
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
use super::*;

//
// Buffers
//

#[derive(Clone, Copy, Debug)]
pub struct BufferAllocation {
    address: vk::DeviceAddress,
    size: vk::DeviceSize,
    ptr: Option<*mut c_void>,
}

impl BufferAllocation {
    #[must_use]
    pub fn device_address(&self) -> vk::DeviceAddress {
        self.address
    }

    #[must_use]
    pub fn size(&self) -> vk::DeviceSize {
        self.size
    }

    #[must_use]
    pub fn as_ptr<T>(&self) -> *const T {
        if let Some(ptr) = self.ptr {
            ptr.cast()
        } else {
            null()
        }
    }

    #[must_use]
    pub fn as_mut_ptr<T>(&self) -> *mut T {
        if let Some(ptr) = self.ptr {
            ptr.cast()
        } else {
            null_mut()
        }
    }

    #[must_use]
    pub unsafe fn as_slice<T>(&self, len: usize) -> &[T] {
        if let Some(ptr) = self.ptr {
            std::slice::from_raw_parts(ptr.cast(), len)
        } else {
            &[]
        }
    }

    #[must_use]
    pub unsafe fn as_mut_slice<T>(&mut self, len: usize) -> &mut [T] {
        if let Some(ptr) = self.ptr {
            std::slice::from_raw_parts_mut(ptr.cast(), len)
        } else {
            &mut []
        }
    }
}

#[derive(Debug)]
pub struct BufferAllocations {
    memory: vk::DeviceMemory,
    allocations: Vec<BufferAllocation>,
}

impl BufferAllocations {
    pub unsafe fn allocate(
        physical_device: &PhysicalDevice,
        device: &Device,
        buffers: &[vk::Buffer],
        buffer_create_infos: &[vk::BufferCreateInfo],
        property_flags: impl Into<vk::MemoryPropertyFlags> + Copy,
    ) -> Result<Self> {
        // Validation.
        ensure!(!buffers.is_empty());
        ensure!(!buffer_create_infos.is_empty());
        ensure!(buffers.len() == buffer_create_infos.len());
        ensure!(buffer_create_infos
            .iter()
            .all(|info| info.s_type == vk::StructureType::BufferCreateInfo));
        ensure!(buffer_create_infos.iter().all(|info| info.p_next.is_null()));
        ensure!(buffer_create_infos
            .iter()
            .all(|info| info.flags == vk::BufferCreateFlags::empty()));
        ensure!(buffer_create_infos.iter().all(|info| info.size > 0));
        ensure!(buffer_create_infos.iter().all(|info| info

            .usage
            .contains(vk::BufferUsageFlagBits::ShaderDeviceAddress)));
        ensure!(buffer_create_infos
            .iter()
            .all(|info| info.sharing_mode == vk::SharingMode::Exclusive));
        ensure!(buffer_create_infos.iter().all(
            |info| info.queue_family_index_count == 0 && info.p_queue_family_indices.is_null()

        ));
        ensure!(property_flags.into() != vk::MemoryPropertyFlags::empty());

        // Requirements.
        let mut memory_requirements = vec![];
        for &buffer_create_info in buffer_create_infos {
            let device_buffer_memory_requirements = vk::DeviceBufferMemoryRequirements {
                s_type: vk::StructureType::DeviceBufferMemoryRequirements,
                p_next: null(),
                p_create_info: addr_of!(buffer_create_info).cast(),
            };
            let mut memory_requirements2 = vk::MemoryRequirements2 {
                s_type: vk::StructureType::MemoryRequirements2,
                p_next: null_mut(),
                memory_requirements: zeroed(),
            };
            device.get_device_buffer_memory_requirements(
                &raw const device_buffer_memory_requirements,
                &raw mut memory_requirements2,
            );
            memory_requirements.push(memory_requirements2.memory_requirements);
        }

        // Buffers must be compatible with the allocation we make.
        ensure!(memory_requirements
            .iter()
            .all(|req| req.alignment == memory_requirements[0].alignment));
        ensure!(memory_requirements
            .iter()
            .all(|req| req.memory_type_bits == memory_requirements[0].memory_type_bits));
        let alignment = memory_requirements[0].alignment;
        let memory_type_bits = memory_requirements[0].memory_type_bits;

        // Memory type index.
        let memory_type_index = memory_type_index(
            &physical_device.memory_properties,
            property_flags,
            memory_type_bits,
        );

        // Allocation size.
        let allocation_size = memory_requirements
            .iter()
            .map(|req| aligned_size(req.size, alignment))
            .sum::<vk::DeviceSize>();

        // Allocation.
        let device_memory = {
            let memory_allocate_flags_info = vk::MemoryAllocateFlagsInfo {
                s_type: vk::StructureType::MemoryAllocateFlagsInfo,
                p_next: null(),
                flags: vk::MemoryAllocateFlagBits::DeviceAddress.into(),
                device_mask: 0,
            };
            device
                .allocate_memory(&vk::MemoryAllocateInfo {
                    s_type: vk::StructureType::MemoryAllocateInfo,
                    p_next: addr_of!(memory_allocate_flags_info).cast(),
                    allocation_size,
                    memory_type_index,
                })
                .with_context(|| {
                    format!("Allocating device memory for {} buffers", buffers.len())
                })?
        };

        // Map memory.
        let mut memory_ptr = None;
        if property_flags
            .into()
            .contains(vk::MemoryPropertyFlagBits::HostVisible)
        {
            let ptr = device
                .map_memory2_khr(&vk::MemoryMapInfoKHR {
                    s_type: vk::StructureType::MemoryMapInfoKHR,
                    p_next: null(),
                    flags: vk::MemoryMapFlags::empty(),
                    memory: device_memory,
                    offset: 0,
                    size: allocation_size,
                })
                .with_context(|| format!("Mapping buffer size={allocation_size}"))?;
            memory_ptr = Some(ptr);
        }

        // Sub-allocations.
        let mut allocations = vec![];
        let mut memory_offset = 0;
        for (buffer_index, (buffer, requirements)) in
            buffers.iter().zip(memory_requirements).enumerate()
        {
            // Aligned size.
            let aligned_size = aligned_size(requirements.size, alignment);

            // Bind buffer memory.
            device
                .bind_buffer_memory2(
                    1,
                    &vk::BindBufferMemoryInfo {
                        s_type: vk::StructureType::BindBufferMemoryInfo,
                        p_next: null(),
                        buffer: *buffer,
                        memory: device_memory,
                        memory_offset,
                    },
                )
                .with_context(|| {
                    format!(
                        "Binding buffer {buffer_index} \
                        size={aligned_size} into \
                        device memory offset={memory_offset}"
                    )
                })?;

            // Device address.
            let device_address = device.get_buffer_device_address(&vk::BufferDeviceAddressInfo {
                s_type: vk::StructureType::BufferDeviceAddressInfo,
                p_next: null(),
                buffer: *buffer,
            });

            // Map memory.
            let buffer_ptr = memory_ptr.map(|ptr| ptr.add(memory_offset as _));

            // Advance.
            memory_offset += aligned_size;

            // Output.
            allocations.push(BufferAllocation {
                address: device_address,
                size: requirements.size,
                ptr: buffer_ptr,
            });
        }

        Ok(Self {
            memory: device_memory,
            allocations,
        })
    }

    pub unsafe fn free(self, device: &Device) {
        device.free_memory(self.memory);
    }

    #[must_use]
    pub fn allocations(&self) -> &[BufferAllocation] {
        &self.allocations
    }
}

//
// Images
//

#[derive(Debug)]
pub struct ImageAllocations {
    memory: vk::DeviceMemory,
}

impl ImageAllocations {
    pub unsafe fn allocate(
        physical_device: &PhysicalDevice,
        device: &Device,
        images: &[vk::Image],
        image_create_infos: &[vk::ImageCreateInfo],
        property_flags: impl Into<vk::MemoryPropertyFlags> + Copy,
    ) -> Result<Self> {
        // Validation.
        ensure!(!images.is_empty());
        ensure!(!image_create_infos.is_empty());
        ensure!(images.len() == image_create_infos.len());
        ensure!(image_create_infos
            .iter()
            .all(|info| info.s_type == vk::StructureType::ImageCreateInfo));
        ensure!(image_create_infos.iter().all(|info| info.p_next.is_null()));
        ensure!(image_create_infos
            .iter()
            .all(|info| info.flags == vk::ImageCreateFlags::empty()));
        ensure!(image_create_infos
            .iter()
            .all(|info| info.extent.width > 0 && info.extent.height > 0 && info.extent.depth > 0));
        ensure!(image_create_infos.iter().all(|info| info.mip_levels > 0));
        ensure!(image_create_infos.iter().all(|info| info.array_layers > 0));
        ensure!(image_create_infos
            .iter()
            .all(|info| info.tiling == vk::ImageTiling::Optimal));
        ensure!(image_create_infos
            .iter()
            .all(|info| info.sharing_mode == vk::SharingMode::Exclusive));
        ensure!(image_create_infos.iter().all(
            |info| info.queue_family_index_count == 0 && info.p_queue_family_indices.is_null()

        ));
        ensure!(image_create_infos
            .iter()
            .all(|info| info.initial_layout == vk::ImageLayout::Undefined));

        // Requirements.
        let mut memory_requirements = vec![];
        for &image_create_info in image_create_infos {
            let device_image_memory_requirements = vk::DeviceImageMemoryRequirements {
                s_type: vk::StructureType::DeviceImageMemoryRequirements,
                p_next: null(),
                p_create_info: &raw const image_create_info,
                plane_aspect: zeroed(),
            };
            let mut memory_requirements2 = vk::MemoryRequirements2 {
                s_type: vk::StructureType::MemoryRequirements2,
                p_next: null_mut(),
                memory_requirements: zeroed(),
            };
            device.get_device_image_memory_requirements(
                &raw const device_image_memory_requirements,
                &raw mut memory_requirements2,
            );
            memory_requirements.push(memory_requirements2.memory_requirements);
        }

        // Images must be compatible with the allocation we make.
        ensure!(memory_requirements
            .iter()
            .all(|req| req.alignment == memory_requirements[0].alignment));
        ensure!(memory_requirements
            .iter()
            .all(|req| req.memory_type_bits == memory_requirements[0].memory_type_bits));
        let alignment = memory_requirements[0].alignment;
        let memory_type_bits = memory_requirements[0].memory_type_bits;

        // Memory type index.
        let memory_type_index = memory_type_index(
            &physical_device.memory_properties,
            property_flags,
            memory_type_bits,
        );

        // Allocation size.
        let allocation_size = memory_requirements
            .iter()
            .map(|req| aligned_size(req.size, alignment))
            .sum::<vk::DeviceSize>();

        // Allocation.
        let device_memory = device
            .allocate_memory(&vk::MemoryAllocateInfo {
                s_type: vk::StructureType::MemoryAllocateInfo,
                p_next: null(),
                allocation_size,
                memory_type_index,
            })
            .with_context(|| {
                format!(
                    "\
                    Allocating device memory for {} images",
                    images.len()
                )
            })?;

        // Sub-allocations.
        let mut memory_offset = 0;
        for (image_index, (image, requirements)) in
            images.iter().zip(memory_requirements).enumerate()
        {
            // Aligned size.
            let aligned_size = aligned_size(requirements.size, alignment);

            // Bind image memory.
            device
                .bind_image_memory2(
                    1,
                    &vk::BindImageMemoryInfo {
                        s_type: vk::StructureType::BindImageMemoryInfo,
                        p_next: null(),
                        image: *image,
                        memory: device_memory,
                        memory_offset,
                    },
                )
                .with_context(|| {
                    format!(
                        "\
                        Binding image {image_index} \
                        size={aligned_size} into \
                        device memory offset={memory_offset}"
                    )
                })?;

            // Advance.
            memory_offset += aligned_size;
        }

        Ok(Self {
            memory: device_memory,
        })
    }

    pub unsafe fn free(self, device: &Device) {
        device.free_memory(self.memory);
    }
}

//
// Utilities
//

fn memory_type_index(
    memory: &vk::PhysicalDeviceMemoryProperties,
    property_flags: impl Into<vk::MemoryPropertyFlags> + Copy,
    memory_type_bits: u32,
) -> u32 {
    for memory_type_index in 0..memory.memory_type_count {
        let memory_type = memory.memory_types[memory_type_index as usize];
        let type_matches = (1 << memory_type_index) & memory_type_bits != 0;
        let property_matches = memory_type.property_flags.contains(property_flags);
        if type_matches && property_matches {
            debug!(
                "index={}, type={:?}, heap={:?}",
                memory_type_index,
                &memory.memory_types[memory_type_index as usize].property_flags,
                &memory.memory_heaps[memory_type.heap_index as usize].flags
            );
            return memory_type_index;
        }
    }
    panic!("Unable to find suitable memory type for the buffer, memory_type_bits=0b{memory_type_bits:b}");
}