vulkan-rust 0.10.0

Ergonomic Vulkan bindings for Rust, generated from vk.xml
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
//! Runtime integration tests for generated wrapper methods.
//!
//! These exercise the auto-generated `impl Device { ... }` and
//! `impl Instance { ... }` methods against a real Vulkan driver.
//! All tests require a Vulkan runtime and are `#[ignore]`d by default.
//!
//! Run with: `cargo test -p vulkan-rust --test generated_wrappers_integration -- --ignored`

mod common;

use vk::Handle;
use vulkan_rust::{Entry, Instance, vk};

struct TestDevice {
    _entry: Entry,
    instance: Instance,
    device: vulkan_rust::Device,
    physical_device: vk::PhysicalDevice,
    queue_family: u32,
}

impl TestDevice {
    fn new() -> Self {
        let (entry, instance) = common::create_instance();

        let physical_devices = unsafe { instance.enumerate_physical_devices() }
            .expect("failed to enumerate physical devices");
        let physical_device = physical_devices[0];

        let families =
            unsafe { instance.get_physical_device_queue_family_properties(physical_device) };
        let queue_family = families
            .iter()
            .position(|f| f.queue_flags.contains(vk::QueueFlagBits::GRAPHICS))
            .expect("no graphics queue family") as u32;

        let queue_priority = 1.0f32;
        let queue_create_info = vk::DeviceQueueCreateInfo {
            s_type: vk::StructureType::DEVICE_QUEUE_CREATE_INFO,
            p_next: std::ptr::null(),
            flags: vk::DeviceQueueCreateFlagBits::empty(),
            queue_family_index: queue_family,
            queue_count: 1,
            p_queue_priorities: &queue_priority,
        };
        let device_create_info = vk::DeviceCreateInfo {
            s_type: vk::StructureType::DEVICE_CREATE_INFO,
            p_next: std::ptr::null(),
            flags: 0,
            queue_create_info_count: 1,
            p_queue_create_infos: &queue_create_info,
            enabled_layer_count: 0,
            pp_enabled_layer_names: std::ptr::null(),
            enabled_extension_count: 0,
            pp_enabled_extension_names: std::ptr::null(),
            p_enabled_features: std::ptr::null(),
        };
        let device = unsafe { instance.create_device(physical_device, &device_create_info, None) }
            .expect("failed to create device");

        Self {
            _entry: entry,
            instance,
            device,
            physical_device,
            queue_family,
        }
    }
}

impl Drop for TestDevice {
    fn drop(&mut self) {
        unsafe {
            self.device.device_wait_idle().ok();
            self.device.destroy_device(None);
            self.instance.destroy_instance(None);
        }
    }
}

// ---------------------------------------------------------------------------
// Instance-level generated wrapper tests
// ---------------------------------------------------------------------------

#[test]
#[ignore]
fn enumerate_device_extension_properties() {
    let (_entry, instance) = common::create_instance();
    let devices = unsafe { instance.enumerate_physical_devices() }
        .expect("enumerate_physical_devices failed");

    let extensions = unsafe { instance.enumerate_device_extension_properties(devices[0], None) }
        .expect("enumerate_device_extension_properties failed");

    println!("Device extensions: {}", extensions.len());
    assert!(
        !extensions.is_empty(),
        "expected at least one device extension"
    );

    unsafe { instance.destroy_instance(None) };
}

#[test]
#[ignore]
fn get_physical_device_memory_properties() {
    let (_entry, instance) = common::create_instance();
    let devices = unsafe { instance.enumerate_physical_devices() }
        .expect("enumerate_physical_devices failed");

    let mem_props = unsafe { instance.get_physical_device_memory_properties(devices[0]) };

    assert!(
        mem_props.memory_type_count > 0,
        "expected at least one memory type"
    );
    assert!(
        mem_props.memory_heap_count > 0,
        "expected at least one memory heap"
    );
    println!(
        "Memory: {} types, {} heaps",
        mem_props.memory_type_count, mem_props.memory_heap_count
    );

    unsafe { instance.destroy_instance(None) };
}

