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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
//! <https://registry.khronos.org/vulkan/specs/latest/man/html/VK_ARM_performance_counters_by_region.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_ARM_performance_counters_by_region";

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

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

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

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

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

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkPhysicalDevicePerformanceCountersByRegionPropertiesARM.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct PhysicalDevicePerformanceCountersByRegionPropertiesARM<'a> {
        pub s_type: StructureType,
        pub p_next: *mut c_void,
        pub max_per_region_performance_counters: u32,
        pub performance_counter_region_size: Extent2D,
        pub row_stride_alignment: u32,
        pub region_alignment: u32,
        pub identity_transform_order: Bool32,
        pub _marker: PhantomData<&'a ()>,
    }

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

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

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

    impl Default for PhysicalDevicePerformanceCountersByRegionPropertiesARM<'_> {
        fn default() -> Self {
            Self {
                s_type: Self::STRUCTURE_TYPE,
                p_next: ptr::null_mut(),
                max_per_region_performance_counters: Default::default(),
                performance_counter_region_size: Default::default(),
                row_stride_alignment: Default::default(),
                region_alignment: Default::default(),
                identity_transform_order: Default::default(),
                _marker: PhantomData,
            }
        }
    }

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

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

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

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

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

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

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

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

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

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkPerformanceCounterDescriptionARM.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct PerformanceCounterDescriptionARM<'a> {
        pub s_type: StructureType,
        pub p_next: *mut c_void,
        pub flags: PerformanceCounterDescriptionFlagsARM,
        pub name: ArrayCStr<{ MAX_DESCRIPTION_SIZE as usize }>,
        pub _marker: PhantomData<&'a ()>,
    }

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

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

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

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

        #[inline]
        pub fn name(
            mut self,
            name: &CStr,
        ) -> core::result::Result<Self, CStrTooLargeForStaticArray> {
            self.name.write_c_str(name)?;
            Ok(self)
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkRenderPassPerformanceCountersByRegionBeginInfoARM.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct RenderPassPerformanceCountersByRegionBeginInfoARM<'a> {
        pub s_type: StructureType,
        pub p_next: *mut c_void,
        pub counter_address_count: u32,
        pub p_counter_addresses: *const DeviceAddress,
        pub serialize_regions: Bool32,
        pub counter_index_count: u32,
        pub p_counter_indices: *mut u32,
        pub _marker: PhantomData<&'a ()>,
    }

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

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

    unsafe impl Extends<RenderPassBeginInfo<'_>>
        for RenderPassPerformanceCountersByRegionBeginInfoARM<'_>
    {
    }
    unsafe impl Extends<RenderingInfo<'_>> for RenderPassPerformanceCountersByRegionBeginInfoARM<'_> {}

    impl Default for RenderPassPerformanceCountersByRegionBeginInfoARM<'_> {
        fn default() -> Self {
            Self {
                s_type: Self::STRUCTURE_TYPE,
                p_next: ptr::null_mut(),
                counter_address_count: Default::default(),
                p_counter_addresses: ptr::null(),
                serialize_regions: Default::default(),
                counter_index_count: Default::default(),
                p_counter_indices: ptr::null_mut(),
                _marker: PhantomData,
            }
        }
    }

    impl<'a> RenderPassPerformanceCountersByRegionBeginInfoARM<'a> {
        #[inline]
        pub fn counter_addresses(mut self, counter_addresses: &'a [DeviceAddress]) -> Self {
            self.counter_address_count = counter_addresses.len().try_into().unwrap();
            self.p_counter_addresses = counter_addresses.as_ptr() as _;
            self
        }

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

        #[inline]
        pub fn counter_indices(mut self, counter_indices: &'a mut [u32]) -> Self {
            self.counter_index_count = counter_indices.len().try_into().unwrap();
            self.p_counter_indices = counter_indices.as_mut_ptr() as _;
            self
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkPerformanceCounterDescriptionFlagsARM.html>
    #[repr(transparent)]
    #[derive(Copy, Clone, PartialEq, Eq, Hash)]
    pub struct PerformanceCounterDescriptionFlagsARM(Flags);
    vk_bitflags_wrapped!(PerformanceCounterDescriptionFlagsARM, Flags);

    impl fmt::Debug for PerformanceCounterDescriptionFlagsARM {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            debug_flags(f, &[], self.0)
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkEnumeratePhysicalDeviceQueueFamilyPerformanceCountersByRegionARM.html>
    pub type PFN_vkEnumeratePhysicalDeviceQueueFamilyPerformanceCountersByRegionARM =
        unsafe extern "system" fn(
            physical_device: PhysicalDevice,
            queue_family_index: u32,
            p_counter_count: *mut u32,
            p_counters: *mut PerformanceCounterARM<'_>,
            p_counter_descriptions: *mut PerformanceCounterDescriptionARM<'_>,
        ) -> vk::Result;
}

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

    pub type VkPhysicalDevicePerformanceCountersByRegionFeaturesARM =
        PhysicalDevicePerformanceCountersByRegionFeaturesARM<'static>;
    pub type VkPhysicalDevicePerformanceCountersByRegionPropertiesARM =
        PhysicalDevicePerformanceCountersByRegionPropertiesARM<'static>;
    pub type VkPerformanceCounterARM = PerformanceCounterARM<'static>;
    pub type VkPerformanceCounterDescriptionARM = PerformanceCounterDescriptionARM<'static>;
    pub type VkRenderPassPerformanceCountersByRegionBeginInfoARM =
        RenderPassPerformanceCountersByRegionBeginInfoARM<'static>;
    pub type VkPerformanceCounterDescriptionFlagsARM = PerformanceCounterDescriptionFlagsARM;
    impl PhysicalDevicePerformanceCountersByRegionFeaturesARM<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(
            &self,
        ) -> &VkPhysicalDevicePerformanceCountersByRegionFeaturesARM {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl PhysicalDevicePerformanceCountersByRegionPropertiesARM<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(
            &self,
        ) -> &VkPhysicalDevicePerformanceCountersByRegionPropertiesARM {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl PerformanceCounterARM<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkPerformanceCounterARM {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl PerformanceCounterDescriptionARM<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkPerformanceCounterDescriptionARM {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl RenderPassPerformanceCountersByRegionBeginInfoARM<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(
            &self,
        ) -> &VkRenderPassPerformanceCountersByRegionBeginInfoARM {
            unsafe { core::mem::transmute(self) }
        }
    }
}

pub struct InstanceFn {
    enumerate_physical_device_queue_family_performance_counters_by_region:
        PFN_vkEnumeratePhysicalDeviceQueueFamilyPerformanceCountersByRegionARM,
}

impl LoadInstanceFn for InstanceFn {
    unsafe fn load_with(
        load: impl Fn(&CStr) -> Option<PFN_vkVoidFunction>,
    ) -> core::result::Result<Self, MissingEntryPointError> {
        unsafe {
            Ok(Self {
                enumerate_physical_device_queue_family_performance_counters_by_region: transmute(
                    load(c"vkEnumeratePhysicalDeviceQueueFamilyPerformanceCountersByRegionARM")
                        .ok_or(MissingEntryPointError)?,
                ),
            })
        }
    }
}

impl InstanceFn {
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkEnumeratePhysicalDeviceQueueFamilyPerformanceCountersByRegionARM.html>
    #[inline]
    pub unsafe fn enumerate_physical_device_queue_family_performance_counters_by_region<'a>(
        &self,
        physical_device: PhysicalDevice,
        queue_family_index: u32,
        mut counters: impl EnumerateInto<PerformanceCounterARM<'a>>,
        mut counter_descriptions: impl EnumerateInto<PerformanceCounterDescriptionARM<'a>>,
    ) -> crate::Result<()> {
        unsafe {
            let call = |counter_count, counters, counter_descriptions| {
                let result = (self
                    .enumerate_physical_device_queue_family_performance_counters_by_region)(
                    physical_device,
                    queue_family_index,
                    counter_count,
                    counters as _,
                    counter_descriptions as _,
                );

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