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
//! <https://registry.khronos.org/vulkan/specs/latest/man/html/VK_EXT_full_screen_exclusive.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_EXT_full_screen_exclusive";

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/VkSurfaceFullScreenExclusiveInfoEXT.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct SurfaceFullScreenExclusiveInfoEXT<'a> {
        pub s_type: StructureType,
        pub p_next: *mut c_void,
        pub full_screen_exclusive: FullScreenExclusiveEXT,
        pub _marker: PhantomData<&'a ()>,
    }

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

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

    unsafe impl Extends<PhysicalDeviceSurfaceInfo2KHR<'_>> for SurfaceFullScreenExclusiveInfoEXT<'_> {}
    unsafe impl Extends<SwapchainCreateInfoKHR<'_>> for SurfaceFullScreenExclusiveInfoEXT<'_> {}

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

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

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

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

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

    unsafe impl Extends<PhysicalDeviceSurfaceInfo2KHR<'_>>
        for SurfaceFullScreenExclusiveWin32InfoEXT<'_>
    {
    }
    unsafe impl Extends<SwapchainCreateInfoKHR<'_>> for SurfaceFullScreenExclusiveWin32InfoEXT<'_> {}

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

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

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

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

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

    unsafe impl Extends<SurfaceCapabilities2KHR<'_>> for SurfaceCapabilitiesFullScreenExclusiveEXT<'_> {}

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

    impl<'a> SurfaceCapabilitiesFullScreenExclusiveEXT<'a> {
        #[inline]
        pub fn full_screen_exclusive_supported(
            mut self,
            full_screen_exclusive_supported: bool,
        ) -> Self {
            self.full_screen_exclusive_supported = full_screen_exclusive_supported.into();
            self
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkFullScreenExclusiveEXT.html>
    #[repr(transparent)]
    #[derive(Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct FullScreenExclusiveEXT(i32);

    impl FullScreenExclusiveEXT {
        #[inline]
        pub const fn from_raw(x: i32) -> Self {
            Self(x)
        }
        #[inline]
        pub const fn as_raw(self) -> i32 {
            self.0
        }

        pub const DEFAULT_EXT: Self = Self(0);
        pub const ALLOWED_EXT: Self = Self(1);
        pub const DISALLOWED_EXT: Self = Self(2);
        pub const APPLICATION_CONTROLLED_EXT: Self = Self(3);
    }

    impl fmt::Debug for FullScreenExclusiveEXT {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            let name = match *self {
                Self::DEFAULT_EXT => Some("DEFAULT_EXT"),
                Self::ALLOWED_EXT => Some("ALLOWED_EXT"),
                Self::DISALLOWED_EXT => Some("DISALLOWED_EXT"),
                Self::APPLICATION_CONTROLLED_EXT => Some("APPLICATION_CONTROLLED_EXT"),
                _ => None,
            };
            if let Some(name) = name {
                f.write_str(name)
            } else {
                self.0.fmt(f)
            }
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetPhysicalDeviceSurfacePresentModes2EXT.html>
    pub type PFN_vkGetPhysicalDeviceSurfacePresentModes2EXT =
        unsafe extern "system" fn(
            physical_device: PhysicalDevice,
            p_surface_info: *const PhysicalDeviceSurfaceInfo2KHR<'_>,
            p_present_mode_count: *mut u32,
            p_present_modes: *mut PresentModeKHR,
        ) -> vk::Result;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetDeviceGroupSurfacePresentModes2EXT.html>
    pub type PFN_vkGetDeviceGroupSurfacePresentModes2EXT = unsafe extern "system" fn(
        device: Device,
        p_surface_info: *const PhysicalDeviceSurfaceInfo2KHR<'_>,
        p_modes: *mut DeviceGroupPresentModeFlagsKHR,
    )
        -> vk::Result;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkAcquireFullScreenExclusiveModeEXT.html>
    pub type PFN_vkAcquireFullScreenExclusiveModeEXT =
        unsafe extern "system" fn(device: Device, swapchain: SwapchainKHR) -> vk::Result;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkReleaseFullScreenExclusiveModeEXT.html>
    pub type PFN_vkReleaseFullScreenExclusiveModeEXT =
        unsafe extern "system" fn(device: Device, swapchain: SwapchainKHR) -> vk::Result;
}

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

    pub type VkSurfaceFullScreenExclusiveInfoEXT = SurfaceFullScreenExclusiveInfoEXT<'static>;
    pub type VkSurfaceFullScreenExclusiveWin32InfoEXT =
        SurfaceFullScreenExclusiveWin32InfoEXT<'static>;
    pub type VkSurfaceCapabilitiesFullScreenExclusiveEXT =
        SurfaceCapabilitiesFullScreenExclusiveEXT<'static>;
    pub type VkFullScreenExclusiveEXT = FullScreenExclusiveEXT;
    impl SurfaceFullScreenExclusiveInfoEXT<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkSurfaceFullScreenExclusiveInfoEXT {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl SurfaceFullScreenExclusiveWin32InfoEXT<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkSurfaceFullScreenExclusiveWin32InfoEXT {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl SurfaceCapabilitiesFullScreenExclusiveEXT<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkSurfaceCapabilitiesFullScreenExclusiveEXT {
            unsafe { core::mem::transmute(self) }
        }
    }
}

pub struct InstanceFn {
    get_physical_device_surface_present_modes2: PFN_vkGetPhysicalDeviceSurfacePresentModes2EXT,
}

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_surface_present_modes2: transmute(
                    load(c"vkGetPhysicalDeviceSurfacePresentModes2EXT")
                        .ok_or(MissingEntryPointError)?,
                ),
            })
        }
    }
}