#[test]
#[ignore]
fn get_physical_device_features() {
    let (_entry, instance) = common::create_instance();
    let devices = unsafe { instance.enumerate_physical_devices() }
        .expect("enumerate_physical_devices failed");

    // Just verify the call completes without crashing.
    let _features = unsafe { instance.get_physical_device_features(devices[0]) };

    unsafe { instance.destroy_instance(None) };
}

// ---------------------------------------------------------------------------
// Device-level generated wrapper tests
// ---------------------------------------------------------------------------

#[test]
#[ignore]
fn create_and_destroy_buffer() {
    let t = TestDevice::new();

    let buffer_info = vk::BufferCreateInfo {
        s_type: vk::StructureType::BUFFER_CREATE_INFO,
        p_next: std::ptr::null(),
        flags: vk::BufferCreateFlagBits::empty(),
        size: 1024,
        usage: vk::BufferUsageFlagBits::VERTEX_BUFFER,
        sharing_mode: vk::SharingMode::EXCLUSIVE,
        queue_family_index_count: 0,
        p_queue_family_indices: std::ptr::null(),
    };

    let buffer =
        unsafe { t.device.create_buffer(&buffer_info, None) }.expect("create_buffer failed");
    assert!(!buffer.is_null());

    unsafe { t.device.destroy_buffer(buffer, None) };
}

#[test]
#[ignore]
fn get_buffer_memory_requirements() {
    let t = TestDevice::new();

    let buffer_info = vk::BufferCreateInfo {
        s_type: vk::StructureType::BUFFER_CREATE_INFO,
        p_next: std::ptr::null(),
        flags: vk::BufferCreateFlagBits::empty(),
        size: 256,
        usage: vk::BufferUsageFlagBits::UNIFORM_BUFFER,
        sharing_mode: vk::SharingMode::EXCLUSIVE,
        queue_family_index_count: 0,
        p_queue_family_indices: std::ptr::null(),
    };

    let buffer =
        unsafe { t.device.create_buffer(&buffer_info, None) }.expect("create_buffer failed");
    let mem_reqs = unsafe { t.device.get_buffer_memory_requirements(buffer) };

    assert!(mem_reqs.size >= 256, "memory requirements size too small");
    assert!(mem_reqs.alignment > 0, "alignment must be non-zero");
    println!(
        "Buffer memory: size={}, alignment={}, memory_type_bits=0x{:x}",
        mem_reqs.size, mem_reqs.alignment, mem_reqs.memory_type_bits
    );

    unsafe { t.device.destroy_buffer(buffer, None) };
}

#[test]
#[ignore]
fn allocate_and_free_memory() {
    let t = TestDevice::new();

    let mem_props = unsafe {
        t.instance
            .get_physical_device_memory_properties(t.physical_device)
    };

    // Find a host-visible memory type.
    let memory_type_index = (0..mem_props.memory_type_count)
        .find(|&i| {
            mem_props.memory_types[i as usize]
                .property_flags
                .contains(vk::MemoryPropertyFlagBits::HOST_VISIBLE)
        })
        .expect("no host-visible memory type");

    let alloc_info = vk::MemoryAllocateInfo {
        s_type: vk::StructureType::MEMORY_ALLOCATE_INFO,
        p_next: std::ptr::null(),
        allocation_size: 4096,
        memory_type_index,
    };

    let memory =
        unsafe { t.device.allocate_memory(&alloc_info, None) }.expect("allocate_memory failed");
    assert!(!memory.is_null());

    unsafe { t.device.free_memory(memory, None) };
}

