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
#![cfg(feature = "provisional")]
//! <https://registry.khronos.org/vulkan/specs/latest/man/html/VK_NV_displacement_micromap.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_NV_displacement_micromap";

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

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

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

    unsafe impl Extends<PhysicalDeviceFeatures2<'_>>
        for PhysicalDeviceDisplacementMicromapFeaturesNV<'_>
    {
    }
    unsafe impl Extends<DeviceCreateInfo<'_>> for PhysicalDeviceDisplacementMicromapFeaturesNV<'_> {}

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

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

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

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

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

    unsafe impl Extends<PhysicalDeviceProperties2<'_>>
        for PhysicalDeviceDisplacementMicromapPropertiesNV<'_>
    {
    }

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

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkAccelerationStructureTrianglesDisplacementMicromapNV.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct AccelerationStructureTrianglesDisplacementMicromapNV<'a> {
        pub s_type: StructureType,
        pub p_next: *mut c_void,
        pub displacement_bias_and_scale_format: Format,
        pub displacement_vector_format: Format,
        pub displacement_bias_and_scale_buffer: DeviceOrHostAddressConstKHR<'a>,
        pub displacement_bias_and_scale_stride: DeviceSize,
        pub displacement_vector_buffer: DeviceOrHostAddressConstKHR<'a>,
        pub displacement_vector_stride: DeviceSize,
        pub displaced_micromap_primitive_flags: DeviceOrHostAddressConstKHR<'a>,
        pub displaced_micromap_primitive_flags_stride: DeviceSize,
        pub index_type: IndexType,
        pub index_buffer: DeviceOrHostAddressConstKHR<'a>,
        pub index_stride: DeviceSize,
        pub base_triangle: u32,
        pub usage_counts_count: u32,
        pub p_usage_counts: *const MicromapUsageEXT,
        pub pp_usage_counts: *const *const MicromapUsageEXT,
        pub micromap: MicromapEXT,
        pub _marker: PhantomData<&'a ()>,
    }

    #[cfg(feature = "debug")]
    impl fmt::Debug for AccelerationStructureTrianglesDisplacementMicromapNV<'_> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.debug_struct("AccelerationStructureTrianglesDisplacementMicromapNV")
                .field("s_type", &self.s_type)
                .field("p_next", &self.p_next)
                .field(
                    "displacement_bias_and_scale_format",
                    &self.displacement_bias_and_scale_format,
                )
                .field(
                    "displacement_vector_format",
                    &self.displacement_vector_format,
                )
                .field(
                    "displacement_bias_and_scale_buffer",
                    &self.displacement_bias_and_scale_buffer,
                )
                .field(
                    "displacement_bias_and_scale_stride",
                    &self.displacement_bias_and_scale_stride,
                )
                .field(
                    "displacement_vector_buffer",
                    &self.displacement_vector_buffer,
                )
                .field(
                    "displacement_vector_stride",
                    &self.displacement_vector_stride,
                )
                .field(
                    "displaced_micromap_primitive_flags",
                    &self.displaced_micromap_primitive_flags,
                )
                .field(
                    "displaced_micromap_primitive_flags_stride",
                    &self.displaced_micromap_primitive_flags_stride,
                )
                .field("index_type", &self.index_type)
                .field("index_buffer", &self.index_buffer)
                .field("index_stride", &self.index_stride)
                .field("base_triangle", &self.base_triangle)
                .field("usage_counts_count", &self.usage_counts_count)
                .field("p_usage_counts", &self.p_usage_counts)
                .field("pp_usage_counts", &self.pp_usage_counts)
                .field("micromap", &self.micromap)
                .finish()
        }
    }

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

    unsafe impl Extends<AccelerationStructureGeometryTrianglesDataKHR<'_>>
        for AccelerationStructureTrianglesDisplacementMicromapNV<'_>
    {
    }

    impl Default for AccelerationStructureTrianglesDisplacementMicromapNV<'_> {
        fn default() -> Self {
            Self {
                s_type: Self::STRUCTURE_TYPE,
                p_next: ptr::null_mut(),
                displacement_bias_and_scale_format: Default::default(),
                displacement_vector_format: Default::default(),
                displacement_bias_and_scale_buffer: Default::default(),
                displacement_bias_and_scale_stride: Default::default(),
                displacement_vector_buffer: Default::default(),
                displacement_vector_stride: Default::default(),
                displaced_micromap_primitive_flags: Default::default(),
                displaced_micromap_primitive_flags_stride: Default::default(),
                index_type: Default::default(),
                index_buffer: Default::default(),
                index_stride: Default::default(),
                base_triangle: Default::default(),
                usage_counts_count: Default::default(),
                p_usage_counts: ptr::null(),
                pp_usage_counts: ptr::null(),
                micromap: Default::default(),
                _marker: PhantomData,
            }
        }
    }

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

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

        #[inline]
        pub fn displacement_bias_and_scale_buffer(
            mut self,
            displacement_bias_and_scale_buffer: DeviceOrHostAddressConstKHR<'a>,
        ) -> Self {
            self.displacement_bias_and_scale_buffer = displacement_bias_and_scale_buffer;
            self
        }

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

        #[inline]
        pub fn displacement_vector_buffer(
            mut self,
            displacement_vector_buffer: DeviceOrHostAddressConstKHR<'a>,
        ) -> Self {
            self.displacement_vector_buffer = displacement_vector_buffer;
            self
        }

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

        #[inline]
        pub fn displaced_micromap_primitive_flags(
            mut self,
            displaced_micromap_primitive_flags: DeviceOrHostAddressConstKHR<'a>,
        ) -> Self {
            self.displaced_micromap_primitive_flags = displaced_micromap_primitive_flags;
            self
        }

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

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

        #[inline]
        pub fn index_buffer(mut self, index_buffer: DeviceOrHostAddressConstKHR<'a>) -> Self {
            self.index_buffer = index_buffer;
            self
        }

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

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

        #[inline]
        pub fn usage_counts(
            mut self,
            usage_counts: Option<&'a [MicromapUsageEXT]>,
            usage_counts_ptrs: Option<&'a [&'a MicromapUsageEXT]>,
        ) -> Self {
            self.usage_counts_count = None
                .or_else(|| usage_counts.as_deref().map(|s| s.len()))
                .or_else(|| usage_counts_ptrs.as_deref().map(|s| s.len()))
                .unwrap_or(0)
                .try_into()
                .unwrap();
            if let Some(s) = &usage_counts_ptrs {
                assert_eq!(s.len(), self.usage_counts_count as usize);
            }
            self.p_usage_counts = usage_counts.map_or(ptr::null(), |s| s.as_ptr() as _);
            self.pp_usage_counts = usage_counts_ptrs.map_or(ptr::null(), |s| s.as_ptr() as _);
            self
        }

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

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

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

        pub const _64_TRIANGLES_64_BYTES_NV: Self = Self(1);
        pub const _256_TRIANGLES_128_BYTES_NV: Self = Self(2);
        pub const _1024_TRIANGLES_128_BYTES_NV: Self = Self(3);
    }

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

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

    pub type VkPhysicalDeviceDisplacementMicromapFeaturesNV =
        PhysicalDeviceDisplacementMicromapFeaturesNV<'static>;
    pub type VkPhysicalDeviceDisplacementMicromapPropertiesNV =
        PhysicalDeviceDisplacementMicromapPropertiesNV<'static>;
    pub type VkAccelerationStructureTrianglesDisplacementMicromapNV =
        AccelerationStructureTrianglesDisplacementMicromapNV<'static>;
    pub type VkDisplacementMicromapFormatNV = DisplacementMicromapFormatNV;
    impl PhysicalDeviceDisplacementMicromapFeaturesNV<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(
            &self,
        ) -> &VkPhysicalDeviceDisplacementMicromapFeaturesNV {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl PhysicalDeviceDisplacementMicromapPropertiesNV<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(
            &self,
        ) -> &VkPhysicalDeviceDisplacementMicromapPropertiesNV {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl AccelerationStructureTrianglesDisplacementMicromapNV<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(
            &self,
        ) -> &VkAccelerationStructureTrianglesDisplacementMicromapNV {
            unsafe { core::mem::transmute(self) }
        }
    }
}