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

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

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/VkPhysicalDeviceHostImageCopyFeaturesEXT.html>
    pub type PhysicalDeviceHostImageCopyFeaturesEXT<'a> = PhysicalDeviceHostImageCopyFeatures<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkPhysicalDeviceHostImageCopyPropertiesEXT.html>
    pub type PhysicalDeviceHostImageCopyPropertiesEXT<'a> =
        PhysicalDeviceHostImageCopyProperties<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkMemoryToImageCopyEXT.html>
    pub type MemoryToImageCopyEXT<'a> = MemoryToImageCopy<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkImageToMemoryCopyEXT.html>
    pub type ImageToMemoryCopyEXT<'a> = ImageToMemoryCopy<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkCopyMemoryToImageInfoEXT.html>
    pub type CopyMemoryToImageInfoEXT<'a> = CopyMemoryToImageInfo<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkCopyImageToMemoryInfoEXT.html>
    pub type CopyImageToMemoryInfoEXT<'a> = CopyImageToMemoryInfo<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkCopyImageToImageInfoEXT.html>
    pub type CopyImageToImageInfoEXT<'a> = CopyImageToImageInfo<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkHostImageLayoutTransitionInfoEXT.html>
    pub type HostImageLayoutTransitionInfoEXT<'a> = HostImageLayoutTransitionInfo<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkSubresourceHostMemcpySizeEXT.html>
    pub type SubresourceHostMemcpySizeEXT<'a> = SubresourceHostMemcpySize<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkHostImageCopyDevicePerformanceQueryEXT.html>
    pub type HostImageCopyDevicePerformanceQueryEXT<'a> = HostImageCopyDevicePerformanceQuery<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkImageSubresource2EXT.html>
    pub type ImageSubresource2EXT<'a> = ImageSubresource2<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkSubresourceLayout2EXT.html>
    pub type SubresourceLayout2EXT<'a> = SubresourceLayout2<'a>;
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/VkHostImageCopyFlagsEXT.html>
    pub type HostImageCopyFlagsEXT = HostImageCopyFlags;
    pub type PFN_vkCopyMemoryToImageEXT = PFN_vkCopyMemoryToImage;
    pub type PFN_vkCopyImageToMemoryEXT = PFN_vkCopyImageToMemory;
    pub type PFN_vkCopyImageToImageEXT = PFN_vkCopyImageToImage;
    pub type PFN_vkTransitionImageLayoutEXT = PFN_vkTransitionImageLayout;
    pub type PFN_vkGetImageSubresourceLayout2EXT = PFN_vkGetImageSubresourceLayout2;
}

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

    pub type VkPhysicalDeviceHostImageCopyFeaturesEXT =
        PhysicalDeviceHostImageCopyFeaturesEXT<'static>;
    pub type VkPhysicalDeviceHostImageCopyPropertiesEXT =
        PhysicalDeviceHostImageCopyPropertiesEXT<'static>;
    pub type VkMemoryToImageCopyEXT = MemoryToImageCopyEXT<'static>;
    pub type VkImageToMemoryCopyEXT = ImageToMemoryCopyEXT<'static>;
    pub type VkCopyMemoryToImageInfoEXT = CopyMemoryToImageInfoEXT<'static>;
    pub type VkCopyImageToMemoryInfoEXT = CopyImageToMemoryInfoEXT<'static>;
    pub type VkCopyImageToImageInfoEXT = CopyImageToImageInfoEXT<'static>;
    pub type VkHostImageLayoutTransitionInfoEXT = HostImageLayoutTransitionInfoEXT<'static>;
    pub type VkSubresourceHostMemcpySizeEXT = SubresourceHostMemcpySizeEXT<'static>;
    pub type VkHostImageCopyDevicePerformanceQueryEXT =
        HostImageCopyDevicePerformanceQueryEXT<'static>;
    pub type VkImageSubresource2EXT = ImageSubresource2EXT<'static>;
    pub type VkSubresourceLayout2EXT = SubresourceLayout2EXT<'static>;
    pub type VkHostImageCopyFlagsEXT = HostImageCopyFlagsEXT;
}

pub struct DeviceFn {
    copy_memory_to_image: PFN_vkCopyMemoryToImage,
    copy_image_to_memory: PFN_vkCopyImageToMemory,
    copy_image_to_image: PFN_vkCopyImageToImage,
    transition_image_layout: PFN_vkTransitionImageLayout,
    get_image_subresource_layout2: PFN_vkGetImageSubresourceLayout2,
}

impl LoadDeviceFn for DeviceFn {
    unsafe fn load_with(
        load: impl Fn(&CStr) -> Option<PFN_vkVoidFunction>,
    ) -> core::result::Result<Self, MissingEntryPointError> {
        unsafe {
            Ok(Self {
                copy_memory_to_image: transmute(
                    load(c"vkCopyMemoryToImageEXT").ok_or(MissingEntryPointError)?,
                ),
                copy_image_to_memory: transmute(
                    load(c"vkCopyImageToMemoryEXT").ok_or(MissingEntryPointError)?,
                ),
                copy_image_to_image: transmute(
                    load(c"vkCopyImageToImageEXT").ok_or(MissingEntryPointError)?,
                ),
                transition_image_layout: transmute(
                    load(c"vkTransitionImageLayoutEXT").ok_or(MissingEntryPointError)?,
                ),
                get_image_subresource_layout2: transmute(
                    load(c"vkGetImageSubresourceLayout2EXT").ok_or(MissingEntryPointError)?,
                ),
            })
        }
    }
}

impl DeviceFn {
    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCopyMemoryToImageEXT.html>
    #[inline]
    pub unsafe fn copy_memory_to_image(
        &self,
        device: Device,
        copy_memory_to_image_info: &CopyMemoryToImageInfo<'_>,
    ) -> crate::Result<()> {
        unsafe {
            let result = (self.copy_memory_to_image)(device, copy_memory_to_image_info);

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCopyImageToMemoryEXT.html>
    #[inline]
    pub unsafe fn copy_image_to_memory(
        &self,
        device: Device,
        copy_image_to_memory_info: &CopyImageToMemoryInfo<'_>,
    ) -> crate::Result<()> {
        unsafe {
            let result = (self.copy_image_to_memory)(device, copy_image_to_memory_info);

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkCopyImageToImageEXT.html>
    #[inline]
    pub unsafe fn copy_image_to_image(
        &self,
        device: Device,
        copy_image_to_image_info: &CopyImageToImageInfo<'_>,
    ) -> crate::Result<()> {
        unsafe {
            let result = (self.copy_image_to_image)(device, copy_image_to_image_info);

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkTransitionImageLayoutEXT.html>
    #[inline]
    pub unsafe fn transition_image_layout(
        &self,
        device: Device,
        transitions: &[HostImageLayoutTransitionInfo<'_>],
    ) -> crate::Result<()> {
        unsafe {
            let result = (self.transition_image_layout)(
                device,
                transitions.len().try_into().unwrap(),
                transitions.as_ptr() as _,
            );

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

    /// <https://registry.khronos.org/vulkan/specs/latest/man/html/vkGetImageSubresourceLayout2EXT.html>
    #[inline]
    pub unsafe fn get_image_subresource_layout2(
        &self,
        device: Device,
        image: Image,
        subresource: &ImageSubresource2<'_>,
        layout: &mut SubresourceLayout2<'_>,
    ) {
        unsafe { (self.get_image_subresource_layout2)(device, image, subresource, layout) }
    }
}