kazan 0.3.9+1.4.359

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
475
476
477
478
479
480
481
482
//! <https://registry.khronos.org/vulkan/specs/latest/man/html/VK_KHR_get_display_properties2.html>
#![allow(unused_imports)]
use crate::{vk::Result as VkResult, vk::*, *};
use core::ffi::{CStr, c_char, c_int, c_void};
use core::mem::transmute;
use core::ptr;

pub const EXTENSION_NAME: &CStr = c"VK_KHR_get_display_properties2";

pub(super) mod defs {
    #![allow(non_camel_case_types, unused_imports)]
    use crate::{vk::*, *};
    use core::ffi::{CStr, c_char, c_int, c_void};
    use core::fmt;
    use core::marker::PhantomData;
    use core::ptr;

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkDisplayProperties2KHR.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct DisplayProperties2KHR<'a> {
        pub s_type: StructureType,
        pub p_next: *mut c_void,
        pub display_properties: DisplayPropertiesKHR<'a>,
        pub _marker: PhantomData<&'a ()>,
    }

    #[cfg(feature = "debug")]
    impl fmt::Debug for DisplayProperties2KHR<'_> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.debug_struct("DisplayProperties2KHR")
                .field("s_type", &self.s_type)
                .field("p_next", &self.p_next)
                .field("display_properties", &self.display_properties)
                .finish()
        }
    }

    unsafe impl<'a> TaggedStructure<'a> for DisplayProperties2KHR<'a> {
        const STRUCTURE_TYPE: StructureType = StructureType::DISPLAY_PROPERTIES_2_KHR;
    }

    impl Default for DisplayProperties2KHR<'_> {
        fn default() -> Self {
            Self {
                s_type: Self::STRUCTURE_TYPE,
                p_next: ptr::null_mut(),
                display_properties: Default::default(),
                _marker: PhantomData,
            }
        }
    }

    impl<'a> DisplayProperties2KHR<'a> {
        #[inline]
        pub fn display_properties(mut self, display_properties: DisplayPropertiesKHR<'a>) -> Self {
            self.display_properties = display_properties;
            self
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkDisplayPlaneProperties2KHR.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct DisplayPlaneProperties2KHR<'a> {
        pub s_type: StructureType,
        pub p_next: *mut c_void,
        pub display_plane_properties: DisplayPlanePropertiesKHR,
        pub _marker: PhantomData<&'a ()>,
    }

    #[cfg(feature = "debug")]
    impl fmt::Debug for DisplayPlaneProperties2KHR<'_> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.debug_struct("DisplayPlaneProperties2KHR")
                .field("s_type", &self.s_type)
                .field("p_next", &self.p_next)
                .field("display_plane_properties", &self.display_plane_properties)
                .finish()
        }
    }

    unsafe impl<'a> TaggedStructure<'a> for DisplayPlaneProperties2KHR<'a> {
        const STRUCTURE_TYPE: StructureType = StructureType::DISPLAY_PLANE_PROPERTIES_2_KHR;
    }

    impl Default for DisplayPlaneProperties2KHR<'_> {
        fn default() -> Self {
            Self {
                s_type: Self::STRUCTURE_TYPE,
                p_next: ptr::null_mut(),
                display_plane_properties: Default::default(),
                _marker: PhantomData,
            }
        }
    }

    impl<'a> DisplayPlaneProperties2KHR<'a> {
        #[inline]
        pub fn display_plane_properties(
            mut self,
            display_plane_properties: DisplayPlanePropertiesKHR,
        ) -> Self {
            self.display_plane_properties = display_plane_properties;
            self
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkDisplayModeProperties2KHR.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct DisplayModeProperties2KHR<'a> {
        pub s_type: StructureType,
        pub p_next: *mut c_void,
        pub display_mode_properties: DisplayModePropertiesKHR,
        pub _marker: PhantomData<&'a ()>,
    }

    #[cfg(feature = "debug")]
    impl fmt::Debug for DisplayModeProperties2KHR<'_> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.debug_struct("DisplayModeProperties2KHR")
                .field("s_type", &self.s_type)
                .field("p_next", &self.p_next)
                .field("display_mode_properties", &self.display_mode_properties)
                .finish()
        }
    }

    unsafe impl<'a> TaggedStructure<'a> for DisplayModeProperties2KHR<'a> {
        const STRUCTURE_TYPE: StructureType = StructureType::DISPLAY_MODE_PROPERTIES_2_KHR;
    }

    impl Default for DisplayModeProperties2KHR<'_> {
        fn default() -> Self {
            Self {
                s_type: Self::STRUCTURE_TYPE,
                p_next: ptr::null_mut(),
                display_mode_properties: Default::default(),
                _marker: PhantomData,
            }
        }
    }

    impl<'a> DisplayModeProperties2KHR<'a> {
        #[inline]
        pub fn display_mode_properties(
            mut self,
            display_mode_properties: DisplayModePropertiesKHR,
        ) -> Self {
            self.display_mode_properties = display_mode_properties;
            self
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkDisplayPlaneInfo2KHR.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct DisplayPlaneInfo2KHR<'a> {
        pub s_type: StructureType,
        pub p_next: *const c_void,
        pub mode: DisplayModeKHR,
        pub plane_index: u32,
        pub _marker: PhantomData<&'a ()>,
    }

    #[cfg(feature = "debug")]
    impl fmt::Debug for DisplayPlaneInfo2KHR<'_> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.debug_struct("DisplayPlaneInfo2KHR")
                .field("s_type", &self.s_type)
                .field("p_next", &self.p_next)
                .field("mode", &self.mode)
                .field("plane_index", &self.plane_index)
                .finish()
        }
    }

    unsafe impl<'a> TaggedStructure<'a> for DisplayPlaneInfo2KHR<'a> {
        const STRUCTURE_TYPE: StructureType = StructureType::DISPLAY_PLANE_INFO_2_KHR;
    }

    impl Default for DisplayPlaneInfo2KHR<'_> {
        fn default() -> Self {
            Self {
                s_type: Self::STRUCTURE_TYPE,
                p_next: ptr::null(),
                mode: Default::default(),
                plane_index: Default::default(),
                _marker: PhantomData,
            }
        }
    }

    impl<'a> DisplayPlaneInfo2KHR<'a> {
        #[inline]
        pub fn mode(mut self, mode: DisplayModeKHR) -> Self {
            self.mode = mode;
            self
        }

        #[inline]
        pub fn plane_index(mut self, plane_index: u32) -> Self {
            self.plane_index = plane_index;
            self
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkDisplayPlaneCapabilities2KHR.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct DisplayPlaneCapabilities2KHR<'a> {
        pub s_type: StructureType,
        pub p_next: *mut c_void,
        pub capabilities: DisplayPlaneCapabilitiesKHR,
        pub _marker: PhantomData<&'a ()>,
    }

    #[cfg(feature = "debug")]
    impl fmt::Debug for DisplayPlaneCapabilities2KHR<'_> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.debug_struct("DisplayPlaneCapabilities2KHR")
                .field("s_type", &self.s_type)
                .field("p_next", &self.p_next)
                .field("capabilities", &self.capabilities)
                .finish()
        }
    }

    unsafe impl<'a> TaggedStructure<'a> for DisplayPlaneCapabilities2KHR<'a> {
        const STRUCTURE_TYPE: StructureType = StructureType::DISPLAY_PLANE_CAPABILITIES_2_KHR;
    }

    impl Default for DisplayPlaneCapabilities2KHR<'_> {
        fn default() -> Self {
            Self {
                s_type: Self::STRUCTURE_TYPE,
                p_next: ptr::null_mut(),
                capabilities: Default::default(),
                _marker: PhantomData,
            }
        }
    }

    impl<'a> DisplayPlaneCapabilities2KHR<'a> {
        #[inline]
        pub fn capabilities(mut self, capabilities: DisplayPlaneCapabilitiesKHR) -> Self {
            self.capabilities = capabilities;
            self
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetPhysicalDeviceDisplayProperties2KHR.html>
    pub type PFN_vkGetPhysicalDeviceDisplayProperties2KHR = unsafe extern "system" fn(
        physical_device: PhysicalDevice,
        p_property_count: *mut u32,
        p_properties: *mut DisplayProperties2KHR<'_>,
    )
        -> vk::Result;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetPhysicalDeviceDisplayPlaneProperties2KHR.html>
    pub type PFN_vkGetPhysicalDeviceDisplayPlaneProperties2KHR =
        unsafe extern "system" fn(
            physical_device: PhysicalDevice,
            p_property_count: *mut u32,
            p_properties: *mut DisplayPlaneProperties2KHR<'_>,
        ) -> vk::Result;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetDisplayModeProperties2KHR.html>
    pub type PFN_vkGetDisplayModeProperties2KHR = unsafe extern "system" fn(
        physical_device: PhysicalDevice,
        display: DisplayKHR,
        p_property_count: *mut u32,
        p_properties: *mut DisplayModeProperties2KHR<'_>,
    ) -> vk::Result;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetDisplayPlaneCapabilities2KHR.html>
    pub type PFN_vkGetDisplayPlaneCapabilities2KHR = unsafe extern "system" fn(
        physical_device: PhysicalDevice,
        p_display_plane_info: *const DisplayPlaneInfo2KHR<'_>,
        p_capabilities: *mut DisplayPlaneCapabilities2KHR<'_>,
    ) -> vk::Result;
}

#[cfg(feature = "ffi")]
pub(super) mod ffi {
    #![allow(non_camel_case_types)]
    use super::defs::*;

    pub type VkDisplayProperties2KHR = DisplayProperties2KHR<'static>;
    pub type VkDisplayPlaneProperties2KHR = DisplayPlaneProperties2KHR<'static>;
    pub type VkDisplayModeProperties2KHR = DisplayModeProperties2KHR<'static>;
    pub type VkDisplayPlaneInfo2KHR = DisplayPlaneInfo2KHR<'static>;
    pub type VkDisplayPlaneCapabilities2KHR = DisplayPlaneCapabilities2KHR<'static>;
    impl DisplayProperties2KHR<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkDisplayProperties2KHR {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl DisplayPlaneProperties2KHR<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkDisplayPlaneProperties2KHR {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl DisplayModeProperties2KHR<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkDisplayModeProperties2KHR {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl DisplayPlaneInfo2KHR<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkDisplayPlaneInfo2KHR {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl DisplayPlaneCapabilities2KHR<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkDisplayPlaneCapabilities2KHR {
            unsafe { core::mem::transmute(self) }
        }
    }
}

pub struct InstanceFn {
    get_physical_device_display_properties2: PFN_vkGetPhysicalDeviceDisplayProperties2KHR,
    get_physical_device_display_plane_properties2:
        PFN_vkGetPhysicalDeviceDisplayPlaneProperties2KHR,
    get_display_mode_properties2: PFN_vkGetDisplayModeProperties2KHR,
    get_display_plane_capabilities2: PFN_vkGetDisplayPlaneCapabilities2KHR,
}

impl LoadInstanceFn for InstanceFn {
    unsafe fn load_with(
        load: impl Fn(&CStr) -> Option<PFN_vkVoidFunction>,
    ) -> core::result::Result<Self, MissingEntryPointError> {
        unsafe {
            Ok(Self {
                get_physical_device_display_properties2: transmute(
                    load(c"vkGetPhysicalDeviceDisplayProperties2KHR")
                        .ok_or(MissingEntryPointError)?,
                ),
                get_physical_device_display_plane_properties2: transmute(
                    load(c"vkGetPhysicalDeviceDisplayPlaneProperties2KHR")
                        .ok_or(MissingEntryPointError)?,
                ),
                get_display_mode_properties2: transmute(
                    load(c"vkGetDisplayModeProperties2KHR").ok_or(MissingEntryPointError)?,
                ),
                get_display_plane_capabilities2: transmute(
                    load(c"vkGetDisplayPlaneCapabilities2KHR").ok_or(MissingEntryPointError)?,
                ),
            })
        }
    }
}

impl InstanceFn {
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetPhysicalDeviceDisplayProperties2KHR.html>
    #[inline]
    pub unsafe fn get_physical_device_display_properties2<'a>(
        &self,
        physical_device: PhysicalDevice,
        mut properties: impl EnumerateInto<DisplayProperties2KHR<'a>>,
    ) -> crate::Result<()> {
        unsafe {
            let call = |property_count, properties| {
                let result = (self.get_physical_device_display_properties2)(
                    physical_device,
                    property_count,
                    properties as _,
                );

                match result {
                    VkResult::SUCCESS => Ok(()),
                    VkResult::INCOMPLETE => Ok(()),
                    err => Err(err),
                }
            };
            let mut len = 0;
            call(&mut len, std::ptr::null_mut())?;
            let capacity = len.try_into().expect("failed to convert `N` to usize");
            let properties_buf = properties.reserve(capacity);
            len = properties_buf.len().try_into().unwrap();
            let result = call(&mut len, properties_buf.as_mut_ptr() as *mut _)?;
            properties.set_len(len.try_into().unwrap());
            Ok(result)
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetPhysicalDeviceDisplayPlaneProperties2KHR.html>
    #[inline]
    pub unsafe fn get_physical_device_display_plane_properties2<'a>(
        &self,
        physical_device: PhysicalDevice,
        mut properties: impl EnumerateInto<DisplayPlaneProperties2KHR<'a>>,
    ) -> crate::Result<()> {
        unsafe {
            let call = |property_count, properties| {
                let result = (self.get_physical_device_display_plane_properties2)(
                    physical_device,
                    property_count,
                    properties as _,
                );

                match result {
                    VkResult::SUCCESS => Ok(()),
                    VkResult::INCOMPLETE => Ok(()),
                    err => Err(err),
                }
            };
            let mut len = 0;
            call(&mut len, std::ptr::null_mut())?;
            let capacity = len.try_into().expect("failed to convert `N` to usize");
            let properties_buf = properties.reserve(capacity);
            len = properties_buf.len().try_into().unwrap();
            let result = call(&mut len, properties_buf.as_mut_ptr() as *mut _)?;
            properties.set_len(len.try_into().unwrap());
            Ok(result)
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetDisplayModeProperties2KHR.html>
    #[inline]
    pub unsafe fn get_display_mode_properties2<'a>(
        &self,
        physical_device: PhysicalDevice,
        display: DisplayKHR,
        mut properties: impl EnumerateInto<DisplayModeProperties2KHR<'a>>,
    ) -> crate::Result<()> {
        unsafe {
            let call = |property_count, properties| {
                let result = (self.get_display_mode_properties2)(
                    physical_device,
                    display,
                    property_count,
                    properties as _,
                );

                match result {
                    VkResult::SUCCESS => Ok(()),
                    VkResult::INCOMPLETE => Ok(()),
                    err => Err(err),
                }
            };
            let mut len = 0;
            call(&mut len, std::ptr::null_mut())?;
            let capacity = len.try_into().expect("failed to convert `N` to usize");
            let properties_buf = properties.reserve(capacity);
            len = properties_buf.len().try_into().unwrap();
            let result = call(&mut len, properties_buf.as_mut_ptr() as *mut _)?;
            properties.set_len(len.try_into().unwrap());
            Ok(result)
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetDisplayPlaneCapabilities2KHR.html>
    #[inline]
    pub unsafe fn get_display_plane_capabilities2(
        &self,
        physical_device: PhysicalDevice,
        display_plane_info: &DisplayPlaneInfo2KHR<'_>,
        capabilities: &mut DisplayPlaneCapabilities2KHR<'_>,
    ) -> crate::Result<()> {
        unsafe {
            let result = (self.get_display_plane_capabilities2)(
                physical_device,
                display_plane_info,
                capabilities,
            );

            match result {
                VkResult::SUCCESS => Ok(()),
                err => Err(err),
            }
        }
    }
}