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

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

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

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

    unsafe impl Extends<DeviceQueueCreateInfo<'_>> for DeviceQueueShaderCoreControlCreateInfoARM<'_> {}
    unsafe impl Extends<DeviceCreateInfo<'_>> for DeviceQueueShaderCoreControlCreateInfoARM<'_> {}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    impl fmt::Debug for PhysicalDeviceSchedulingControlsFlagsARM {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            const KNOWN: &[(Flags64, &str)] = &[
                (
                    PhysicalDeviceSchedulingControlsFlagBitsARM::SHADER_CORE_COUNT_ARM.0,
                    "SHADER_CORE_COUNT_ARM",
                ),
                (
                    PhysicalDeviceSchedulingControlsFlagBitsARM::DISPATCH_PARAMETERS_ARM.0,
                    "DISPATCH_PARAMETERS_ARM",
                ),
            ];
            debug_flags(f, KNOWN, self.0)
        }
    }

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

    impl PhysicalDeviceSchedulingControlsFlagBitsARM {
        pub const SHADER_CORE_COUNT_ARM: Self = Self(1 << 0);
        pub const DISPATCH_PARAMETERS_ARM: Self = Self(1 << 1);
    }

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCmdSetDispatchParametersARM.html>
    pub type PFN_vkCmdSetDispatchParametersARM = unsafe extern "system" fn(
        command_buffer: CommandBuffer,
        p_dispatch_parameters: *const DispatchParametersARM<'_>,
    );
}

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

    pub type VkDeviceQueueShaderCoreControlCreateInfoARM =
        DeviceQueueShaderCoreControlCreateInfoARM<'static>;
    pub type VkPhysicalDeviceSchedulingControlsFeaturesARM =
        PhysicalDeviceSchedulingControlsFeaturesARM<'static>;
    pub type VkPhysicalDeviceSchedulingControlsPropertiesARM =
        PhysicalDeviceSchedulingControlsPropertiesARM<'static>;
    pub type VkPhysicalDeviceSchedulingControlsDispatchParametersPropertiesARM =
        PhysicalDeviceSchedulingControlsDispatchParametersPropertiesARM<'static>;
    pub type VkDispatchParametersARM = DispatchParametersARM<'static>;
    pub type VkPhysicalDeviceSchedulingControlsFlagsARM = PhysicalDeviceSchedulingControlsFlagsARM;
    pub type VkPhysicalDeviceSchedulingControlsFlagBitsARM =
        PhysicalDeviceSchedulingControlsFlagBitsARM;
    impl DeviceQueueShaderCoreControlCreateInfoARM<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkDeviceQueueShaderCoreControlCreateInfoARM {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl PhysicalDeviceSchedulingControlsFeaturesARM<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(
            &self,
        ) -> &VkPhysicalDeviceSchedulingControlsFeaturesARM {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl PhysicalDeviceSchedulingControlsPropertiesARM<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(
            &self,
        ) -> &VkPhysicalDeviceSchedulingControlsPropertiesARM {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl PhysicalDeviceSchedulingControlsDispatchParametersPropertiesARM<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(
            &self,
        ) -> &VkPhysicalDeviceSchedulingControlsDispatchParametersPropertiesARM {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl DispatchParametersARM<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkDispatchParametersARM {
            unsafe { core::mem::transmute(self) }
        }
    }
}

pub struct DeviceFn {
    cmd_set_dispatch_parameters: PFN_vkCmdSetDispatchParametersARM,
}

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

impl DeviceFn {
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCmdSetDispatchParametersARM.html>
    #[inline]
    pub unsafe fn cmd_set_dispatch_parameters(
        &self,
        command_buffer: CommandBuffer,
        dispatch_parameters: &DispatchParametersARM<'_>,
    ) {
        unsafe { (self.cmd_set_dispatch_parameters)(command_buffer, dispatch_parameters) }
    }
}