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

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;

    handle_nondispatchable!(
        CuModuleNVX,
        CU_MODULE_NVX,
        doc = "<https://registry.khronos.org/vulkan/specs/latest/man/html/VkCuModuleNVX.html>"
    );
    handle_nondispatchable!(
        CuFunctionNVX,
        CU_FUNCTION_NVX,
        doc = "<https://registry.khronos.org/vulkan/specs/latest/man/html/VkCuFunctionNVX.html>"
    );

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

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

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

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

    impl<'a> CuModuleCreateInfoNVX<'a> {
        #[inline]
        pub fn data(mut self, data: &'a [u8]) -> Self {
            self.data_size = data.len().try_into().unwrap();
            self.p_data = data.as_ptr() as _;
            self
        }
    }

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

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

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

    unsafe impl Extends<CuModuleCreateInfoNVX<'_>> for CuModuleTexturingModeCreateInfoNVX<'_> {}

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

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

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

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

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

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

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

        #[inline]
        pub fn name(mut self, name: &'a CStr) -> Self {
            self.p_name = name.as_ptr();
            self
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkCuLaunchInfoNVX.html>
    #[repr(C)]
    #[derive(Copy, Clone)]
    #[must_use]
    pub struct CuLaunchInfoNVX<'a> {
        pub s_type: StructureType,
        pub p_next: *const c_void,
        pub function: CuFunctionNVX,
        pub grid_dim_x: u32,
        pub grid_dim_y: u32,
        pub grid_dim_z: u32,
        pub block_dim_x: u32,
        pub block_dim_y: u32,
        pub block_dim_z: u32,
        pub shared_mem_bytes: u32,
        pub param_count: usize,
        pub p_params: *const *const c_void,
        pub extra_count: usize,
        pub p_extras: *const *const c_void,
        pub _marker: PhantomData<&'a ()>,
    }

    #[cfg(feature = "debug")]
    impl fmt::Debug for CuLaunchInfoNVX<'_> {
        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
            f.debug_struct("CuLaunchInfoNVX")
                .field("s_type", &self.s_type)
                .field("p_next", &self.p_next)
                .field("function", &self.function)
                .field("grid_dim_x", &self.grid_dim_x)
                .field("grid_dim_y", &self.grid_dim_y)
                .field("grid_dim_z", &self.grid_dim_z)
                .field("block_dim_x", &self.block_dim_x)
                .field("block_dim_y", &self.block_dim_y)
                .field("block_dim_z", &self.block_dim_z)
                .field("shared_mem_bytes", &self.shared_mem_bytes)
                .field("param_count", &self.param_count)
                .field("p_params", &self.p_params)
                .field("extra_count", &self.extra_count)
                .field("p_extras", &self.p_extras)
                .finish()
        }
    }

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

    impl Default for CuLaunchInfoNVX<'_> {
        fn default() -> Self {
            Self {
                s_type: Self::STRUCTURE_TYPE,
                p_next: ptr::null(),
                function: Default::default(),
                grid_dim_x: Default::default(),
                grid_dim_y: Default::default(),
                grid_dim_z: Default::default(),
                block_dim_x: Default::default(),
                block_dim_y: Default::default(),
                block_dim_z: Default::default(),
                shared_mem_bytes: Default::default(),
                param_count: Default::default(),
                p_params: ptr::null(),
                extra_count: Default::default(),
                p_extras: ptr::null(),
                _marker: PhantomData,
            }
        }
    }

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

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

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

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

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

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

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

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

        #[inline]
        pub fn params(mut self, params: &'a [u8]) -> Self {
            self.param_count = params.len().try_into().unwrap();
            self.p_params = params.as_ptr() as _;
            self
        }

        #[inline]
        pub fn extras(mut self, extras: &'a [u8]) -> Self {
            self.extra_count = extras.len().try_into().unwrap();
            self.p_extras = extras.as_ptr() as _;
            self
        }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCreateCuModuleNVX.html>
    pub type PFN_vkCreateCuModuleNVX = unsafe extern "system" fn(
        device: Device,
        p_create_info: *const CuModuleCreateInfoNVX<'_>,
        p_allocator: *const AllocationCallbacks<'_>,
        p_module: *mut CuModuleNVX,
    ) -> vk::Result;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCreateCuFunctionNVX.html>
    pub type PFN_vkCreateCuFunctionNVX = unsafe extern "system" fn(
        device: Device,
        p_create_info: *const CuFunctionCreateInfoNVX<'_>,
        p_allocator: *const AllocationCallbacks<'_>,
        p_function: *mut CuFunctionNVX,
    ) -> vk::Result;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkDestroyCuModuleNVX.html>
    pub type PFN_vkDestroyCuModuleNVX = unsafe extern "system" fn(
        device: Device,
        module: CuModuleNVX,
        p_allocator: *const AllocationCallbacks<'_>,
    );
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkDestroyCuFunctionNVX.html>
    pub type PFN_vkDestroyCuFunctionNVX = unsafe extern "system" fn(
        device: Device,
        function: CuFunctionNVX,
        p_allocator: *const AllocationCallbacks<'_>,
    );
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCmdCuLaunchKernelNVX.html>
    pub type PFN_vkCmdCuLaunchKernelNVX = unsafe extern "system" fn(
        command_buffer: CommandBuffer,
        p_launch_info: *const CuLaunchInfoNVX<'_>,
    );
}

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

    pub type VkCuModuleNVX = CuModuleNVX;
    pub type VkCuFunctionNVX = CuFunctionNVX;
    pub type VkCuModuleCreateInfoNVX = CuModuleCreateInfoNVX<'static>;
    pub type VkCuModuleTexturingModeCreateInfoNVX = CuModuleTexturingModeCreateInfoNVX<'static>;
    pub type VkCuFunctionCreateInfoNVX = CuFunctionCreateInfoNVX<'static>;
    pub type VkCuLaunchInfoNVX = CuLaunchInfoNVX<'static>;
    impl CuModuleCreateInfoNVX<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkCuModuleCreateInfoNVX {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl CuModuleTexturingModeCreateInfoNVX<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkCuModuleTexturingModeCreateInfoNVX {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl CuFunctionCreateInfoNVX<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkCuFunctionCreateInfoNVX {
            unsafe { core::mem::transmute(self) }
        }
    }
    impl CuLaunchInfoNVX<'_> {
        #[inline]
        pub unsafe fn drop_lifetime_for_ffi(&self) -> &VkCuLaunchInfoNVX {
            unsafe { core::mem::transmute(self) }
        }
    }
}