#[test]
#[ignore]
fn create_and_destroy_fence() {
    let t = TestDevice::new();

    let fence_info = vk::FenceCreateInfo {
        s_type: vk::StructureType::FENCE_CREATE_INFO,
        p_next: std::ptr::null(),
        flags: vk::FenceCreateFlagBits::SIGNALED,
    };

    let fence = unsafe { t.device.create_fence(&fence_info, None) }.expect("create_fence failed");
    assert!(!fence.is_null());

    // Wait for signaled fence should succeed immediately.
    let result = unsafe { t.device.wait_for_fences(&[fence], true, 0) };
    assert!(result.is_ok(), "wait_for_fences failed: {result:?}");

    // Reset and verify it's unsignaled.
    unsafe { t.device.reset_fences(&[fence]) }.expect("reset_fences failed");

    unsafe { t.device.destroy_fence(fence, None) };
}

#[test]
#[ignore]
fn create_and_destroy_semaphore() {
    let t = TestDevice::new();

    let sem_info = vk::SemaphoreCreateInfo {
        s_type: vk::StructureType::SEMAPHORE_CREATE_INFO,
        p_next: std::ptr::null(),
        flags: vk::SemaphoreCreateFlagBits::empty(),
    };

    let semaphore =
        unsafe { t.device.create_semaphore(&sem_info, None) }.expect("create_semaphore failed");
    assert!(!semaphore.is_null());

    unsafe { t.device.destroy_semaphore(semaphore, None) };
}

#[test]
#[ignore]
fn create_command_pool_and_submit_empty_buffer() {
    let t = TestDevice::new();

    // Create command pool.
    let pool_info = vk::CommandPoolCreateInfo {
        s_type: vk::StructureType::COMMAND_POOL_CREATE_INFO,
        p_next: std::ptr::null(),
        flags: vk::CommandPoolCreateFlagBits::RESET_COMMAND_BUFFER,
        queue_family_index: t.queue_family,
    };
    let pool = unsafe { t.device.create_command_pool(&pool_info, None) }
        .expect("create_command_pool failed");

    // Allocate command buffer (uses raw forward,count is inside the struct).
    let alloc_info = vk::CommandBufferAllocateInfo {
        s_type: vk::StructureType::COMMAND_BUFFER_ALLOCATE_INFO,
        p_next: std::ptr::null(),
        command_pool: pool,
        level: vk::CommandBufferLevel::PRIMARY,
        command_buffer_count: 1,
    };
    let mut cmd_buf = vk::CommandBuffer::null();
    unsafe {
        let fp = t
            .device
            .commands()
            .allocate_command_buffers
            .expect("not loaded");
        let result = fp(t.device.handle(), &alloc_info, &mut cmd_buf);
        assert!(
            result.as_raw() >= 0,
            "allocate_command_buffers failed: {:?}",
            result
        );
    };
    assert!(!cmd_buf.is_null());

    // Begin → End (empty command buffer).
    let begin_info = vk::CommandBufferBeginInfo {
        s_type: vk::StructureType::COMMAND_BUFFER_BEGIN_INFO,
        p_next: std::ptr::null(),
        flags: vk::CommandBufferUsageFlagBits::ONE_TIME_SUBMIT,
        p_inheritance_info: std::ptr::null(),
    };
    unsafe { t.device.begin_command_buffer(cmd_buf, &begin_info) }
        .expect("begin_command_buffer failed");
    unsafe { t.device.end_command_buffer(cmd_buf) }.expect("end_command_buffer failed");

    // Submit.
    let queue = unsafe { t.device.get_device_queue(t.queue_family, 0) };
    let submit_info = vk::SubmitInfo {
        s_type: vk::StructureType::SUBMIT_INFO,
        p_next: std::ptr::null(),
        wait_semaphore_count: 0,
        p_wait_semaphores: std::ptr::null(),
        p_wait_dst_stage_mask: std::ptr::null(),
        command_buffer_count: 1,
        p_command_buffers: &cmd_buf,
        signal_semaphore_count: 0,
        p_signal_semaphores: std::ptr::null(),
    };

    let fence_info = vk::FenceCreateInfo {
        s_type: vk::StructureType::FENCE_CREATE_INFO,
        p_next: std::ptr::null(),
        flags: vk::FenceCreateFlagBits::empty(),
    };
    let fence = unsafe { t.device.create_fence(&fence_info, None) }.expect("create_fence failed");

    unsafe { t.device.queue_submit(queue, &[submit_info], fence) }.expect("queue_submit failed");

    // Wait for completion.
    unsafe { t.device.wait_for_fences(&[fence], true, u64::MAX) }.expect("wait_for_fences failed");

    // Cleanup.
    unsafe {
        t.device.destroy_fence(fence, None);
        t.device.free_command_buffers(pool, &[cmd_buf]);
        t.device.destroy_command_pool(pool, None);
    };
}

