covk 0.1.2-1.4.346

Unsafe vulkan bindings for Rust
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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
// generated file, do not modify manually
#![allow(unused_qualifications)]
#![allow(mismatched_lifetime_syntaxes)]
use crate::sys;
use crate::sys::ffi::*;
use crate::vk::*;
use crate::vk;
use crate::{Abi, Vk, Sys};

/// `VK_KHR_device_group` InstanceCommands
#[derive(Debug, Clone, Copy)]
pub struct Instance(pub sys::khr::device_group::InstanceCommands);

impl Instance {
    pub fn load(get: impl FnMut(&::core::ffi::CStr) -> Option<crate::ProcAddr>) -> Self {
        Self(unsafe { sys::khr::device_group::InstanceCommands::load(get) })
    }
}

impl Instance {
    /// ```c
    /// VkResult vkGetPhysicalDevicePresentRectanglesKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface, uint32_t* pRectCount, VkRect2D* pRects)
    /// ```
    ///
    /// SuccessCodes: [Result::Success], [Result::Incomplete]
    pub unsafe fn get_physical_device_present_rectangles(
        &self,
        physical_device: vk::PhysicalDevice,
        surface: vk::SurfaceKHR,
        rects: Option<&mut ::alloc::vec::Vec<Rect2D>>,
    ) -> crate::Result<(uint32_t, Result)> {
        unsafe {
            let mut _c: uint32_t = Default::default();
            let mut _r = self.0.GetPhysicalDevicePresentRectanglesKHR(
                physical_device.abi(), 
                surface.abi(), 
                &mut _c, 
                Default::default(), 
            ).vk();
            if let Some(_b) = rects {
                _r.result(|| Some(()))?;
                _b.reserve(_c as usize);
                _r = self.0.GetPhysicalDevicePresentRectanglesKHR(
                    physical_device.abi(), 
                    surface.abi(), 
                    &mut _c, 
                    (&mut **_b).abi(), 
                ).vk();
                _r.result(|| Some(()))?;
                _b.set_len(_b.len() + _c as usize);
            }
            _r.result_multi(|| Some(_c))
        }
    }
}

impl crate::CommandScope<vk::Instance> for vk::extensions::khr::device_group {
    type Commands = Instance;
}

/// Instance object
pub trait KhrDeviceGroupInstance {
    fn raw(&self) -> vk::Instance;
    fn commands(&self) -> &Instance;

}

impl crate::HndScope<vk::Instance> for vk::extensions::khr::device_group {
    type Impl = _hs_Instance::Instance;
}

mod _hs_Instance {
    use super::*;
    #[derive(Debug)]
    pub struct Instance(pub(crate) ::alloc::sync::Arc<super::Instance>, pub(crate) crate::hnd::Instance<vk::core>);

    impl Clone for Instance {
        fn clone(&self) -> Self { Self(self.0.clone(), self.1.clone()) }
    }

    impl crate::hnd::Instance<vk::extensions::khr::device_group> {
        pub unsafe fn new(base: &crate::hnd::Instance<vk::core>) -> Self {
            unsafe {
                Self(Instance(
                   ::alloc::sync::Arc::new(super::Instance::load(|name| unsafe { base.get_proc_addr(name) })),
                   base.clone(),
                ))
            }
        }
    }

    impl crate::Extension<crate::hnd::Instance<vk::core>> for vk::extensions::khr::device_group {
        type Output = crate::hnd::Instance<vk::extensions::khr::device_group>;
        unsafe fn make(target: &crate::hnd::Instance<vk::core>) -> Self::Output {
            unsafe { crate::hnd::Instance::<vk::extensions::khr::device_group>::new(target) }
        }
    }

    impl crate::hnd::Instance<vk::extensions::khr::device_group> {
        pub fn raw(&self) -> vk::Instance { self.0.1.raw() }
        pub fn commands(&self) -> &::alloc::sync::Arc<super::Instance> { &self.0.0 }
        pub fn core(&self) -> &crate::hnd::Instance<vk::core> { &self.0.1 }
    }