pub struct DeviceFn {
    create_cu_module: PFN_vkCreateCuModuleNVX,
    create_cu_function: PFN_vkCreateCuFunctionNVX,
    destroy_cu_module: PFN_vkDestroyCuModuleNVX,
    destroy_cu_function: PFN_vkDestroyCuFunctionNVX,
    cmd_cu_launch_kernel: PFN_vkCmdCuLaunchKernelNVX,
}

impl LoadDeviceFn for DeviceFn {
    unsafe fn load_with(
        load: impl Fn(&CStr) -> Option<PFN_vkVoidFunction>,
    ) -> core::result::Result<Self, MissingEntryPointError> {
        unsafe {
            Ok(Self {
                create_cu_module: transmute(
                    load(c"vkCreateCuModuleNVX").ok_or(MissingEntryPointError)?,
                ),
                create_cu_function: transmute(
                    load(c"vkCreateCuFunctionNVX").ok_or(MissingEntryPointError)?,
                ),
                destroy_cu_module: transmute(
                    load(c"vkDestroyCuModuleNVX").ok_or(MissingEntryPointError)?,
                ),
                destroy_cu_function: transmute(
                    load(c"vkDestroyCuFunctionNVX").ok_or(MissingEntryPointError)?,
                ),
                cmd_cu_launch_kernel: transmute(
                    load(c"vkCmdCuLaunchKernelNVX").ok_or(MissingEntryPointError)?,
                ),
            })
        }
    }
}

impl DeviceFn {
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCreateCuModuleNVX.html>
    #[inline]
    pub unsafe fn create_cu_module(
        &self,
        device: Device,
        create_info: &CuModuleCreateInfoNVX<'_>,
        allocator: Option<&AllocationCallbacks<'_>>,
    ) -> crate::Result<CuModuleNVX> {
        unsafe {
            let mut module = core::mem::MaybeUninit::uninit();
            let result = (self.create_cu_module)(
                device,
                create_info,
                allocator.to_raw_ptr(),
                module.as_mut_ptr(),
            );

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCreateCuFunctionNVX.html>
    #[inline]
    pub unsafe fn create_cu_function(
        &self,
        device: Device,
        create_info: &CuFunctionCreateInfoNVX<'_>,
        allocator: Option<&AllocationCallbacks<'_>>,
    ) -> crate::Result<CuFunctionNVX> {
        unsafe {
            let mut function = core::mem::MaybeUninit::uninit();
            let result = (self.create_cu_function)(
                device,
                create_info,
                allocator.to_raw_ptr(),
                function.as_mut_ptr(),
            );

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkDestroyCuModuleNVX.html>
    #[inline]
    pub unsafe fn destroy_cu_module(
        &self,
        device: Device,
        module: CuModuleNVX,
        allocator: Option<&AllocationCallbacks<'_>>,
    ) {
        unsafe { (self.destroy_cu_module)(device, module, allocator.to_raw_ptr()) }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkDestroyCuFunctionNVX.html>
    #[inline]
    pub unsafe fn destroy_cu_function(
        &self,
        device: Device,
        function: CuFunctionNVX,
        allocator: Option<&AllocationCallbacks<'_>>,
    ) {
        unsafe { (self.destroy_cu_function)(device, function, allocator.to_raw_ptr()) }
    }

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCmdCuLaunchKernelNVX.html>
    #[inline]
    pub unsafe fn cmd_cu_launch_kernel(
        &self,
        command_buffer: CommandBuffer,
        launch_info: &CuLaunchInfoNVX<'_>,
    ) {
        unsafe { (self.cmd_cu_launch_kernel)(command_buffer, launch_info) }
    }
}