impl InstanceFn {
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetPhysicalDeviceSurfacePresentModes2EXT.html>
    #[inline]
    pub unsafe fn get_physical_device_surface_present_modes2<'a>(
        &self,
        physical_device: PhysicalDevice,
        surface_info: &PhysicalDeviceSurfaceInfo2KHR<'a>,
        mut present_modes: impl EnumerateInto<PresentModeKHR>,
    ) -> crate::Result<()> {
        unsafe {
            let call = |present_mode_count, present_modes| {
                let result = (self.get_physical_device_surface_present_modes2)(
                    physical_device,
                    surface_info,
                    present_mode_count,
                    present_modes 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 present_modes_buf = present_modes.reserve(capacity);
            len = present_modes_buf.len().try_into().unwrap();
            let result = call(&mut len, present_modes_buf.as_mut_ptr() as *mut _)?;
            present_modes.set_len(len.try_into().unwrap());
            Ok(result)
        }
    }
}

pub struct DeviceFn {
    acquire_full_screen_exclusive_mode: PFN_vkAcquireFullScreenExclusiveModeEXT,
    release_full_screen_exclusive_mode: PFN_vkReleaseFullScreenExclusiveModeEXT,
    get_device_group_surface_present_modes2: Option<PFN_vkGetDeviceGroupSurfacePresentModes2EXT>,
}

impl LoadDeviceFn for DeviceFn {
    unsafe fn load_with(
        load: impl Fn(&CStr) -> Option<PFN_vkVoidFunction>,
    ) -> core::result::Result<Self, MissingEntryPointError> {
        unsafe {
            Ok(Self {
                acquire_full_screen_exclusive_mode: transmute(
                    load(c"vkAcquireFullScreenExclusiveModeEXT").ok_or(MissingEntryPointError)?,
                ),
                release_full_screen_exclusive_mode: transmute(
                    load(c"vkReleaseFullScreenExclusiveModeEXT").ok_or(MissingEntryPointError)?,
                ),
                get_device_group_surface_present_modes2: transmute(load(
                    c"vkGetDeviceGroupSurfacePresentModes2EXT",
                )),
            })
        }
    }
}

impl DeviceFn {
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkAcquireFullScreenExclusiveModeEXT.html>
    #[inline]
    pub unsafe fn acquire_full_screen_exclusive_mode(
        &self,
        device: Device,
        swapchain: SwapchainKHR,
    ) -> crate::Result<()> {
        unsafe {
            let result = (self.acquire_full_screen_exclusive_mode)(device, swapchain);

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkReleaseFullScreenExclusiveModeEXT.html>
    #[inline]
    pub unsafe fn release_full_screen_exclusive_mode(
        &self,
        device: Device,
        swapchain: SwapchainKHR,
    ) -> crate::Result<()> {
        unsafe {
            let result = (self.release_full_screen_exclusive_mode)(device, swapchain);

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetDeviceGroupSurfacePresentModes2EXT.html>
    #[inline]
    pub unsafe fn get_device_group_surface_present_modes2(
        &self,
        device: Device,
        surface_info: &PhysicalDeviceSurfaceInfo2KHR<'_>,
    ) -> crate::Result<DeviceGroupPresentModeFlagsKHR> {
        unsafe {
            let mut modes = core::mem::MaybeUninit::uninit();
            let result = (self.get_device_group_surface_present_modes2.unwrap())(
                device,
                surface_info,
                modes.as_mut_ptr(),
            );

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