    impl ::core::fmt::Debug for crate::hnd::Instance<vk::extensions::khr::device_group> {
        fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
            f.write_fmt(format_args!("Instance({:p})", self.raw()))
        }
    }

    impl ::core::fmt::Pointer for crate::hnd::Instance<vk::extensions::khr::device_group> {
        fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
            self.raw().fmt(f)
        }
    }

    impl ::core::ops::Deref for crate::hnd::Instance<vk::extensions::khr::device_group> {
        type Target = super::Instance;
        fn deref(&self) -> &Self::Target { self.commands() }
    }

    impl super::KhrDeviceGroupInstance for crate::hnd::Instance<vk::extensions::khr::device_group> {
        fn raw(&self) -> vk::Instance { self.raw() }
        fn commands(&self) -> &super::Instance { self.commands() }
    }

    impl crate::HndCtx<vk::extensions::khr::device_group, vk::Instance> for crate::hnd::Instance<vk::extensions::khr::device_group> {
        type Ctx = Self;
        fn ctx(&self) -> Self::Ctx { self.clone() }
        fn raw(&self) -> vk::Instance { self.raw() }
        fn commands(&self) -> &::alloc::sync::Arc<super::Instance> { self.commands() }
    }
}

/// PhysicalDevice object
pub trait KhrDeviceGroupPhysicalDevice {
    fn raw(&self) -> vk::PhysicalDevice;
    fn commands(&self) -> &Instance;

    /// ```c
    /// VkResult vkGetPhysicalDevicePresentRectanglesKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface, uint32_t* pRectCount, VkRect2D* pRects)
    /// ```
    ///
    /// SuccessCodes: [Result::Success], [Result::Incomplete]
    unsafe fn get_present_rectangles(
        &self,
        surface: vk::SurfaceKHR,
        rects: Option<&mut ::alloc::vec::Vec<Rect2D>>,
    ) -> crate::Result<(uint32_t, Result)> {
        unsafe {
            self.commands().get_physical_device_present_rectangles(
                self.raw(),
                surface,
                rects,
            )
        }
    }
}

/// `VK_KHR_device_group` DeviceCommands
#[derive(Debug, Clone, Copy)]
pub struct Device(pub sys::khr::device_group::DeviceCommands);

impl Device {
    pub fn load(get: impl FnMut(&::core::ffi::CStr) -> Option<crate::ProcAddr>) -> Self {
        Self(unsafe { sys::khr::device_group::DeviceCommands::load(get) })
    }
}

impl Device {
    /// ```c
    /// VkResult vkAcquireNextImage2KHR(VkDevice device, VkAcquireNextImageInfoKHR const* pAcquireInfo, uint32_t* pImageIndex)
    /// ```
    ///
    /// SuccessCodes: [Result::Success], [Result::Timeout], [Result::NotReady], [Result::SuboptimalKhr]
    pub unsafe fn acquire_next_image2(
        &self,
        device: vk::Device,
        acquire_info: &AcquireNextImageInfoKHR,
        image_index: *mut uint32_t,
    ) -> crate::Result<Result> {
        unsafe {
            let _r = self.0.AcquireNextImage2KHR(
                device.abi(), 
                acquire_info.abi(), 
                image_index.abi(), 
            ).vk();
            _r.result(|| Some(_r))
        }
    }
    /// ```c
    /// void vkCmdDispatchBase(VkCommandBuffer commandBuffer, uint32_t baseGroupX, uint32_t baseGroupY, uint32_t baseGroupZ, uint32_t groupCountX, uint32_t groupCountY, uint32_t groupCountZ)
    /// ```
    pub unsafe fn cmd_dispatch_base(
        &self,
        command_buffer: vk::CommandBuffer,
        base_group_x: uint32_t,
        base_group_y: uint32_t,
        base_group_z: uint32_t,
        group_count_x: uint32_t,
        group_count_y: uint32_t,
        group_count_z: uint32_t,
    ) -> () {
        unsafe {
            self.0.CmdDispatchBaseKHR(
                command_buffer.abi(), 
                base_group_x.abi(), 
                base_group_y.abi(), 
                base_group_z.abi(), 
                group_count_x.abi(), 
                group_count_y.abi(), 
                group_count_z.abi(), 
            );
        }
    }
    /// ```c
    /// void vkCmdSetDeviceMask(VkCommandBuffer commandBuffer, uint32_t deviceMask)
    /// ```
    pub unsafe fn cmd_set_device_mask(
        &self,
        command_buffer: vk::CommandBuffer,
        device_mask: uint32_t,
    ) -> () {
        unsafe {
            self.0.CmdSetDeviceMaskKHR(
                command_buffer.abi(), 
                device_mask.abi(), 
            );
        }
    }
    /// ```c
    /// void vkGetDeviceGroupPeerMemoryFeatures(VkDevice device, uint32_t heapIndex, uint32_t localDeviceIndex, uint32_t remoteDeviceIndex, VkPeerMemoryFeatureFlags* pPeerMemoryFeatures)
    /// ```
    pub unsafe fn get_device_group_peer_memory_features(
        &self,
        device: vk::Device,
        heap_index: uint32_t,
        local_device_index: uint32_t,
        remote_device_index: uint32_t,
    ) -> PeerMemoryFeatureFlags {
        unsafe {
            let mut _v: PeerMemoryFeatureFlags = Default::default();
            self.0.GetDeviceGroupPeerMemoryFeaturesKHR(
                device.abi(), 
                heap_index.abi(), 
                local_device_index.abi(), 
                remote_device_index.abi(), 
                (&mut _v).abi(), 
            );
            _v
        }
    }
    /// ```c
    /// VkResult vkGetDeviceGroupPresentCapabilitiesKHR(VkDevice device, VkDeviceGroupPresentCapabilitiesKHR* pDeviceGroupPresentCapabilities)
    /// ```
    pub unsafe fn get_device_group_present_capabilities(
        &self,
        device: vk::Device,
        device_group_present_capabilities: &mut DeviceGroupPresentCapabilitiesKHR,
    ) -> crate::Result<()> {
        unsafe {
            let _r = self.0.GetDeviceGroupPresentCapabilitiesKHR(
                device.abi(), 
                device_group_present_capabilities.abi(), 
            ).vk();
            _r.result(|| Some(()))
        }
    }
    /// ```c
    /// VkResult vkGetDeviceGroupSurfacePresentModesKHR(VkDevice device, VkSurfaceKHR surface, VkDeviceGroupPresentModeFlagsKHR* pModes)
    /// ```
    pub unsafe fn get_device_group_surface_present_modes(
        &self,
        device: vk::Device,
        surface: vk::SurfaceKHR,
    ) -> crate::Result<DeviceGroupPresentModeFlagsKHR> {
        unsafe {
            let mut _v: DeviceGroupPresentModeFlagsKHR = Default::default();
            let _r = self.0.GetDeviceGroupSurfacePresentModesKHR(
                device.abi(), 
                surface.abi(), 
                (&mut _v).abi(), 
            ).vk();
            _r.result(|| Some(_v))
        }
    }
}

