wgpu_hal/vulkan/
conv.rs

1use alloc::vec::Vec;
2
3use ash::vk;
4
5impl super::PrivateCapabilities {
6    pub fn map_texture_format(&self, format: wgt::TextureFormat) -> vk::Format {
7        use ash::vk::Format as F;
8        use wgt::TextureFormat as Tf;
9        use wgt::{AstcBlock, AstcChannel};
10        match format {
11            Tf::R8Unorm => F::R8_UNORM,
12            Tf::R8Snorm => F::R8_SNORM,
13            Tf::R8Uint => F::R8_UINT,
14            Tf::R8Sint => F::R8_SINT,
15            Tf::R16Uint => F::R16_UINT,
16            Tf::R16Sint => F::R16_SINT,
17            Tf::R16Unorm => F::R16_UNORM,
18            Tf::R16Snorm => F::R16_SNORM,
19            Tf::R16Float => F::R16_SFLOAT,
20            Tf::Rg8Unorm => F::R8G8_UNORM,
21            Tf::Rg8Snorm => F::R8G8_SNORM,
22            Tf::Rg8Uint => F::R8G8_UINT,
23            Tf::Rg8Sint => F::R8G8_SINT,
24            Tf::Rg16Unorm => F::R16G16_UNORM,
25            Tf::Rg16Snorm => F::R16G16_SNORM,
26            Tf::R32Uint => F::R32_UINT,
27            Tf::R32Sint => F::R32_SINT,
28            Tf::R32Float => F::R32_SFLOAT,
29            Tf::Rg16Uint => F::R16G16_UINT,
30            Tf::Rg16Sint => F::R16G16_SINT,
31            Tf::Rg16Float => F::R16G16_SFLOAT,
32            Tf::Rgba8Unorm => F::R8G8B8A8_UNORM,
33            Tf::Rgba8UnormSrgb => F::R8G8B8A8_SRGB,
34            Tf::Bgra8UnormSrgb => F::B8G8R8A8_SRGB,
35            Tf::Rgba8Snorm => F::R8G8B8A8_SNORM,
36            Tf::Bgra8Unorm => F::B8G8R8A8_UNORM,
37            Tf::Rgba8Uint => F::R8G8B8A8_UINT,
38            Tf::Rgba8Sint => F::R8G8B8A8_SINT,
39            Tf::Rgb10a2Uint => F::A2B10G10R10_UINT_PACK32,
40            Tf::Rgb10a2Unorm => F::A2B10G10R10_UNORM_PACK32,
41            Tf::Rg11b10Ufloat => F::B10G11R11_UFLOAT_PACK32,
42            Tf::R64Uint => F::R64_UINT,
43            Tf::Rg32Uint => F::R32G32_UINT,
44            Tf::Rg32Sint => F::R32G32_SINT,
45            Tf::Rg32Float => F::R32G32_SFLOAT,
46            Tf::Rgba16Uint => F::R16G16B16A16_UINT,
47            Tf::Rgba16Sint => F::R16G16B16A16_SINT,
48            Tf::Rgba16Unorm => F::R16G16B16A16_UNORM,
49            Tf::Rgba16Snorm => F::R16G16B16A16_SNORM,
50            Tf::Rgba16Float => F::R16G16B16A16_SFLOAT,
51            Tf::Rgba32Uint => F::R32G32B32A32_UINT,
52            Tf::Rgba32Sint => F::R32G32B32A32_SINT,
53            Tf::Rgba32Float => F::R32G32B32A32_SFLOAT,
54            Tf::Depth32Float => F::D32_SFLOAT,
55            Tf::Depth32FloatStencil8 => F::D32_SFLOAT_S8_UINT,
56            Tf::Depth24Plus => {
57                if self.texture_d24 {
58                    F::X8_D24_UNORM_PACK32
59                } else {
60                    F::D32_SFLOAT
61                }
62            }
63            Tf::Depth24PlusStencil8 => {
64                if self.texture_d24_s8 {
65                    F::D24_UNORM_S8_UINT
66                } else {
67                    F::D32_SFLOAT_S8_UINT
68                }
69            }
70            Tf::Stencil8 => {
71                if self.texture_s8 {
72                    F::S8_UINT
73                } else if self.texture_d24_s8 {
74                    F::D24_UNORM_S8_UINT
75                } else {
76                    F::D32_SFLOAT_S8_UINT
77                }
78            }
79            Tf::Depth16Unorm => F::D16_UNORM,
80            Tf::NV12 => F::G8_B8R8_2PLANE_420_UNORM,
81            Tf::P010 => F::G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16,
82            Tf::Rgb9e5Ufloat => F::E5B9G9R9_UFLOAT_PACK32,
83            Tf::Bc1RgbaUnorm => F::BC1_RGBA_UNORM_BLOCK,
84            Tf::Bc1RgbaUnormSrgb => F::BC1_RGBA_SRGB_BLOCK,
85            Tf::Bc2RgbaUnorm => F::BC2_UNORM_BLOCK,
86            Tf::Bc2RgbaUnormSrgb => F::BC2_SRGB_BLOCK,
87            Tf::Bc3RgbaUnorm => F::BC3_UNORM_BLOCK,
88            Tf::Bc3RgbaUnormSrgb => F::BC3_SRGB_BLOCK,
89            Tf::Bc4RUnorm => F::BC4_UNORM_BLOCK,
90            Tf::Bc4RSnorm => F::BC4_SNORM_BLOCK,
91            Tf::Bc5RgUnorm => F::BC5_UNORM_BLOCK,
92            Tf::Bc5RgSnorm => F::BC5_SNORM_BLOCK,
93            Tf::Bc6hRgbUfloat => F::BC6H_UFLOAT_BLOCK,
94            Tf::Bc6hRgbFloat => F::BC6H_SFLOAT_BLOCK,
95            Tf::Bc7RgbaUnorm => F::BC7_UNORM_BLOCK,
96            Tf::Bc7RgbaUnormSrgb => F::BC7_SRGB_BLOCK,
97            Tf::Etc2Rgb8Unorm => F::ETC2_R8G8B8_UNORM_BLOCK,
98            Tf::Etc2Rgb8UnormSrgb => F::ETC2_R8G8B8_SRGB_BLOCK,
99            Tf::Etc2Rgb8A1Unorm => F::ETC2_R8G8B8A1_UNORM_BLOCK,
100            Tf::Etc2Rgb8A1UnormSrgb => F::ETC2_R8G8B8A1_SRGB_BLOCK,
101            Tf::Etc2Rgba8Unorm => F::ETC2_R8G8B8A8_UNORM_BLOCK,
102            Tf::Etc2Rgba8UnormSrgb => F::ETC2_R8G8B8A8_SRGB_BLOCK,
103            Tf::EacR11Unorm => F::EAC_R11_UNORM_BLOCK,
104            Tf::EacR11Snorm => F::EAC_R11_SNORM_BLOCK,
105            Tf::EacRg11Unorm => F::EAC_R11G11_UNORM_BLOCK,
106            Tf::EacRg11Snorm => F::EAC_R11G11_SNORM_BLOCK,
107            Tf::Astc { block, channel } => match channel {
108                AstcChannel::Unorm => match block {
109                    AstcBlock::B4x4 => F::ASTC_4X4_UNORM_BLOCK,
110                    AstcBlock::B5x4 => F::ASTC_5X4_UNORM_BLOCK,
111                    AstcBlock::B5x5 => F::ASTC_5X5_UNORM_BLOCK,
112                    AstcBlock::B6x5 => F::ASTC_6X5_UNORM_BLOCK,
113                    AstcBlock::B6x6 => F::ASTC_6X6_UNORM_BLOCK,
114                    AstcBlock::B8x5 => F::ASTC_8X5_UNORM_BLOCK,
115                    AstcBlock::B8x6 => F::ASTC_8X6_UNORM_BLOCK,
116                    AstcBlock::B8x8 => F::ASTC_8X8_UNORM_BLOCK,
117                    AstcBlock::B10x5 => F::ASTC_10X5_UNORM_BLOCK,
118                    AstcBlock::B10x6 => F::ASTC_10X6_UNORM_BLOCK,
119                    AstcBlock::B10x8 => F::ASTC_10X8_UNORM_BLOCK,
120                    AstcBlock::B10x10 => F::ASTC_10X10_UNORM_BLOCK,
121                    AstcBlock::B12x10 => F::ASTC_12X10_UNORM_BLOCK,
122                    AstcBlock::B12x12 => F::ASTC_12X12_UNORM_BLOCK,
123                },
124                AstcChannel::UnormSrgb => match block {
125                    AstcBlock::B4x4 => F::ASTC_4X4_SRGB_BLOCK,
126                    AstcBlock::B5x4 => F::ASTC_5X4_SRGB_BLOCK,
127                    AstcBlock::B5x5 => F::ASTC_5X5_SRGB_BLOCK,
128                    AstcBlock::B6x5 => F::ASTC_6X5_SRGB_BLOCK,
129                    AstcBlock::B6x6 => F::ASTC_6X6_SRGB_BLOCK,
130                    AstcBlock::B8x5 => F::ASTC_8X5_SRGB_BLOCK,
131                    AstcBlock::B8x6 => F::ASTC_8X6_SRGB_BLOCK,
132                    AstcBlock::B8x8 => F::ASTC_8X8_SRGB_BLOCK,
133                    AstcBlock::B10x5 => F::ASTC_10X5_SRGB_BLOCK,
134                    AstcBlock::B10x6 => F::ASTC_10X6_SRGB_BLOCK,
135                    AstcBlock::B10x8 => F::ASTC_10X8_SRGB_BLOCK,
136                    AstcBlock::B10x10 => F::ASTC_10X10_SRGB_BLOCK,
137                    AstcBlock::B12x10 => F::ASTC_12X10_SRGB_BLOCK,
138                    AstcBlock::B12x12 => F::ASTC_12X12_SRGB_BLOCK,
139                },
140                AstcChannel::Hdr => match block {
141                    AstcBlock::B4x4 => F::ASTC_4X4_SFLOAT_BLOCK_EXT,
142                    AstcBlock::B5x4 => F::ASTC_5X4_SFLOAT_BLOCK_EXT,
143                    AstcBlock::B5x5 => F::ASTC_5X5_SFLOAT_BLOCK_EXT,
144                    AstcBlock::B6x5 => F::ASTC_6X5_SFLOAT_BLOCK_EXT,
145                    AstcBlock::B6x6 => F::ASTC_6X6_SFLOAT_BLOCK_EXT,
146                    AstcBlock::B8x5 => F::ASTC_8X5_SFLOAT_BLOCK_EXT,
147                    AstcBlock::B8x6 => F::ASTC_8X6_SFLOAT_BLOCK_EXT,
148                    AstcBlock::B8x8 => F::ASTC_8X8_SFLOAT_BLOCK_EXT,
149                    AstcBlock::B10x5 => F::ASTC_10X5_SFLOAT_BLOCK_EXT,
150                    AstcBlock::B10x6 => F::ASTC_10X6_SFLOAT_BLOCK_EXT,
151                    AstcBlock::B10x8 => F::ASTC_10X8_SFLOAT_BLOCK_EXT,
152                    AstcBlock::B10x10 => F::ASTC_10X10_SFLOAT_BLOCK_EXT,
153                    AstcBlock::B12x10 => F::ASTC_12X10_SFLOAT_BLOCK_EXT,
154                    AstcBlock::B12x12 => F::ASTC_12X12_SFLOAT_BLOCK_EXT,
155                },
156            },
157        }
158    }
159}
160
161pub fn map_vk_surface_formats(
162    sf: vk::SurfaceFormatKHR,
163) -> Option<(wgt::TextureFormat, wgt::SurfaceColorSpace)> {
164    use ash::vk::Format as F;
165    use wgt::TextureFormat as Tf;
166    // Format list we care about pulled from https://vulkan.gpuinfo.org/listsurfaceformats.php.
167    let format = match sf.format {
168        F::B8G8R8A8_UNORM => Tf::Bgra8Unorm,
169        F::B8G8R8A8_SRGB => Tf::Bgra8UnormSrgb,
170        F::R8G8B8A8_SNORM => Tf::Rgba8Snorm,
171        F::R8G8B8A8_UNORM => Tf::Rgba8Unorm,
172        F::R8G8B8A8_SRGB => Tf::Rgba8UnormSrgb,
173        F::R16G16B16A16_SNORM => Tf::Rgba16Snorm,
174        F::R16G16B16A16_UNORM => Tf::Rgba16Unorm,
175        F::R16G16B16A16_SFLOAT => Tf::Rgba16Float,
176        F::A2B10G10R10_UNORM_PACK32 => Tf::Rgb10a2Unorm,
177        _ => return None,
178    };
179    let color_space = map_vk_color_space(sf.color_space)?;
180    Some((format, color_space))
181}
182
183pub fn map_vk_color_space(color_space: vk::ColorSpaceKHR) -> Option<wgt::SurfaceColorSpace> {
184    use wgt::SurfaceColorSpace as Scs;
185    Some(match color_space {
186        vk::ColorSpaceKHR::SRGB_NONLINEAR => Scs::Srgb,
187        vk::ColorSpaceKHR::EXTENDED_SRGB_LINEAR_EXT => Scs::ExtendedSrgbLinear,
188        vk::ColorSpaceKHR::EXTENDED_SRGB_NONLINEAR_EXT => Scs::ExtendedSrgb,
189        vk::ColorSpaceKHR::DISPLAY_P3_NONLINEAR_EXT => Scs::DisplayP3,
190        vk::ColorSpaceKHR::HDR10_ST2084_EXT => Scs::Bt2100Pq,
191        vk::ColorSpaceKHR::HDR10_HLG_EXT => Scs::Bt2100Hlg,
192        _ => return None,
193    })
194}
195
196pub fn map_surface_color_space(color_space: wgt::SurfaceColorSpace) -> vk::ColorSpaceKHR {
197    use wgt::SurfaceColorSpace as Scs;
198    match color_space {
199        Scs::Auto => unreachable!("wgpu-core resolves `Auto` before configuring the surface"),
200        Scs::Srgb => vk::ColorSpaceKHR::SRGB_NONLINEAR,
201        Scs::ExtendedSrgbLinear => vk::ColorSpaceKHR::EXTENDED_SRGB_LINEAR_EXT,
202        Scs::ExtendedSrgb => vk::ColorSpaceKHR::EXTENDED_SRGB_NONLINEAR_EXT,
203        Scs::DisplayP3 => vk::ColorSpaceKHR::DISPLAY_P3_NONLINEAR_EXT,
204        Scs::Bt2100Pq => vk::ColorSpaceKHR::HDR10_ST2084_EXT,
205        Scs::Bt2100Hlg => vk::ColorSpaceKHR::HDR10_HLG_EXT,
206        Scs::ExtendedDisplayP3 => {
207            unreachable!("`ExtendedDisplayP3` is never reported in the Vulkan surface capabilities")
208        }
209    }
210}
211
212impl crate::Attachment<'_, super::TextureView> {
213    pub(super) fn make_attachment_key(&self, ops: crate::AttachmentOps) -> super::AttachmentKey {
214        super::AttachmentKey {
215            format: self.view.raw_format,
216            layout: derive_image_layout(self.usage, self.view.format),
217            ops,
218        }
219    }
220}
221
222impl crate::ColorAttachment<'_, super::TextureView> {
223    pub(super) unsafe fn make_vk_clear_color(&self) -> vk::ClearColorValue {
224        let cv = &self.clear_value;
225        match self.target.view.format.sample_type(None, None).unwrap() {
226            wgt::TextureSampleType::Float { .. } => vk::ClearColorValue {
227                float32: [cv.r as f32, cv.g as f32, cv.b as f32, cv.a as f32],
228            },
229            wgt::TextureSampleType::Sint => vk::ClearColorValue {
230                int32: [cv.r as i32, cv.g as i32, cv.b as i32, cv.a as i32],
231            },
232            wgt::TextureSampleType::Uint => vk::ClearColorValue {
233                uint32: [cv.r as u32, cv.g as u32, cv.b as u32, cv.a as u32],
234            },
235            wgt::TextureSampleType::Depth => unreachable!(),
236        }
237    }
238}
239
240pub fn derive_image_layout(usage: wgt::TextureUses, format: wgt::TextureFormat) -> vk::ImageLayout {
241    let is_color = !format.is_depth_stencil_format();
242    match usage {
243        wgt::TextureUses::UNINITIALIZED => vk::ImageLayout::UNDEFINED,
244        wgt::TextureUses::COPY_SRC => vk::ImageLayout::TRANSFER_SRC_OPTIMAL,
245        wgt::TextureUses::COPY_DST => vk::ImageLayout::TRANSFER_DST_OPTIMAL,
246        wgt::TextureUses::RESOURCE if is_color => vk::ImageLayout::SHADER_READ_ONLY_OPTIMAL,
247        wgt::TextureUses::COLOR_TARGET => vk::ImageLayout::COLOR_ATTACHMENT_OPTIMAL,
248        _ => {
249            if usage == wgt::TextureUses::PRESENT {
250                vk::ImageLayout::PRESENT_SRC_KHR
251            } else if is_color {
252                vk::ImageLayout::GENERAL
253            } else {
254                match (
255                    usage.contains(wgt::TextureUses::DEPTH_WRITE),
256                    usage.contains(wgt::TextureUses::STENCIL_WRITE),
257                ) {
258                    (true, true) => vk::ImageLayout::DEPTH_STENCIL_ATTACHMENT_OPTIMAL,
259                    (false, true) => vk::ImageLayout::DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL,
260                    (true, false) => vk::ImageLayout::DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL,
261                    (false, false) => vk::ImageLayout::DEPTH_STENCIL_READ_ONLY_OPTIMAL,
262                }
263            }
264        }
265    }
266}
267
268pub fn map_queue_family(family: crate::QueueFamily) -> u32 {
269    match family {
270        crate::QueueFamily::Explicit(index) => index,
271        crate::QueueFamily::External => vk::QUEUE_FAMILY_EXTERNAL,
272        crate::QueueFamily::Foreign => vk::QUEUE_FAMILY_FOREIGN_EXT,
273    }
274}
275
276pub fn map_texture_usage(usage: wgt::TextureUses) -> vk::ImageUsageFlags {
277    let mut flags = vk::ImageUsageFlags::empty();
278    if usage.contains(wgt::TextureUses::COPY_SRC) {
279        flags |= vk::ImageUsageFlags::TRANSFER_SRC;
280    }
281    if usage.contains(wgt::TextureUses::COPY_DST) {
282        flags |= vk::ImageUsageFlags::TRANSFER_DST;
283    }
284    if usage.contains(wgt::TextureUses::RESOURCE) {
285        flags |= vk::ImageUsageFlags::SAMPLED;
286    }
287    if usage.contains(wgt::TextureUses::COLOR_TARGET) {
288        flags |= vk::ImageUsageFlags::COLOR_ATTACHMENT;
289    }
290    if usage.intersects(
291        wgt::TextureUses::DEPTH_READ
292            | wgt::TextureUses::DEPTH_WRITE
293            | wgt::TextureUses::STENCIL_READ
294            | wgt::TextureUses::STENCIL_WRITE,
295    ) {
296        flags |= vk::ImageUsageFlags::DEPTH_STENCIL_ATTACHMENT;
297    }
298    if usage.intersects(
299        wgt::TextureUses::STORAGE_READ_ONLY
300            | wgt::TextureUses::STORAGE_WRITE_ONLY
301            | wgt::TextureUses::STORAGE_READ_WRITE
302            | wgt::TextureUses::STORAGE_ATOMIC,
303    ) {
304        flags |= vk::ImageUsageFlags::STORAGE;
305    }
306    if usage.contains(wgt::TextureUses::TRANSIENT) {
307        flags |= vk::ImageUsageFlags::TRANSIENT_ATTACHMENT;
308    }
309    flags
310}
311
312pub fn map_texture_usage_to_barrier(
313    usage: wgt::TextureUses,
314    queue_flags: vk::QueueFlags,
315    support_store_op_none: bool,
316) -> (vk::PipelineStageFlags, vk::AccessFlags) {
317    let mut stages = vk::PipelineStageFlags::empty();
318    let mut access = vk::AccessFlags::empty();
319    let shader_stages = shader_stages(queue_flags);
320
321    if usage.contains(wgt::TextureUses::COPY_SRC) {
322        stages |= vk::PipelineStageFlags::TRANSFER;
323        access |= vk::AccessFlags::TRANSFER_READ;
324    }
325    if usage.contains(wgt::TextureUses::COPY_DST) {
326        stages |= vk::PipelineStageFlags::TRANSFER;
327        access |= vk::AccessFlags::TRANSFER_WRITE;
328    }
329    if usage.contains(wgt::TextureUses::RESOURCE) {
330        stages |= shader_stages;
331        access |= vk::AccessFlags::SHADER_READ;
332    }
333    if usage.contains(wgt::TextureUses::COLOR_TARGET) {
334        stages |= vk::PipelineStageFlags::COLOR_ATTACHMENT_OUTPUT;
335        access |= vk::AccessFlags::COLOR_ATTACHMENT_READ | vk::AccessFlags::COLOR_ATTACHMENT_WRITE;
336    }
337    if usage.intersects(wgt::TextureUses::DEPTH_READ | wgt::TextureUses::STENCIL_READ) {
338        stages |= vk::PipelineStageFlags::EARLY_FRAGMENT_TESTS
339            | vk::PipelineStageFlags::LATE_FRAGMENT_TESTS;
340        access |= if !support_store_op_none {
341            // If `vk::AttachmentStoreOp::NONE` isn't available we use `vk::AttachmentStoreOp::Store`
342            // for readonly depth-stencil attachments, which needs write access to avoid validation error.
343            vk::AccessFlags::DEPTH_STENCIL_ATTACHMENT_READ
344                | vk::AccessFlags::DEPTH_STENCIL_ATTACHMENT_WRITE
345        } else {
346            vk::AccessFlags::DEPTH_STENCIL_ATTACHMENT_READ
347        }
348    }
349    if usage.intersects(wgt::TextureUses::DEPTH_WRITE | wgt::TextureUses::STENCIL_WRITE) {
350        stages |= vk::PipelineStageFlags::EARLY_FRAGMENT_TESTS
351            | vk::PipelineStageFlags::LATE_FRAGMENT_TESTS;
352        access |= vk::AccessFlags::DEPTH_STENCIL_ATTACHMENT_READ
353            | vk::AccessFlags::DEPTH_STENCIL_ATTACHMENT_WRITE;
354    }
355    if usage.intersects(
356        wgt::TextureUses::STORAGE_READ_ONLY
357            | wgt::TextureUses::STORAGE_READ_WRITE
358            | wgt::TextureUses::STORAGE_ATOMIC,
359    ) {
360        stages |= shader_stages;
361        access |= vk::AccessFlags::SHADER_READ;
362    }
363    if usage.intersects(
364        wgt::TextureUses::STORAGE_WRITE_ONLY
365            | wgt::TextureUses::STORAGE_READ_WRITE
366            | wgt::TextureUses::STORAGE_ATOMIC,
367    ) {
368        stages |= shader_stages;
369        access |= vk::AccessFlags::SHADER_WRITE;
370    }
371
372    if usage == wgt::TextureUses::UNINITIALIZED || usage == wgt::TextureUses::PRESENT {
373        (
374            vk::PipelineStageFlags::TOP_OF_PIPE,
375            vk::AccessFlags::empty(),
376        )
377    } else {
378        (stages, access)
379    }
380}
381
382pub fn map_vk_image_usage(usage: vk::ImageUsageFlags) -> wgt::TextureUses {
383    let mut bits = wgt::TextureUses::empty();
384    if usage.contains(vk::ImageUsageFlags::TRANSFER_SRC) {
385        bits |= wgt::TextureUses::COPY_SRC;
386    }
387    if usage.contains(vk::ImageUsageFlags::TRANSFER_DST) {
388        bits |= wgt::TextureUses::COPY_DST;
389    }
390    if usage.contains(vk::ImageUsageFlags::SAMPLED) {
391        bits |= wgt::TextureUses::RESOURCE;
392    }
393    if usage.contains(vk::ImageUsageFlags::COLOR_ATTACHMENT) {
394        bits |= wgt::TextureUses::COLOR_TARGET;
395    }
396    if usage.contains(vk::ImageUsageFlags::DEPTH_STENCIL_ATTACHMENT) {
397        bits |= wgt::TextureUses::DEPTH_READ
398            | wgt::TextureUses::DEPTH_WRITE
399            | wgt::TextureUses::STENCIL_READ
400            | wgt::TextureUses::STENCIL_WRITE;
401    }
402    if usage.contains(vk::ImageUsageFlags::STORAGE) {
403        bits |= wgt::TextureUses::STORAGE_READ_ONLY
404            | wgt::TextureUses::STORAGE_WRITE_ONLY
405            | wgt::TextureUses::STORAGE_READ_WRITE
406            | wgt::TextureUses::STORAGE_ATOMIC;
407    }
408    if usage.contains(vk::ImageUsageFlags::TRANSIENT_ATTACHMENT) {
409        bits |= wgt::TextureUses::TRANSIENT;
410    }
411    bits
412}
413
414pub fn map_texture_dimension(dim: wgt::TextureDimension) -> vk::ImageType {
415    match dim {
416        wgt::TextureDimension::D1 => vk::ImageType::TYPE_1D,
417        wgt::TextureDimension::D2 => vk::ImageType::TYPE_2D,
418        wgt::TextureDimension::D3 => vk::ImageType::TYPE_3D,
419    }
420}
421
422pub fn map_index_format(index_format: wgt::IndexFormat) -> vk::IndexType {
423    match index_format {
424        wgt::IndexFormat::Uint16 => vk::IndexType::UINT16,
425        wgt::IndexFormat::Uint32 => vk::IndexType::UINT32,
426    }
427}
428
429pub fn map_vertex_format(vertex_format: wgt::VertexFormat) -> vk::Format {
430    use wgt::VertexFormat as Vf;
431    match vertex_format {
432        Vf::Uint8 => vk::Format::R8_UINT,
433        Vf::Uint8x2 => vk::Format::R8G8_UINT,
434        Vf::Uint8x4 => vk::Format::R8G8B8A8_UINT,
435        Vf::Sint8 => vk::Format::R8_SINT,
436        Vf::Sint8x2 => vk::Format::R8G8_SINT,
437        Vf::Sint8x4 => vk::Format::R8G8B8A8_SINT,
438        Vf::Unorm8 => vk::Format::R8_UNORM,
439        Vf::Unorm8x2 => vk::Format::R8G8_UNORM,
440        Vf::Unorm8x4 => vk::Format::R8G8B8A8_UNORM,
441        Vf::Snorm8 => vk::Format::R8_SNORM,
442        Vf::Snorm8x2 => vk::Format::R8G8_SNORM,
443        Vf::Snorm8x4 => vk::Format::R8G8B8A8_SNORM,
444        Vf::Uint16 => vk::Format::R16_UINT,
445        Vf::Uint16x2 => vk::Format::R16G16_UINT,
446        Vf::Uint16x4 => vk::Format::R16G16B16A16_UINT,
447        Vf::Sint16 => vk::Format::R16_SINT,
448        Vf::Sint16x2 => vk::Format::R16G16_SINT,
449        Vf::Sint16x4 => vk::Format::R16G16B16A16_SINT,
450        Vf::Unorm16 => vk::Format::R16_UNORM,
451        Vf::Unorm16x2 => vk::Format::R16G16_UNORM,
452        Vf::Unorm16x4 => vk::Format::R16G16B16A16_UNORM,
453        Vf::Snorm16 => vk::Format::R16_SNORM,
454        Vf::Snorm16x2 => vk::Format::R16G16_SNORM,
455        Vf::Snorm16x4 => vk::Format::R16G16B16A16_SNORM,
456        Vf::Float16 => vk::Format::R16_SFLOAT,
457        Vf::Float16x2 => vk::Format::R16G16_SFLOAT,
458        Vf::Float16x4 => vk::Format::R16G16B16A16_SFLOAT,
459        Vf::Float32 => vk::Format::R32_SFLOAT,
460        Vf::Float32x2 => vk::Format::R32G32_SFLOAT,
461        Vf::Float32x3 => vk::Format::R32G32B32_SFLOAT,
462        Vf::Float32x4 => vk::Format::R32G32B32A32_SFLOAT,
463        Vf::Uint32 => vk::Format::R32_UINT,
464        Vf::Uint32x2 => vk::Format::R32G32_UINT,
465        Vf::Uint32x3 => vk::Format::R32G32B32_UINT,
466        Vf::Uint32x4 => vk::Format::R32G32B32A32_UINT,
467        Vf::Sint32 => vk::Format::R32_SINT,
468        Vf::Sint32x2 => vk::Format::R32G32_SINT,
469        Vf::Sint32x3 => vk::Format::R32G32B32_SINT,
470        Vf::Sint32x4 => vk::Format::R32G32B32A32_SINT,
471        Vf::Float64 => vk::Format::R64_SFLOAT,
472        Vf::Float64x2 => vk::Format::R64G64_SFLOAT,
473        Vf::Float64x3 => vk::Format::R64G64B64_SFLOAT,
474        Vf::Float64x4 => vk::Format::R64G64B64A64_SFLOAT,
475        Vf::Unorm10_10_10_2 => vk::Format::A2B10G10R10_UNORM_PACK32,
476        // Note that, unlike the unorm variant, this format has no mandatory format
477        // features in Vulkan, so vertex buffer support is not guaranteed.
478        Vf::Snorm10_10_10_2 => vk::Format::A2B10G10R10_SNORM_PACK32,
479        Vf::Unorm8x4Bgra => vk::Format::B8G8R8A8_UNORM,
480    }
481}
482
483pub fn map_aspects(aspects: crate::FormatAspects) -> vk::ImageAspectFlags {
484    let mut flags = vk::ImageAspectFlags::empty();
485    if aspects.contains(crate::FormatAspects::COLOR) {
486        flags |= vk::ImageAspectFlags::COLOR;
487    }
488    if aspects.contains(crate::FormatAspects::DEPTH) {
489        flags |= vk::ImageAspectFlags::DEPTH;
490    }
491    if aspects.contains(crate::FormatAspects::STENCIL) {
492        flags |= vk::ImageAspectFlags::STENCIL;
493    }
494    if aspects.contains(crate::FormatAspects::PLANE_0) {
495        flags |= vk::ImageAspectFlags::PLANE_0;
496    }
497    if aspects.contains(crate::FormatAspects::PLANE_1) {
498        flags |= vk::ImageAspectFlags::PLANE_1;
499    }
500    if aspects.contains(crate::FormatAspects::PLANE_2) {
501        flags |= vk::ImageAspectFlags::PLANE_2;
502    }
503    flags
504}
505
506pub fn map_attachment_ops(
507    op: crate::AttachmentOps,
508) -> (vk::AttachmentLoadOp, vk::AttachmentStoreOp) {
509    let load_op = if op.contains(crate::AttachmentOps::LOAD) {
510        vk::AttachmentLoadOp::LOAD
511    } else if op.contains(crate::AttachmentOps::LOAD_DONT_CARE) {
512        vk::AttachmentLoadOp::DONT_CARE
513    } else if op.contains(crate::AttachmentOps::LOAD_CLEAR) {
514        vk::AttachmentLoadOp::CLEAR
515    } else {
516        unreachable!()
517    };
518    let store_op = if op.contains(crate::AttachmentOps::STORE) {
519        vk::AttachmentStoreOp::STORE
520    } else if op.contains(crate::AttachmentOps::STORE_DISCARD) {
521        vk::AttachmentStoreOp::DONT_CARE
522    } else {
523        unreachable!()
524    };
525    (load_op, store_op)
526}
527
528pub fn map_present_mode(mode: wgt::PresentMode) -> vk::PresentModeKHR {
529    match mode {
530        wgt::PresentMode::Immediate => vk::PresentModeKHR::IMMEDIATE,
531        wgt::PresentMode::Mailbox => vk::PresentModeKHR::MAILBOX,
532        wgt::PresentMode::Fifo => vk::PresentModeKHR::FIFO,
533        wgt::PresentMode::FifoRelaxed => vk::PresentModeKHR::FIFO_RELAXED,
534        wgt::PresentMode::AutoNoVsync | wgt::PresentMode::AutoVsync => {
535            unreachable!("Cannot create swapchain with Auto PresentationMode")
536        }
537    }
538}
539
540pub fn map_vk_present_mode(mode: vk::PresentModeKHR) -> Option<wgt::PresentMode> {
541    // Not exposed in Ash yet.
542    const FIFO_LATEST_READY: vk::PresentModeKHR = vk::PresentModeKHR::from_raw(1_000_361_000);
543
544    // See https://registry.khronos.org/vulkan/specs/latest/man/html/VkPresentModeKHR.html
545    match mode {
546        vk::PresentModeKHR::IMMEDIATE => Some(wgt::PresentMode::Immediate),
547        vk::PresentModeKHR::MAILBOX => Some(wgt::PresentMode::Mailbox),
548        vk::PresentModeKHR::FIFO => Some(wgt::PresentMode::Fifo),
549        vk::PresentModeKHR::FIFO_RELAXED => Some(wgt::PresentMode::FifoRelaxed),
550
551        // Modes that aren't exposed yet.
552        vk::PresentModeKHR::SHARED_DEMAND_REFRESH => None,
553        vk::PresentModeKHR::SHARED_CONTINUOUS_REFRESH => None,
554        FIFO_LATEST_READY => None,
555
556        _ => {
557            log::debug!("Unrecognized present mode {mode:?}");
558            None
559        }
560    }
561}
562
563pub fn map_composite_alpha_mode(mode: wgt::CompositeAlphaMode) -> vk::CompositeAlphaFlagsKHR {
564    match mode {
565        wgt::CompositeAlphaMode::Opaque => vk::CompositeAlphaFlagsKHR::OPAQUE,
566        wgt::CompositeAlphaMode::PreMultiplied => vk::CompositeAlphaFlagsKHR::PRE_MULTIPLIED,
567        wgt::CompositeAlphaMode::PostMultiplied => vk::CompositeAlphaFlagsKHR::POST_MULTIPLIED,
568        wgt::CompositeAlphaMode::Inherit => vk::CompositeAlphaFlagsKHR::INHERIT,
569        wgt::CompositeAlphaMode::Auto => unreachable!(),
570    }
571}
572
573pub fn map_vk_composite_alpha(flags: vk::CompositeAlphaFlagsKHR) -> Vec<wgt::CompositeAlphaMode> {
574    let mut modes = Vec::new();
575    if flags.contains(vk::CompositeAlphaFlagsKHR::OPAQUE) {
576        modes.push(wgt::CompositeAlphaMode::Opaque);
577    }
578    if flags.contains(vk::CompositeAlphaFlagsKHR::PRE_MULTIPLIED) {
579        modes.push(wgt::CompositeAlphaMode::PreMultiplied);
580    }
581    if flags.contains(vk::CompositeAlphaFlagsKHR::POST_MULTIPLIED) {
582        modes.push(wgt::CompositeAlphaMode::PostMultiplied);
583    }
584    if flags.contains(vk::CompositeAlphaFlagsKHR::INHERIT) {
585        modes.push(wgt::CompositeAlphaMode::Inherit);
586    }
587    modes
588}
589
590pub fn map_buffer_usage(usage: wgt::BufferUses) -> vk::BufferUsageFlags {
591    let mut flags = vk::BufferUsageFlags::empty();
592    if usage.contains(wgt::BufferUses::COPY_SRC) {
593        flags |= vk::BufferUsageFlags::TRANSFER_SRC;
594    }
595    if usage.contains(wgt::BufferUses::COPY_DST) {
596        flags |= vk::BufferUsageFlags::TRANSFER_DST;
597    }
598    if usage.contains(wgt::BufferUses::UNIFORM) {
599        flags |= vk::BufferUsageFlags::UNIFORM_BUFFER;
600    }
601    if usage.intersects(wgt::BufferUses::STORAGE_READ_ONLY | wgt::BufferUses::STORAGE_READ_WRITE) {
602        flags |= vk::BufferUsageFlags::STORAGE_BUFFER;
603    }
604    if usage.contains(wgt::BufferUses::INDEX) {
605        flags |= vk::BufferUsageFlags::INDEX_BUFFER;
606    }
607    if usage.contains(wgt::BufferUses::VERTEX) {
608        flags |= vk::BufferUsageFlags::VERTEX_BUFFER;
609    }
610    if usage.contains(wgt::BufferUses::INDIRECT) {
611        flags |= vk::BufferUsageFlags::INDIRECT_BUFFER;
612    }
613    if usage.contains(wgt::BufferUses::ACCELERATION_STRUCTURE_SCRATCH) {
614        flags |= vk::BufferUsageFlags::STORAGE_BUFFER | vk::BufferUsageFlags::SHADER_DEVICE_ADDRESS;
615    }
616    if usage.intersects(
617        wgt::BufferUses::BOTTOM_LEVEL_ACCELERATION_STRUCTURE_INPUT
618            | wgt::BufferUses::TOP_LEVEL_ACCELERATION_STRUCTURE_INPUT,
619    ) {
620        flags |= vk::BufferUsageFlags::ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_KHR
621            | vk::BufferUsageFlags::SHADER_DEVICE_ADDRESS;
622    }
623    if usage.intersects(wgt::BufferUses::ACCELERATION_STRUCTURE_QUERY) {
624        flags |= vk::BufferUsageFlags::TRANSFER_DST;
625    }
626    if usage.intersects(wgt::BufferUses::RAY_TRACING_PIPELINE_SHADER_DATA) {
627        flags |= vk::BufferUsageFlags::SHADER_BINDING_TABLE_KHR
628            | vk::BufferUsageFlags::SHADER_DEVICE_ADDRESS;
629    }
630    flags
631}
632
633pub fn map_buffer_usage_to_barrier(
634    usage: wgt::BufferUses,
635    queue_flags: vk::QueueFlags,
636) -> (vk::PipelineStageFlags, vk::AccessFlags) {
637    let mut stages = vk::PipelineStageFlags::empty();
638    let mut access = vk::AccessFlags::empty();
639    let shader_stages = shader_stages(queue_flags);
640
641    if usage.contains(wgt::BufferUses::MAP_READ) {
642        stages |= vk::PipelineStageFlags::HOST;
643        access |= vk::AccessFlags::HOST_READ;
644    }
645    if usage.contains(wgt::BufferUses::MAP_WRITE) {
646        stages |= vk::PipelineStageFlags::HOST;
647        access |= vk::AccessFlags::HOST_WRITE;
648    }
649    if usage.contains(wgt::BufferUses::COPY_SRC) {
650        stages |= vk::PipelineStageFlags::TRANSFER;
651        access |= vk::AccessFlags::TRANSFER_READ;
652    }
653    if usage.contains(wgt::BufferUses::COPY_DST) {
654        stages |= vk::PipelineStageFlags::TRANSFER;
655        access |= vk::AccessFlags::TRANSFER_WRITE;
656    }
657    if usage.contains(wgt::BufferUses::UNIFORM) {
658        stages |= shader_stages;
659        access |= vk::AccessFlags::UNIFORM_READ;
660    }
661    if usage.intersects(wgt::BufferUses::STORAGE_READ_ONLY) {
662        stages |= shader_stages;
663        access |= vk::AccessFlags::SHADER_READ;
664    }
665    if usage.intersects(wgt::BufferUses::STORAGE_READ_WRITE) {
666        stages |= shader_stages;
667        access |= vk::AccessFlags::SHADER_READ | vk::AccessFlags::SHADER_WRITE;
668    }
669    if usage.contains(wgt::BufferUses::INDEX) {
670        stages |= vk::PipelineStageFlags::VERTEX_INPUT;
671        access |= vk::AccessFlags::INDEX_READ;
672    }
673    if usage.contains(wgt::BufferUses::VERTEX) {
674        stages |= vk::PipelineStageFlags::VERTEX_INPUT;
675        access |= vk::AccessFlags::VERTEX_ATTRIBUTE_READ;
676    }
677    if usage.contains(wgt::BufferUses::INDIRECT) {
678        stages |= vk::PipelineStageFlags::DRAW_INDIRECT;
679        access |= vk::AccessFlags::INDIRECT_COMMAND_READ;
680    }
681    if usage.intersects(
682        wgt::BufferUses::BOTTOM_LEVEL_ACCELERATION_STRUCTURE_INPUT
683            | wgt::BufferUses::TOP_LEVEL_ACCELERATION_STRUCTURE_INPUT
684            | wgt::BufferUses::ACCELERATION_STRUCTURE_SCRATCH,
685    ) {
686        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
687        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR
688            | vk::AccessFlags::ACCELERATION_STRUCTURE_WRITE_KHR
689            | vk::AccessFlags::SHADER_READ;
690    }
691    if usage.contains(wgt::BufferUses::ACCELERATION_STRUCTURE_QUERY) {
692        stages |= vk::PipelineStageFlags::TRANSFER;
693        access |= vk::AccessFlags::TRANSFER_WRITE;
694    }
695
696    (stages, access)
697}
698
699fn shader_stages(queue_flags: vk::QueueFlags) -> vk::PipelineStageFlags {
700    let mut stages = vk::PipelineStageFlags::empty();
701
702    if queue_flags.contains(vk::QueueFlags::GRAPHICS) {
703        stages |= vk::PipelineStageFlags::VERTEX_SHADER | vk::PipelineStageFlags::FRAGMENT_SHADER;
704    }
705    if queue_flags.contains(vk::QueueFlags::COMPUTE) {
706        stages |= vk::PipelineStageFlags::COMPUTE_SHADER;
707    }
708
709    stages
710}
711
712pub fn map_view_dimension(dim: wgt::TextureViewDimension) -> vk::ImageViewType {
713    match dim {
714        wgt::TextureViewDimension::D1 => vk::ImageViewType::TYPE_1D,
715        wgt::TextureViewDimension::D2 => vk::ImageViewType::TYPE_2D,
716        wgt::TextureViewDimension::D2Array => vk::ImageViewType::TYPE_2D_ARRAY,
717        wgt::TextureViewDimension::Cube => vk::ImageViewType::CUBE,
718        wgt::TextureViewDimension::CubeArray => vk::ImageViewType::CUBE_ARRAY,
719        wgt::TextureViewDimension::D3 => vk::ImageViewType::TYPE_3D,
720    }
721}
722
723pub fn map_copy_extent(extent: &crate::CopyExtent) -> vk::Extent3D {
724    vk::Extent3D {
725        width: extent.width,
726        height: extent.height,
727        depth: extent.depth,
728    }
729}
730
731pub fn map_subresource_range(
732    range: &wgt::ImageSubresourceRange,
733    format: wgt::TextureFormat,
734) -> vk::ImageSubresourceRange {
735    vk::ImageSubresourceRange {
736        aspect_mask: map_aspects(crate::FormatAspects::new(format, range.aspect)),
737        base_mip_level: range.base_mip_level,
738        level_count: range.mip_level_count.unwrap_or(vk::REMAINING_MIP_LEVELS),
739        base_array_layer: range.base_array_layer,
740        layer_count: range
741            .array_layer_count
742            .unwrap_or(vk::REMAINING_ARRAY_LAYERS),
743    }
744}
745
746// Special subresource range mapping for dealing with barriers
747// so that we account for the "hidden" depth aspect in emulated Stencil8.
748pub(super) fn map_subresource_range_combined_aspect(
749    range: &wgt::ImageSubresourceRange,
750    format: wgt::TextureFormat,
751    private_caps: &super::PrivateCapabilities,
752) -> vk::ImageSubresourceRange {
753    let mut range = map_subresource_range(range, format);
754    if !private_caps.texture_s8 && format == wgt::TextureFormat::Stencil8 {
755        range.aspect_mask |= vk::ImageAspectFlags::DEPTH;
756    }
757    range
758}
759
760pub fn map_subresource_layers(
761    base: &crate::TextureCopyBase,
762) -> (vk::ImageSubresourceLayers, vk::Offset3D) {
763    let offset = vk::Offset3D {
764        x: base.origin.x as i32,
765        y: base.origin.y as i32,
766        z: base.origin.z as i32,
767    };
768    let subresource = vk::ImageSubresourceLayers {
769        aspect_mask: map_aspects(base.aspect),
770        mip_level: base.mip_level,
771        base_array_layer: base.array_layer,
772        layer_count: 1,
773    };
774    (subresource, offset)
775}
776
777pub fn map_filter_mode(mode: wgt::FilterMode) -> vk::Filter {
778    match mode {
779        wgt::FilterMode::Nearest => vk::Filter::NEAREST,
780        wgt::FilterMode::Linear => vk::Filter::LINEAR,
781    }
782}
783
784pub fn map_mip_filter_mode(mode: wgt::MipmapFilterMode) -> vk::SamplerMipmapMode {
785    match mode {
786        wgt::MipmapFilterMode::Nearest => vk::SamplerMipmapMode::NEAREST,
787        wgt::MipmapFilterMode::Linear => vk::SamplerMipmapMode::LINEAR,
788    }
789}
790
791pub fn map_address_mode(mode: wgt::AddressMode) -> vk::SamplerAddressMode {
792    match mode {
793        wgt::AddressMode::ClampToEdge => vk::SamplerAddressMode::CLAMP_TO_EDGE,
794        wgt::AddressMode::Repeat => vk::SamplerAddressMode::REPEAT,
795        wgt::AddressMode::MirrorRepeat => vk::SamplerAddressMode::MIRRORED_REPEAT,
796        wgt::AddressMode::ClampToBorder => vk::SamplerAddressMode::CLAMP_TO_BORDER,
797        // wgt::AddressMode::MirrorClamp => vk::SamplerAddressMode::MIRROR_CLAMP_TO_EDGE,
798    }
799}
800
801pub fn map_border_color(border_color: wgt::SamplerBorderColor) -> vk::BorderColor {
802    match border_color {
803        wgt::SamplerBorderColor::TransparentBlack | wgt::SamplerBorderColor::Zero => {
804            vk::BorderColor::FLOAT_TRANSPARENT_BLACK
805        }
806        wgt::SamplerBorderColor::OpaqueBlack => vk::BorderColor::FLOAT_OPAQUE_BLACK,
807        wgt::SamplerBorderColor::OpaqueWhite => vk::BorderColor::FLOAT_OPAQUE_WHITE,
808    }
809}
810
811pub fn map_comparison(fun: wgt::CompareFunction) -> vk::CompareOp {
812    use wgt::CompareFunction as Cf;
813    match fun {
814        Cf::Never => vk::CompareOp::NEVER,
815        Cf::Less => vk::CompareOp::LESS,
816        Cf::LessEqual => vk::CompareOp::LESS_OR_EQUAL,
817        Cf::Equal => vk::CompareOp::EQUAL,
818        Cf::GreaterEqual => vk::CompareOp::GREATER_OR_EQUAL,
819        Cf::Greater => vk::CompareOp::GREATER,
820        Cf::NotEqual => vk::CompareOp::NOT_EQUAL,
821        Cf::Always => vk::CompareOp::ALWAYS,
822    }
823}
824
825pub fn map_shader_stage(stage: wgt::ShaderStages) -> vk::ShaderStageFlags {
826    let mut flags = vk::ShaderStageFlags::empty();
827    if stage.contains(wgt::ShaderStages::VERTEX) {
828        flags |= vk::ShaderStageFlags::VERTEX;
829    }
830    if stage.contains(wgt::ShaderStages::FRAGMENT) {
831        flags |= vk::ShaderStageFlags::FRAGMENT;
832    }
833    if stage.contains(wgt::ShaderStages::COMPUTE) {
834        flags |= vk::ShaderStageFlags::COMPUTE;
835    }
836    if stage.contains(wgt::ShaderStages::TASK) {
837        flags |= vk::ShaderStageFlags::TASK_EXT;
838    }
839    if stage.contains(wgt::ShaderStages::MESH) {
840        flags |= vk::ShaderStageFlags::MESH_EXT;
841    }
842    if stage.contains(wgt::ShaderStages::RAY_GENERATION) {
843        flags |= vk::ShaderStageFlags::RAYGEN_KHR;
844    }
845    if stage.contains(wgt::ShaderStages::MISS) {
846        flags |= vk::ShaderStageFlags::MISS_KHR;
847    }
848    if stage.contains(wgt::ShaderStages::ANY_HIT) {
849        flags |= vk::ShaderStageFlags::ANY_HIT_KHR;
850    }
851    if stage.contains(wgt::ShaderStages::CLOSEST_HIT) {
852        flags |= vk::ShaderStageFlags::CLOSEST_HIT_KHR;
853    }
854    flags
855}
856
857pub fn map_binding_type(ty: wgt::BindingType) -> vk::DescriptorType {
858    match ty {
859        wgt::BindingType::Buffer {
860            ty,
861            has_dynamic_offset,
862            ..
863        } => match ty {
864            wgt::BufferBindingType::Storage { .. } => match has_dynamic_offset {
865                true => vk::DescriptorType::STORAGE_BUFFER_DYNAMIC,
866                false => vk::DescriptorType::STORAGE_BUFFER,
867            },
868            wgt::BufferBindingType::Uniform => match has_dynamic_offset {
869                true => vk::DescriptorType::UNIFORM_BUFFER_DYNAMIC,
870                false => vk::DescriptorType::UNIFORM_BUFFER,
871            },
872        },
873        wgt::BindingType::Sampler { .. } => vk::DescriptorType::SAMPLER,
874        wgt::BindingType::Texture { .. } => vk::DescriptorType::SAMPLED_IMAGE,
875        wgt::BindingType::StorageTexture { .. } => vk::DescriptorType::STORAGE_IMAGE,
876        wgt::BindingType::AccelerationStructure { .. } => {
877            vk::DescriptorType::ACCELERATION_STRUCTURE_KHR
878        }
879        wgt::BindingType::ExternalTexture => unimplemented!(),
880    }
881}
882
883pub fn map_topology(topology: wgt::PrimitiveTopology) -> vk::PrimitiveTopology {
884    use wgt::PrimitiveTopology as Pt;
885    match topology {
886        Pt::PointList => vk::PrimitiveTopology::POINT_LIST,
887        Pt::LineList => vk::PrimitiveTopology::LINE_LIST,
888        Pt::LineStrip => vk::PrimitiveTopology::LINE_STRIP,
889        Pt::TriangleList => vk::PrimitiveTopology::TRIANGLE_LIST,
890        Pt::TriangleStrip => vk::PrimitiveTopology::TRIANGLE_STRIP,
891    }
892}
893
894pub fn map_polygon_mode(mode: wgt::PolygonMode) -> vk::PolygonMode {
895    match mode {
896        wgt::PolygonMode::Fill => vk::PolygonMode::FILL,
897        wgt::PolygonMode::Line => vk::PolygonMode::LINE,
898        wgt::PolygonMode::Point => vk::PolygonMode::POINT,
899    }
900}
901
902pub fn map_front_face(front_face: wgt::FrontFace) -> vk::FrontFace {
903    match front_face {
904        wgt::FrontFace::Cw => vk::FrontFace::CLOCKWISE,
905        wgt::FrontFace::Ccw => vk::FrontFace::COUNTER_CLOCKWISE,
906    }
907}
908
909pub fn map_cull_face(face: wgt::Face) -> vk::CullModeFlags {
910    match face {
911        wgt::Face::Front => vk::CullModeFlags::FRONT,
912        wgt::Face::Back => vk::CullModeFlags::BACK,
913    }
914}
915
916pub fn map_stencil_op(op: wgt::StencilOperation) -> vk::StencilOp {
917    use wgt::StencilOperation as So;
918    match op {
919        So::Keep => vk::StencilOp::KEEP,
920        So::Zero => vk::StencilOp::ZERO,
921        So::Replace => vk::StencilOp::REPLACE,
922        So::Invert => vk::StencilOp::INVERT,
923        So::IncrementClamp => vk::StencilOp::INCREMENT_AND_CLAMP,
924        So::IncrementWrap => vk::StencilOp::INCREMENT_AND_WRAP,
925        So::DecrementClamp => vk::StencilOp::DECREMENT_AND_CLAMP,
926        So::DecrementWrap => vk::StencilOp::DECREMENT_AND_WRAP,
927    }
928}
929
930pub fn map_stencil_face(
931    face: &wgt::StencilFaceState,
932    compare_mask: u32,
933    write_mask: u32,
934) -> vk::StencilOpState {
935    vk::StencilOpState {
936        fail_op: map_stencil_op(face.fail_op),
937        pass_op: map_stencil_op(face.pass_op),
938        depth_fail_op: map_stencil_op(face.depth_fail_op),
939        compare_op: map_comparison(face.compare),
940        compare_mask,
941        write_mask,
942        reference: 0,
943    }
944}
945
946fn map_blend_factor(factor: wgt::BlendFactor) -> vk::BlendFactor {
947    use wgt::BlendFactor as Bf;
948    match factor {
949        Bf::Zero => vk::BlendFactor::ZERO,
950        Bf::One => vk::BlendFactor::ONE,
951        Bf::Src => vk::BlendFactor::SRC_COLOR,
952        Bf::OneMinusSrc => vk::BlendFactor::ONE_MINUS_SRC_COLOR,
953        Bf::SrcAlpha => vk::BlendFactor::SRC_ALPHA,
954        Bf::OneMinusSrcAlpha => vk::BlendFactor::ONE_MINUS_SRC_ALPHA,
955        Bf::Dst => vk::BlendFactor::DST_COLOR,
956        Bf::OneMinusDst => vk::BlendFactor::ONE_MINUS_DST_COLOR,
957        Bf::DstAlpha => vk::BlendFactor::DST_ALPHA,
958        Bf::OneMinusDstAlpha => vk::BlendFactor::ONE_MINUS_DST_ALPHA,
959        Bf::SrcAlphaSaturated => vk::BlendFactor::SRC_ALPHA_SATURATE,
960        Bf::Constant => vk::BlendFactor::CONSTANT_COLOR,
961        Bf::OneMinusConstant => vk::BlendFactor::ONE_MINUS_CONSTANT_COLOR,
962        Bf::Src1 => vk::BlendFactor::SRC1_COLOR,
963        Bf::OneMinusSrc1 => vk::BlendFactor::ONE_MINUS_SRC1_COLOR,
964        Bf::Src1Alpha => vk::BlendFactor::SRC1_ALPHA,
965        Bf::OneMinusSrc1Alpha => vk::BlendFactor::ONE_MINUS_SRC1_ALPHA,
966    }
967}
968
969fn map_blend_op(operation: wgt::BlendOperation) -> vk::BlendOp {
970    use wgt::BlendOperation as Bo;
971    match operation {
972        Bo::Add => vk::BlendOp::ADD,
973        Bo::Subtract => vk::BlendOp::SUBTRACT,
974        Bo::ReverseSubtract => vk::BlendOp::REVERSE_SUBTRACT,
975        Bo::Min => vk::BlendOp::MIN,
976        Bo::Max => vk::BlendOp::MAX,
977    }
978}
979
980pub fn map_blend_component(
981    component: &wgt::BlendComponent,
982) -> (vk::BlendOp, vk::BlendFactor, vk::BlendFactor) {
983    let op = map_blend_op(component.operation);
984    let src = map_blend_factor(component.src_factor);
985    let dst = map_blend_factor(component.dst_factor);
986    (op, src, dst)
987}
988
989pub fn map_pipeline_statistics(
990    types: wgt::PipelineStatisticsTypes,
991) -> vk::QueryPipelineStatisticFlags {
992    use wgt::PipelineStatisticsTypes as Pst;
993    let mut flags = vk::QueryPipelineStatisticFlags::empty();
994    if types.contains(Pst::VERTEX_SHADER_INVOCATIONS) {
995        flags |= vk::QueryPipelineStatisticFlags::VERTEX_SHADER_INVOCATIONS;
996    }
997    if types.contains(Pst::CLIPPER_INVOCATIONS) {
998        flags |= vk::QueryPipelineStatisticFlags::CLIPPING_INVOCATIONS;
999    }
1000    if types.contains(Pst::CLIPPER_PRIMITIVES_OUT) {
1001        flags |= vk::QueryPipelineStatisticFlags::CLIPPING_PRIMITIVES;
1002    }
1003    if types.contains(Pst::FRAGMENT_SHADER_INVOCATIONS) {
1004        flags |= vk::QueryPipelineStatisticFlags::FRAGMENT_SHADER_INVOCATIONS;
1005    }
1006    if types.contains(Pst::COMPUTE_SHADER_INVOCATIONS) {
1007        flags |= vk::QueryPipelineStatisticFlags::COMPUTE_SHADER_INVOCATIONS;
1008    }
1009    flags
1010}
1011
1012pub fn map_acceleration_structure_format(
1013    format: crate::AccelerationStructureFormat,
1014) -> vk::AccelerationStructureTypeKHR {
1015    match format {
1016        crate::AccelerationStructureFormat::TopLevel => vk::AccelerationStructureTypeKHR::TOP_LEVEL,
1017        crate::AccelerationStructureFormat::BottomLevel => {
1018            vk::AccelerationStructureTypeKHR::BOTTOM_LEVEL
1019        }
1020    }
1021}
1022
1023pub fn map_acceleration_structure_build_mode(
1024    format: crate::AccelerationStructureBuildMode,
1025) -> vk::BuildAccelerationStructureModeKHR {
1026    match format {
1027        crate::AccelerationStructureBuildMode::Build => {
1028            vk::BuildAccelerationStructureModeKHR::BUILD
1029        }
1030        crate::AccelerationStructureBuildMode::Update => {
1031            vk::BuildAccelerationStructureModeKHR::UPDATE
1032        }
1033    }
1034}
1035
1036pub fn map_acceleration_structure_flags(
1037    flags: crate::AccelerationStructureBuildFlags,
1038) -> vk::BuildAccelerationStructureFlagsKHR {
1039    let mut vk_flags = vk::BuildAccelerationStructureFlagsKHR::empty();
1040
1041    if flags.contains(crate::AccelerationStructureBuildFlags::PREFER_FAST_TRACE) {
1042        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::PREFER_FAST_TRACE;
1043    }
1044
1045    if flags.contains(crate::AccelerationStructureBuildFlags::PREFER_FAST_BUILD) {
1046        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::PREFER_FAST_BUILD;
1047    }
1048
1049    if flags.contains(crate::AccelerationStructureBuildFlags::ALLOW_UPDATE) {
1050        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::ALLOW_UPDATE;
1051    }
1052
1053    if flags.contains(crate::AccelerationStructureBuildFlags::LOW_MEMORY) {
1054        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::LOW_MEMORY;
1055    }
1056
1057    if flags.contains(crate::AccelerationStructureBuildFlags::ALLOW_COMPACTION) {
1058        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::ALLOW_COMPACTION
1059    }
1060
1061    if flags.contains(crate::AccelerationStructureBuildFlags::ALLOW_RAY_HIT_VERTEX_RETURN) {
1062        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::ALLOW_DATA_ACCESS
1063    }
1064
1065    vk_flags
1066}
1067
1068pub fn map_acceleration_structure_geometry_flags(
1069    flags: crate::AccelerationStructureGeometryFlags,
1070) -> vk::GeometryFlagsKHR {
1071    let mut vk_flags = vk::GeometryFlagsKHR::empty();
1072
1073    if flags.contains(crate::AccelerationStructureGeometryFlags::OPAQUE) {
1074        vk_flags |= vk::GeometryFlagsKHR::OPAQUE;
1075    }
1076
1077    if flags.contains(crate::AccelerationStructureGeometryFlags::NO_DUPLICATE_ANY_HIT_INVOCATION) {
1078        vk_flags |= vk::GeometryFlagsKHR::NO_DUPLICATE_ANY_HIT_INVOCATION;
1079    }
1080
1081    vk_flags
1082}
1083
1084pub fn map_acceleration_structure_usage_to_barrier(
1085    usage: crate::AccelerationStructureUses,
1086    features: wgt::Features,
1087    queue_flags: vk::QueueFlags,
1088) -> (vk::PipelineStageFlags, vk::AccessFlags) {
1089    let mut stages = vk::PipelineStageFlags::empty();
1090    let mut access = vk::AccessFlags::empty();
1091
1092    if usage.contains(crate::AccelerationStructureUses::BUILD_INPUT) {
1093        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
1094        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR;
1095    }
1096    if usage.contains(crate::AccelerationStructureUses::QUERY_INPUT) {
1097        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
1098        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR;
1099    }
1100    if usage.contains(crate::AccelerationStructureUses::BUILD_OUTPUT) {
1101        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
1102        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_WRITE_KHR;
1103    }
1104    if usage.contains(crate::AccelerationStructureUses::SHADER_INPUT)
1105        && features.contains(wgt::Features::EXPERIMENTAL_RAY_QUERY)
1106    {
1107        stages |= shader_stages(queue_flags);
1108        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR;
1109    }
1110    if usage.contains(crate::AccelerationStructureUses::SHADER_INPUT)
1111        && features.contains(wgt::Features::EXPERIMENTAL_RAY_TRACING_PIPELINES)
1112    {
1113        stages |= vk::PipelineStageFlags::RAY_TRACING_SHADER_KHR;
1114        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR;
1115    }
1116    if usage.contains(crate::AccelerationStructureUses::COPY_SRC) {
1117        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
1118        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR;
1119    }
1120    if usage.contains(crate::AccelerationStructureUses::COPY_DST) {
1121        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
1122        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_WRITE_KHR;
1123    }
1124
1125    (stages, access)
1126}
1127
1128pub fn map_component_swizzle(swizzle: wgt::ComponentSwizzle) -> vk::ComponentSwizzle {
1129    match swizzle {
1130        wgt::ComponentSwizzle::Zero => vk::ComponentSwizzle::ZERO,
1131        wgt::ComponentSwizzle::One => vk::ComponentSwizzle::ONE,
1132        wgt::ComponentSwizzle::R => vk::ComponentSwizzle::R,
1133        wgt::ComponentSwizzle::G => vk::ComponentSwizzle::G,
1134        wgt::ComponentSwizzle::B => vk::ComponentSwizzle::B,
1135        wgt::ComponentSwizzle::A => vk::ComponentSwizzle::A,
1136    }
1137}
1138
1139pub fn map_texture_component_swizzle(
1140    swizzle: wgt::TextureComponentSwizzle,
1141) -> vk::ComponentMapping {
1142    vk::ComponentMapping {
1143        r: map_component_swizzle(swizzle.r),
1144        g: map_component_swizzle(swizzle.g),
1145        b: map_component_swizzle(swizzle.b),
1146        a: map_component_swizzle(swizzle.a),
1147    }
1148}
1149
1150#[cfg(test)]
1151mod tests {
1152    use super::*;
1153
1154    /// `map_vk_color_space` and `map_surface_color_space` must stay mutually
1155    /// inverse so that a color space reported in the surface capabilities is
1156    /// exactly what the swapchain is created with.
1157    #[test]
1158    fn color_space_round_trip() {
1159        for vk_color_space in [
1160            vk::ColorSpaceKHR::SRGB_NONLINEAR,
1161            vk::ColorSpaceKHR::EXTENDED_SRGB_LINEAR_EXT,
1162            vk::ColorSpaceKHR::EXTENDED_SRGB_NONLINEAR_EXT,
1163            vk::ColorSpaceKHR::DISPLAY_P3_NONLINEAR_EXT,
1164            vk::ColorSpaceKHR::HDR10_ST2084_EXT,
1165            vk::ColorSpaceKHR::HDR10_HLG_EXT,
1166        ] {
1167            let mapped = map_vk_color_space(vk_color_space).unwrap();
1168            assert_eq!(map_surface_color_space(mapped), vk_color_space);
1169        }
1170    }
1171
1172    #[test]
1173    fn unknown_color_spaces_are_dropped() {
1174        for vk_color_space in [
1175            vk::ColorSpaceKHR::BT2020_LINEAR_EXT,
1176            vk::ColorSpaceKHR::DOLBYVISION_EXT,
1177            vk::ColorSpaceKHR::PASS_THROUGH_EXT,
1178            vk::ColorSpaceKHR::ADOBERGB_NONLINEAR_EXT,
1179        ] {
1180            assert!(map_vk_color_space(vk_color_space).is_none());
1181            assert!(map_vk_surface_formats(vk::SurfaceFormatKHR {
1182                format: vk::Format::B8G8R8A8_UNORM,
1183                color_space: vk_color_space,
1184            })
1185            .is_none());
1186        }
1187    }
1188
1189    #[test]
1190    fn hdr10_surface_format_maps() {
1191        let (format, color_space) = map_vk_surface_formats(vk::SurfaceFormatKHR {
1192            format: vk::Format::A2B10G10R10_UNORM_PACK32,
1193            color_space: vk::ColorSpaceKHR::HDR10_ST2084_EXT,
1194        })
1195        .unwrap();
1196        assert_eq!(format, wgt::TextureFormat::Rgb10a2Unorm);
1197        assert_eq!(color_space, wgt::SurfaceColorSpace::Bt2100Pq);
1198    }
1199
1200    #[test]
1201    fn buffer_shader_stages_follow_queue_flags() {
1202        let usage = wgt::BufferUses::UNIFORM;
1203
1204        let (stages, access) = map_buffer_usage_to_barrier(usage, vk::QueueFlags::GRAPHICS);
1205        assert_eq!(
1206            stages,
1207            vk::PipelineStageFlags::VERTEX_SHADER | vk::PipelineStageFlags::FRAGMENT_SHADER
1208        );
1209        assert_eq!(access, vk::AccessFlags::UNIFORM_READ);
1210
1211        let (stages, access) = map_buffer_usage_to_barrier(usage, vk::QueueFlags::COMPUTE);
1212        assert_eq!(stages, vk::PipelineStageFlags::COMPUTE_SHADER);
1213        assert_eq!(access, vk::AccessFlags::UNIFORM_READ);
1214
1215        let (stages, access) =
1216            map_buffer_usage_to_barrier(usage, vk::QueueFlags::GRAPHICS | vk::QueueFlags::COMPUTE);
1217        assert_eq!(
1218            stages,
1219            vk::PipelineStageFlags::VERTEX_SHADER
1220                | vk::PipelineStageFlags::FRAGMENT_SHADER
1221                | vk::PipelineStageFlags::COMPUTE_SHADER
1222        );
1223        assert_eq!(access, vk::AccessFlags::UNIFORM_READ);
1224    }
1225
1226    #[test]
1227    fn non_shader_buffer_usage_is_unchanged() {
1228        let (stages, access) = map_buffer_usage_to_barrier(
1229            wgt::BufferUses::COPY_SRC | wgt::BufferUses::VERTEX,
1230            vk::QueueFlags::empty(),
1231        );
1232
1233        assert_eq!(
1234            stages,
1235            vk::PipelineStageFlags::TRANSFER | vk::PipelineStageFlags::VERTEX_INPUT
1236        );
1237        assert_eq!(
1238            access,
1239            vk::AccessFlags::TRANSFER_READ | vk::AccessFlags::VERTEX_ATTRIBUTE_READ
1240        );
1241    }
1242
1243    #[test]
1244    fn texture_shader_stages_follow_queue_flags() {
1245        let usage = wgt::TextureUses::RESOURCE;
1246
1247        let (stages, access) = map_texture_usage_to_barrier(usage, vk::QueueFlags::GRAPHICS, false);
1248        assert_eq!(
1249            stages,
1250            vk::PipelineStageFlags::VERTEX_SHADER | vk::PipelineStageFlags::FRAGMENT_SHADER
1251        );
1252        assert_eq!(access, vk::AccessFlags::SHADER_READ);
1253
1254        let (stages, access) = map_texture_usage_to_barrier(usage, vk::QueueFlags::COMPUTE, false);
1255        assert_eq!(stages, vk::PipelineStageFlags::COMPUTE_SHADER);
1256        assert_eq!(access, vk::AccessFlags::SHADER_READ);
1257
1258        let (stages, access) = map_texture_usage_to_barrier(
1259            usage,
1260            vk::QueueFlags::GRAPHICS | vk::QueueFlags::COMPUTE,
1261            false,
1262        );
1263        assert_eq!(
1264            stages,
1265            vk::PipelineStageFlags::VERTEX_SHADER
1266                | vk::PipelineStageFlags::FRAGMENT_SHADER
1267                | vk::PipelineStageFlags::COMPUTE_SHADER
1268        );
1269        assert_eq!(access, vk::AccessFlags::SHADER_READ);
1270    }
1271
1272    #[test]
1273    fn non_shader_texture_usage_is_unchanged() {
1274        let (stages, access) = map_texture_usage_to_barrier(
1275            wgt::TextureUses::COPY_SRC | wgt::TextureUses::COLOR_TARGET,
1276            vk::QueueFlags::empty(),
1277            false,
1278        );
1279
1280        assert_eq!(
1281            stages,
1282            vk::PipelineStageFlags::TRANSFER | vk::PipelineStageFlags::COLOR_ATTACHMENT_OUTPUT
1283        );
1284        assert_eq!(
1285            access,
1286            vk::AccessFlags::TRANSFER_READ
1287                | vk::AccessFlags::COLOR_ATTACHMENT_READ
1288                | vk::AccessFlags::COLOR_ATTACHMENT_WRITE
1289        );
1290    }
1291
1292    #[test]
1293    fn acceleration_structure_shader_stages_follow_queue_flags() {
1294        let usage = crate::AccelerationStructureUses::SHADER_INPUT;
1295        let features = wgt::Features::EXPERIMENTAL_RAY_QUERY;
1296
1297        let (stages, access) =
1298            map_acceleration_structure_usage_to_barrier(usage, features, vk::QueueFlags::GRAPHICS);
1299        assert_eq!(
1300            stages,
1301            vk::PipelineStageFlags::VERTEX_SHADER | vk::PipelineStageFlags::FRAGMENT_SHADER
1302        );
1303        assert_eq!(access, vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR);
1304
1305        let (stages, access) =
1306            map_acceleration_structure_usage_to_barrier(usage, features, vk::QueueFlags::COMPUTE);
1307        assert_eq!(stages, vk::PipelineStageFlags::COMPUTE_SHADER);
1308        assert_eq!(access, vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR);
1309
1310        let (stages, access) = map_acceleration_structure_usage_to_barrier(
1311            usage,
1312            features,
1313            vk::QueueFlags::GRAPHICS | vk::QueueFlags::COMPUTE,
1314        );
1315        assert_eq!(
1316            stages,
1317            vk::PipelineStageFlags::VERTEX_SHADER
1318                | vk::PipelineStageFlags::FRAGMENT_SHADER
1319                | vk::PipelineStageFlags::COMPUTE_SHADER
1320        );
1321        assert_eq!(access, vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR);
1322    }
1323
1324    #[test]
1325    fn non_shader_acceleration_structure_usage_is_unchanged() {
1326        let (stages, access) = map_acceleration_structure_usage_to_barrier(
1327            crate::AccelerationStructureUses::BUILD_INPUT
1328                | crate::AccelerationStructureUses::BUILD_OUTPUT,
1329            wgt::Features::empty(),
1330            vk::QueueFlags::empty(),
1331        );
1332
1333        assert_eq!(
1334            stages,
1335            vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR
1336        );
1337        assert_eq!(
1338            access,
1339            vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR
1340                | vk::AccessFlags::ACCELERATION_STRUCTURE_WRITE_KHR
1341        );
1342    }
1343}
wgpu_hal/vulkan/conv.rs

wgpu_hal/vulkan/
conv.rs