#[test]
#[ignore]
fn create_and_destroy_image() {
    let t = TestDevice::new();

    let image_info = vk::ImageCreateInfo {
        s_type: vk::StructureType::IMAGE_CREATE_INFO,
        p_next: std::ptr::null(),
        flags: vk::ImageCreateFlagBits::empty(),
        image_type: vk::ImageType::_2D,
        format: vk::Format::R8G8B8A8_UNORM,
        extent: vk::Extent3D {
            width: 64,
            height: 64,
            depth: 1,
        },
        mip_levels: 1,
        array_layers: 1,
        samples: vk::SampleCountFlagBits::_1,
        tiling: vk::ImageTiling::OPTIMAL,
        usage: vk::ImageUsageFlagBits::SAMPLED,
        sharing_mode: vk::SharingMode::EXCLUSIVE,
        queue_family_index_count: 0,
        p_queue_family_indices: std::ptr::null(),
        initial_layout: vk::ImageLayout::UNDEFINED,
    };

    let image = unsafe { t.device.create_image(&image_info, None) }.expect("create_image failed");
    assert!(!image.is_null());

    let mem_reqs = unsafe { t.device.get_image_memory_requirements(image) };
    assert!(
        mem_reqs.size > 0,
        "image memory requirements size must be > 0"
    );

    unsafe { t.device.destroy_image(image, None) };
}

#[test]
#[ignore]
fn create_and_destroy_sampler() {
    let t = TestDevice::new();

    let sampler_info = vk::SamplerCreateInfo {
        s_type: vk::StructureType::SAMPLER_CREATE_INFO,
        p_next: std::ptr::null(),
        flags: vk::SamplerCreateFlagBits::empty(),
        mag_filter: vk::Filter::LINEAR,
        min_filter: vk::Filter::LINEAR,
        mipmap_mode: vk::SamplerMipmapMode::LINEAR,
        address_mode_u: vk::SamplerAddressMode::REPEAT,
        address_mode_v: vk::SamplerAddressMode::REPEAT,
        address_mode_w: vk::SamplerAddressMode::REPEAT,
        mip_lod_bias: 0.0,
        anisotropy_enable: 0,
        max_anisotropy: 1.0,
        compare_enable: 0,
        compare_op: vk::CompareOp::ALWAYS,
        min_lod: 0.0,
        max_lod: 0.0,
        border_color: vk::BorderColor::INT_OPAQUE_BLACK,
        unnormalized_coordinates: 0,
    };

    let sampler =
        unsafe { t.device.create_sampler(&sampler_info, None) }.expect("create_sampler failed");
    assert!(!sampler.is_null());

    unsafe { t.device.destroy_sampler(sampler, None) };
}

#[test]
#[ignore]
fn create_and_destroy_pipeline_layout() {
    let t = TestDevice::new();

    let layout_info = vk::PipelineLayoutCreateInfo {
        s_type: vk::StructureType::PIPELINE_LAYOUT_CREATE_INFO,
        p_next: std::ptr::null(),
        flags: vk::PipelineLayoutCreateFlagBits::empty(),
        set_layout_count: 0,
        p_set_layouts: std::ptr::null(),
        push_constant_range_count: 0,
        p_push_constant_ranges: std::ptr::null(),
    };

    let layout = unsafe { t.device.create_pipeline_layout(&layout_info, None) }
        .expect("create_pipeline_layout failed");
    assert!(!layout.is_null());

    unsafe { t.device.destroy_pipeline_layout(layout, None) };
}