impl crate::CommandScope<vk::Device> for vk::extensions::khr::device_group {
    type Commands = Device;
}

/// Device object
pub trait KhrDeviceGroupDevice {
    fn raw(&self) -> vk::Device;
    fn commands(&self) -> &Device;

    /// ```c
    /// VkResult vkAcquireNextImage2KHR(VkDevice device, VkAcquireNextImageInfoKHR const* pAcquireInfo, uint32_t* pImageIndex)
    /// ```
    ///
    /// SuccessCodes: [Result::Success], [Result::Timeout], [Result::NotReady], [Result::SuboptimalKhr]
    unsafe fn acquire_next_image2(
        &self,
        acquire_info: &AcquireNextImageInfoKHR,
        image_index: *mut uint32_t,
    ) -> crate::Result<Result> {
        unsafe {
            self.commands().acquire_next_image2(
                self.raw(),
                acquire_info,
                image_index,
            )
        }
    }
    /// ```c
    /// void vkGetDeviceGroupPeerMemoryFeatures(VkDevice device, uint32_t heapIndex, uint32_t localDeviceIndex, uint32_t remoteDeviceIndex, VkPeerMemoryFeatureFlags* pPeerMemoryFeatures)
    /// ```
    unsafe fn get_device_group_peer_memory_features(
        &self,
        heap_index: uint32_t,
        local_device_index: uint32_t,
        remote_device_index: uint32_t,
    ) -> PeerMemoryFeatureFlags {
        unsafe {
            self.commands().get_device_group_peer_memory_features(
                self.raw(),
                heap_index,
                local_device_index,
                remote_device_index,
            )
        }
    }
    /// ```c
    /// VkResult vkGetDeviceGroupPresentCapabilitiesKHR(VkDevice device, VkDeviceGroupPresentCapabilitiesKHR* pDeviceGroupPresentCapabilities)
    /// ```
    unsafe fn get_device_group_present_capabilities(
        &self,
        device_group_present_capabilities: &mut DeviceGroupPresentCapabilitiesKHR,
    ) -> crate::Result<()> {
        unsafe {
            self.commands().get_device_group_present_capabilities(
                self.raw(),
                device_group_present_capabilities,
            )
        }
    }
    /// ```c
    /// VkResult vkGetDeviceGroupSurfacePresentModesKHR(VkDevice device, VkSurfaceKHR surface, VkDeviceGroupPresentModeFlagsKHR* pModes)
    /// ```
    unsafe fn get_device_group_surface_present_modes(
        &self,
        surface: vk::SurfaceKHR,
    ) -> crate::Result<DeviceGroupPresentModeFlagsKHR> {
        unsafe {
            self.commands().get_device_group_surface_present_modes(
                self.raw(),
                surface,
            )
        }
    }
}

impl crate::HndScope<vk::Device> for vk::extensions::khr::device_group {
    type Impl = _hs_Device::Device;
}

mod _hs_Device {
    use super::*;
    #[derive(Debug)]
    pub struct Device(pub(crate) ::alloc::sync::Arc<super::Device>, pub(crate) crate::hnd::Device<vk::core>);

    impl Clone for Device {
        fn clone(&self) -> Self { Self(self.0.clone(), self.1.clone()) }
    }

    impl crate::hnd::Device<vk::extensions::khr::device_group> {
        pub unsafe fn new(base: &crate::hnd::Device<vk::core>) -> Self {
            unsafe {
                Self(Device(
                   ::alloc::sync::Arc::new(super::Device::load(|name| unsafe { base.get_proc_addr(name) })),
                   base.clone(),
                ))
            }
        }
    }

    impl crate::Extension<crate::hnd::Device<vk::core>> for vk::extensions::khr::device_group {
        type Output = crate::hnd::Device<vk::extensions::khr::device_group>;
        unsafe fn make(target: &crate::hnd::Device<vk::core>) -> Self::Output {
            unsafe { crate::hnd::Device::<vk::extensions::khr::device_group>::new(target) }
        }
    }

    impl crate::hnd::Device<vk::extensions::khr::device_group> {
        pub fn raw(&self) -> vk::Device { self.0.1.raw() }
        pub fn commands(&self) -> &::alloc::sync::Arc<super::Device> { &self.0.0 }
        pub fn core(&self) -> &crate::hnd::Device<vk::core> { &self.0.1 }
    }

    impl ::core::fmt::Debug for crate::hnd::Device<vk::extensions::khr::device_group> {
        fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
            f.write_fmt(format_args!("Device({:p})", self.raw()))
        }
    }

    impl ::core::fmt::Pointer for crate::hnd::Device<vk::extensions::khr::device_group> {
        fn fmt(&self, f: &mut ::core::fmt::Formatter<'_>) -> ::core::fmt::Result {
            self.raw().fmt(f)
        }
    }

    impl ::core::ops::Deref for crate::hnd::Device<vk::extensions::khr::device_group> {
        type Target = super::Device;
        fn deref(&self) -> &Self::Target { self.commands() }
    }

    impl super::KhrDeviceGroupDevice for crate::hnd::Device<vk::extensions::khr::device_group> {
        fn raw(&self) -> vk::Device { self.raw() }
        fn commands(&self) -> &super::Device { self.commands() }
    }

    impl crate::HndCtx<vk::extensions::khr::device_group, vk::Device> for crate::hnd::Device<vk::extensions::khr::device_group> {
        type Ctx = Self;
        fn ctx(&self) -> Self::Ctx { self.clone() }
        fn raw(&self) -> vk::Device { self.raw() }
        fn commands(&self) -> &::alloc::sync::Arc<super::Device> { self.commands() }
    }
}

/// CommandBuffer object
pub trait KhrDeviceGroupCommandBuffer {
    fn raw(&self) -> vk::CommandBuffer;
    fn commands(&self) -> &Device;

    /// ```c
    /// void vkCmdDispatchBase(VkCommandBuffer commandBuffer, uint32_t baseGroupX, uint32_t baseGroupY, uint32_t baseGroupZ, uint32_t groupCountX, uint32_t groupCountY, uint32_t groupCountZ)
    /// ```
    unsafe fn dispatch_base(
        &self,
        base_group_x: uint32_t,
        base_group_y: uint32_t,
        base_group_z: uint32_t,
        group_count_x: uint32_t,
        group_count_y: uint32_t,
        group_count_z: uint32_t,
    ) -> () {
        unsafe {
            self.commands().cmd_dispatch_base(
                self.raw(),
                base_group_x,
                base_group_y,
                base_group_z,
                group_count_x,
                group_count_y,
                group_count_z,
            )
        }
    }
    /// ```c
    /// void vkCmdSetDeviceMask(VkCommandBuffer commandBuffer, uint32_t deviceMask)
    /// ```
    unsafe fn set_device_mask(
        &self,
        device_mask: uint32_t,
    ) -> () {
        unsafe {
            self.commands().cmd_set_device_mask(
                self.raw(),
                device_mask,
            )
        }
    }
}