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    // Note: depth textures are always sampled with RODS layout
242    let is_color = !format.is_depth_stencil_format();
243    match usage {
244        wgt::TextureUses::UNINITIALIZED => vk::ImageLayout::UNDEFINED,
245        wgt::TextureUses::COPY_SRC => vk::ImageLayout::TRANSFER_SRC_OPTIMAL,
246        wgt::TextureUses::COPY_DST => vk::ImageLayout::TRANSFER_DST_OPTIMAL,
247        wgt::TextureUses::RESOURCE if is_color => vk::ImageLayout::SHADER_READ_ONLY_OPTIMAL,
248        wgt::TextureUses::COLOR_TARGET => vk::ImageLayout::COLOR_ATTACHMENT_OPTIMAL,
249        wgt::TextureUses::DEPTH_STENCIL_WRITE => vk::ImageLayout::DEPTH_STENCIL_ATTACHMENT_OPTIMAL,
250        _ => {
251            if usage == wgt::TextureUses::PRESENT {
252                vk::ImageLayout::PRESENT_SRC_KHR
253            } else if is_color {
254                vk::ImageLayout::GENERAL
255            } else {
256                vk::ImageLayout::DEPTH_STENCIL_READ_ONLY_OPTIMAL
257            }
258        }
259    }
260}
261
262pub fn map_texture_usage(usage: wgt::TextureUses) -> vk::ImageUsageFlags {
263    let mut flags = vk::ImageUsageFlags::empty();
264    if usage.contains(wgt::TextureUses::COPY_SRC) {
265        flags |= vk::ImageUsageFlags::TRANSFER_SRC;
266    }
267    if usage.contains(wgt::TextureUses::COPY_DST) {
268        flags |= vk::ImageUsageFlags::TRANSFER_DST;
269    }
270    if usage.contains(wgt::TextureUses::RESOURCE) {
271        flags |= vk::ImageUsageFlags::SAMPLED;
272    }
273    if usage.contains(wgt::TextureUses::COLOR_TARGET) {
274        flags |= vk::ImageUsageFlags::COLOR_ATTACHMENT;
275    }
276    if usage
277        .intersects(wgt::TextureUses::DEPTH_STENCIL_READ | wgt::TextureUses::DEPTH_STENCIL_WRITE)
278    {
279        flags |= vk::ImageUsageFlags::DEPTH_STENCIL_ATTACHMENT;
280    }
281    if usage.intersects(
282        wgt::TextureUses::STORAGE_READ_ONLY
283            | wgt::TextureUses::STORAGE_WRITE_ONLY
284            | wgt::TextureUses::STORAGE_READ_WRITE
285            | wgt::TextureUses::STORAGE_ATOMIC,
286    ) {
287        flags |= vk::ImageUsageFlags::STORAGE;
288    }
289    if usage.contains(wgt::TextureUses::TRANSIENT) {
290        flags |= vk::ImageUsageFlags::TRANSIENT_ATTACHMENT;
291    }
292    flags
293}
294
295/// The stages a shader may read or write a texture in: fragment and compute,
296/// plus upstream's vertex stage once the device's texture stages widened.
297/// Widened, they are exactly upstream's: like upstream, which names no task
298/// or mesh stage in any barrier, this leaves experimental mesh shading's
299/// reads unsynchronized.
300pub fn texture_shader_stages(widened: bool) -> vk::PipelineStageFlags {
301    let fragment_and_compute =
302        vk::PipelineStageFlags::FRAGMENT_SHADER | vk::PipelineStageFlags::COMPUTE_SHADER;
303    if widened {
304        fragment_and_compute | vk::PipelineStageFlags::VERTEX_SHADER
305    } else {
306        fragment_and_compute
307    }
308}
309
310/// The stages and access of `usage`, with `shader_stages` the stages that
311/// may read or write the texture from a shader.
312pub fn map_texture_usage_to_barrier(
313    usage: wgt::TextureUses,
314    shader_stages: vk::PipelineStageFlags,
315) -> (vk::PipelineStageFlags, vk::AccessFlags) {
316    let mut stages = vk::PipelineStageFlags::empty();
317    let mut access = vk::AccessFlags::empty();
318
319    if usage.contains(wgt::TextureUses::COPY_SRC) {
320        stages |= vk::PipelineStageFlags::TRANSFER;
321        access |= vk::AccessFlags::TRANSFER_READ;
322    }
323    if usage.contains(wgt::TextureUses::COPY_DST) {
324        stages |= vk::PipelineStageFlags::TRANSFER;
325        access |= vk::AccessFlags::TRANSFER_WRITE;
326    }
327    if usage.contains(wgt::TextureUses::RESOURCE) {
328        stages |= shader_stages;
329        access |= vk::AccessFlags::SHADER_READ;
330    }
331    if usage.contains(wgt::TextureUses::COLOR_TARGET) {
332        stages |= vk::PipelineStageFlags::COLOR_ATTACHMENT_OUTPUT;
333        access |= vk::AccessFlags::COLOR_ATTACHMENT_READ | vk::AccessFlags::COLOR_ATTACHMENT_WRITE;
334    }
335    if usage.intersects(wgt::TextureUses::DEPTH_STENCIL_READ) {
336        stages |= vk::PipelineStageFlags::EARLY_FRAGMENT_TESTS
337            | vk::PipelineStageFlags::LATE_FRAGMENT_TESTS;
338        access |= vk::AccessFlags::DEPTH_STENCIL_ATTACHMENT_READ;
339    }
340    if usage.intersects(wgt::TextureUses::DEPTH_STENCIL_WRITE) {
341        stages |= vk::PipelineStageFlags::EARLY_FRAGMENT_TESTS
342            | vk::PipelineStageFlags::LATE_FRAGMENT_TESTS;
343        access |= vk::AccessFlags::DEPTH_STENCIL_ATTACHMENT_READ
344            | vk::AccessFlags::DEPTH_STENCIL_ATTACHMENT_WRITE;
345    }
346    if usage.intersects(
347        wgt::TextureUses::STORAGE_READ_ONLY
348            | wgt::TextureUses::STORAGE_READ_WRITE
349            | wgt::TextureUses::STORAGE_ATOMIC,
350    ) {
351        stages |= shader_stages;
352        access |= vk::AccessFlags::SHADER_READ;
353    }
354    if usage.intersects(
355        wgt::TextureUses::STORAGE_WRITE_ONLY
356            | wgt::TextureUses::STORAGE_READ_WRITE
357            | wgt::TextureUses::STORAGE_ATOMIC,
358    ) {
359        stages |= shader_stages;
360        access |= vk::AccessFlags::SHADER_WRITE;
361    }
362
363    if usage == wgt::TextureUses::UNINITIALIZED || usage == wgt::TextureUses::PRESENT {
364        (
365            vk::PipelineStageFlags::TOP_OF_PIPE,
366            vk::AccessFlags::empty(),
367        )
368    } else {
369        (stages, access)
370    }
371}
372
373pub fn map_vk_image_usage(usage: vk::ImageUsageFlags) -> wgt::TextureUses {
374    let mut bits = wgt::TextureUses::empty();
375    if usage.contains(vk::ImageUsageFlags::TRANSFER_SRC) {
376        bits |= wgt::TextureUses::COPY_SRC;
377    }
378    if usage.contains(vk::ImageUsageFlags::TRANSFER_DST) {
379        bits |= wgt::TextureUses::COPY_DST;
380    }
381    if usage.contains(vk::ImageUsageFlags::SAMPLED) {
382        bits |= wgt::TextureUses::RESOURCE;
383    }
384    if usage.contains(vk::ImageUsageFlags::COLOR_ATTACHMENT) {
385        bits |= wgt::TextureUses::COLOR_TARGET;
386    }
387    if usage.contains(vk::ImageUsageFlags::DEPTH_STENCIL_ATTACHMENT) {
388        bits |= wgt::TextureUses::DEPTH_STENCIL_READ | wgt::TextureUses::DEPTH_STENCIL_WRITE;
389    }
390    if usage.contains(vk::ImageUsageFlags::STORAGE) {
391        bits |= wgt::TextureUses::STORAGE_READ_ONLY
392            | wgt::TextureUses::STORAGE_WRITE_ONLY
393            | wgt::TextureUses::STORAGE_READ_WRITE
394            | wgt::TextureUses::STORAGE_ATOMIC;
395    }
396    if usage.contains(vk::ImageUsageFlags::TRANSIENT_ATTACHMENT) {
397        bits |= wgt::TextureUses::TRANSIENT;
398    }
399    bits
400}
401
402pub fn map_texture_dimension(dim: wgt::TextureDimension) -> vk::ImageType {
403    match dim {
404        wgt::TextureDimension::D1 => vk::ImageType::TYPE_1D,
405        wgt::TextureDimension::D2 => vk::ImageType::TYPE_2D,
406        wgt::TextureDimension::D3 => vk::ImageType::TYPE_3D,
407    }
408}
409
410pub fn map_index_format(index_format: wgt::IndexFormat) -> vk::IndexType {
411    match index_format {
412        wgt::IndexFormat::Uint16 => vk::IndexType::UINT16,
413        wgt::IndexFormat::Uint32 => vk::IndexType::UINT32,
414    }
415}
416
417pub fn map_vertex_format(vertex_format: wgt::VertexFormat) -> vk::Format {
418    use wgt::VertexFormat as Vf;
419    match vertex_format {
420        Vf::Uint8 => vk::Format::R8_UINT,
421        Vf::Uint8x2 => vk::Format::R8G8_UINT,
422        Vf::Uint8x4 => vk::Format::R8G8B8A8_UINT,
423        Vf::Sint8 => vk::Format::R8_SINT,
424        Vf::Sint8x2 => vk::Format::R8G8_SINT,
425        Vf::Sint8x4 => vk::Format::R8G8B8A8_SINT,
426        Vf::Unorm8 => vk::Format::R8_UNORM,
427        Vf::Unorm8x2 => vk::Format::R8G8_UNORM,
428        Vf::Unorm8x4 => vk::Format::R8G8B8A8_UNORM,
429        Vf::Snorm8 => vk::Format::R8_SNORM,
430        Vf::Snorm8x2 => vk::Format::R8G8_SNORM,
431        Vf::Snorm8x4 => vk::Format::R8G8B8A8_SNORM,
432        Vf::Uint16 => vk::Format::R16_UINT,
433        Vf::Uint16x2 => vk::Format::R16G16_UINT,
434        Vf::Uint16x4 => vk::Format::R16G16B16A16_UINT,
435        Vf::Sint16 => vk::Format::R16_SINT,
436        Vf::Sint16x2 => vk::Format::R16G16_SINT,
437        Vf::Sint16x4 => vk::Format::R16G16B16A16_SINT,
438        Vf::Unorm16 => vk::Format::R16_UNORM,
439        Vf::Unorm16x2 => vk::Format::R16G16_UNORM,
440        Vf::Unorm16x4 => vk::Format::R16G16B16A16_UNORM,
441        Vf::Snorm16 => vk::Format::R16_SNORM,
442        Vf::Snorm16x2 => vk::Format::R16G16_SNORM,
443        Vf::Snorm16x4 => vk::Format::R16G16B16A16_SNORM,
444        Vf::Float16 => vk::Format::R16_SFLOAT,
445        Vf::Float16x2 => vk::Format::R16G16_SFLOAT,
446        Vf::Float16x4 => vk::Format::R16G16B16A16_SFLOAT,
447        Vf::Float32 => vk::Format::R32_SFLOAT,
448        Vf::Float32x2 => vk::Format::R32G32_SFLOAT,
449        Vf::Float32x3 => vk::Format::R32G32B32_SFLOAT,
450        Vf::Float32x4 => vk::Format::R32G32B32A32_SFLOAT,
451        Vf::Uint32 => vk::Format::R32_UINT,
452        Vf::Uint32x2 => vk::Format::R32G32_UINT,
453        Vf::Uint32x3 => vk::Format::R32G32B32_UINT,
454        Vf::Uint32x4 => vk::Format::R32G32B32A32_UINT,
455        Vf::Sint32 => vk::Format::R32_SINT,
456        Vf::Sint32x2 => vk::Format::R32G32_SINT,
457        Vf::Sint32x3 => vk::Format::R32G32B32_SINT,
458        Vf::Sint32x4 => vk::Format::R32G32B32A32_SINT,
459        Vf::Float64 => vk::Format::R64_SFLOAT,
460        Vf::Float64x2 => vk::Format::R64G64_SFLOAT,
461        Vf::Float64x3 => vk::Format::R64G64B64_SFLOAT,
462        Vf::Float64x4 => vk::Format::R64G64B64A64_SFLOAT,
463        Vf::Unorm10_10_10_2 => vk::Format::A2B10G10R10_UNORM_PACK32,
464        Vf::Unorm8x4Bgra => vk::Format::B8G8R8A8_UNORM,
465    }
466}
467
468pub fn map_aspects(aspects: crate::FormatAspects) -> vk::ImageAspectFlags {
469    let mut flags = vk::ImageAspectFlags::empty();
470    if aspects.contains(crate::FormatAspects::COLOR) {
471        flags |= vk::ImageAspectFlags::COLOR;
472    }
473    if aspects.contains(crate::FormatAspects::DEPTH) {
474        flags |= vk::ImageAspectFlags::DEPTH;
475    }
476    if aspects.contains(crate::FormatAspects::STENCIL) {
477        flags |= vk::ImageAspectFlags::STENCIL;
478    }
479    if aspects.contains(crate::FormatAspects::PLANE_0) {
480        flags |= vk::ImageAspectFlags::PLANE_0;
481    }
482    if aspects.contains(crate::FormatAspects::PLANE_1) {
483        flags |= vk::ImageAspectFlags::PLANE_1;
484    }
485    if aspects.contains(crate::FormatAspects::PLANE_2) {
486        flags |= vk::ImageAspectFlags::PLANE_2;
487    }
488    flags
489}
490
491pub fn map_attachment_ops(
492    op: crate::AttachmentOps,
493) -> (vk::AttachmentLoadOp, vk::AttachmentStoreOp) {
494    let load_op = if op.contains(crate::AttachmentOps::LOAD) {
495        vk::AttachmentLoadOp::LOAD
496    } else if op.contains(crate::AttachmentOps::LOAD_DONT_CARE) {
497        vk::AttachmentLoadOp::DONT_CARE
498    } else if op.contains(crate::AttachmentOps::LOAD_CLEAR) {
499        vk::AttachmentLoadOp::CLEAR
500    } else {
501        unreachable!()
502    };
503    let store_op = if op.contains(crate::AttachmentOps::STORE) {
504        vk::AttachmentStoreOp::STORE
505    } else if op.contains(crate::AttachmentOps::STORE_DISCARD) {
506        vk::AttachmentStoreOp::DONT_CARE
507    } else {
508        unreachable!()
509    };
510    (load_op, store_op)
511}
512
513pub fn map_present_mode(mode: wgt::PresentMode) -> vk::PresentModeKHR {
514    match mode {
515        wgt::PresentMode::Immediate => vk::PresentModeKHR::IMMEDIATE,
516        wgt::PresentMode::Mailbox => vk::PresentModeKHR::MAILBOX,
517        wgt::PresentMode::Fifo => vk::PresentModeKHR::FIFO,
518        wgt::PresentMode::FifoRelaxed => vk::PresentModeKHR::FIFO_RELAXED,
519        wgt::PresentMode::AutoNoVsync | wgt::PresentMode::AutoVsync => {
520            unreachable!("Cannot create swapchain with Auto PresentationMode")
521        }
522    }
523}
524
525pub fn map_vk_present_mode(mode: vk::PresentModeKHR) -> Option<wgt::PresentMode> {
526    // Not exposed in Ash yet.
527    const FIFO_LATEST_READY: vk::PresentModeKHR = vk::PresentModeKHR::from_raw(1_000_361_000);
528
529    // See https://registry.khronos.org/vulkan/specs/latest/man/html/VkPresentModeKHR.html
530    match mode {
531        vk::PresentModeKHR::IMMEDIATE => Some(wgt::PresentMode::Immediate),
532        vk::PresentModeKHR::MAILBOX => Some(wgt::PresentMode::Mailbox),
533        vk::PresentModeKHR::FIFO => Some(wgt::PresentMode::Fifo),
534        vk::PresentModeKHR::FIFO_RELAXED => Some(wgt::PresentMode::FifoRelaxed),
535
536        // Modes that aren't exposed yet.
537        vk::PresentModeKHR::SHARED_DEMAND_REFRESH => None,
538        vk::PresentModeKHR::SHARED_CONTINUOUS_REFRESH => None,
539        FIFO_LATEST_READY => None,
540
541        _ => {
542            log::debug!("Unrecognized present mode {mode:?}");
543            None
544        }
545    }
546}
547
548pub fn map_composite_alpha_mode(mode: wgt::CompositeAlphaMode) -> vk::CompositeAlphaFlagsKHR {
549    match mode {
550        wgt::CompositeAlphaMode::Opaque => vk::CompositeAlphaFlagsKHR::OPAQUE,
551        wgt::CompositeAlphaMode::PreMultiplied => vk::CompositeAlphaFlagsKHR::PRE_MULTIPLIED,
552        wgt::CompositeAlphaMode::PostMultiplied => vk::CompositeAlphaFlagsKHR::POST_MULTIPLIED,
553        wgt::CompositeAlphaMode::Inherit => vk::CompositeAlphaFlagsKHR::INHERIT,
554        wgt::CompositeAlphaMode::Auto => unreachable!(),
555    }
556}
557
558pub fn map_vk_composite_alpha(flags: vk::CompositeAlphaFlagsKHR) -> Vec<wgt::CompositeAlphaMode> {
559    let mut modes = Vec::new();
560    if flags.contains(vk::CompositeAlphaFlagsKHR::OPAQUE) {
561        modes.push(wgt::CompositeAlphaMode::Opaque);
562    }
563    if flags.contains(vk::CompositeAlphaFlagsKHR::PRE_MULTIPLIED) {
564        modes.push(wgt::CompositeAlphaMode::PreMultiplied);
565    }
566    if flags.contains(vk::CompositeAlphaFlagsKHR::POST_MULTIPLIED) {
567        modes.push(wgt::CompositeAlphaMode::PostMultiplied);
568    }
569    if flags.contains(vk::CompositeAlphaFlagsKHR::INHERIT) {
570        modes.push(wgt::CompositeAlphaMode::Inherit);
571    }
572    modes
573}
574
575pub fn map_buffer_usage(usage: wgt::BufferUses) -> vk::BufferUsageFlags {
576    let mut flags = vk::BufferUsageFlags::empty();
577    if usage.contains(wgt::BufferUses::COPY_SRC) {
578        flags |= vk::BufferUsageFlags::TRANSFER_SRC;
579    }
580    if usage.contains(wgt::BufferUses::COPY_DST) {
581        flags |= vk::BufferUsageFlags::TRANSFER_DST;
582    }
583    if usage.contains(wgt::BufferUses::UNIFORM) {
584        flags |= vk::BufferUsageFlags::UNIFORM_BUFFER;
585    }
586    if usage.intersects(wgt::BufferUses::STORAGE_READ_ONLY | wgt::BufferUses::STORAGE_READ_WRITE) {
587        flags |= vk::BufferUsageFlags::STORAGE_BUFFER;
588    }
589    if usage.contains(wgt::BufferUses::INDEX) {
590        flags |= vk::BufferUsageFlags::INDEX_BUFFER;
591    }
592    if usage.contains(wgt::BufferUses::VERTEX) {
593        flags |= vk::BufferUsageFlags::VERTEX_BUFFER;
594    }
595    if usage.contains(wgt::BufferUses::INDIRECT) {
596        flags |= vk::BufferUsageFlags::INDIRECT_BUFFER;
597    }
598    if usage.contains(wgt::BufferUses::ACCELERATION_STRUCTURE_SCRATCH) {
599        flags |= vk::BufferUsageFlags::STORAGE_BUFFER | vk::BufferUsageFlags::SHADER_DEVICE_ADDRESS;
600    }
601    if usage.intersects(
602        wgt::BufferUses::BOTTOM_LEVEL_ACCELERATION_STRUCTURE_INPUT
603            | wgt::BufferUses::TOP_LEVEL_ACCELERATION_STRUCTURE_INPUT,
604    ) {
605        flags |= vk::BufferUsageFlags::ACCELERATION_STRUCTURE_BUILD_INPUT_READ_ONLY_KHR
606            | vk::BufferUsageFlags::SHADER_DEVICE_ADDRESS;
607    }
608    if usage.intersects(wgt::BufferUses::ACCELERATION_STRUCTURE_QUERY) {
609        flags |= vk::BufferUsageFlags::TRANSFER_DST;
610    }
611    if usage.intersects(wgt::BufferUses::RAY_TRACING_PIPELINE_SHADER_DATA) {
612        flags |= vk::BufferUsageFlags::SHADER_BINDING_TABLE_KHR
613            | vk::BufferUsageFlags::SHADER_DEVICE_ADDRESS;
614    }
615    flags
616}
617
618pub fn map_buffer_usage_to_barrier(
619    usage: wgt::BufferUses,
620) -> (vk::PipelineStageFlags, vk::AccessFlags) {
621    let mut stages = vk::PipelineStageFlags::empty();
622    let mut access = vk::AccessFlags::empty();
623    let shader_stages = vk::PipelineStageFlags::VERTEX_SHADER
624        | vk::PipelineStageFlags::FRAGMENT_SHADER
625        | vk::PipelineStageFlags::COMPUTE_SHADER;
626
627    if usage.contains(wgt::BufferUses::MAP_READ) {
628        stages |= vk::PipelineStageFlags::HOST;
629        access |= vk::AccessFlags::HOST_READ;
630    }
631    if usage.contains(wgt::BufferUses::MAP_WRITE) {
632        stages |= vk::PipelineStageFlags::HOST;
633        access |= vk::AccessFlags::HOST_WRITE;
634    }
635    if usage.contains(wgt::BufferUses::COPY_SRC) {
636        stages |= vk::PipelineStageFlags::TRANSFER;
637        access |= vk::AccessFlags::TRANSFER_READ;
638    }
639    if usage.contains(wgt::BufferUses::COPY_DST) {
640        stages |= vk::PipelineStageFlags::TRANSFER;
641        access |= vk::AccessFlags::TRANSFER_WRITE;
642    }
643    if usage.contains(wgt::BufferUses::UNIFORM) {
644        stages |= shader_stages;
645        access |= vk::AccessFlags::UNIFORM_READ;
646    }
647    if usage.intersects(wgt::BufferUses::STORAGE_READ_ONLY) {
648        stages |= shader_stages;
649        access |= vk::AccessFlags::SHADER_READ;
650    }
651    if usage.intersects(wgt::BufferUses::STORAGE_READ_WRITE) {
652        stages |= shader_stages;
653        access |= vk::AccessFlags::SHADER_READ | vk::AccessFlags::SHADER_WRITE;
654    }
655    if usage.contains(wgt::BufferUses::INDEX) {
656        stages |= vk::PipelineStageFlags::VERTEX_INPUT;
657        access |= vk::AccessFlags::INDEX_READ;
658    }
659    if usage.contains(wgt::BufferUses::VERTEX) {
660        stages |= vk::PipelineStageFlags::VERTEX_INPUT;
661        access |= vk::AccessFlags::VERTEX_ATTRIBUTE_READ;
662    }
663    if usage.contains(wgt::BufferUses::INDIRECT) {
664        stages |= vk::PipelineStageFlags::DRAW_INDIRECT;
665        access |= vk::AccessFlags::INDIRECT_COMMAND_READ;
666    }
667    if usage.intersects(
668        wgt::BufferUses::BOTTOM_LEVEL_ACCELERATION_STRUCTURE_INPUT
669            | wgt::BufferUses::TOP_LEVEL_ACCELERATION_STRUCTURE_INPUT
670            | wgt::BufferUses::ACCELERATION_STRUCTURE_SCRATCH,
671    ) {
672        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
673        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR
674            | vk::AccessFlags::ACCELERATION_STRUCTURE_WRITE_KHR
675            | vk::AccessFlags::SHADER_READ;
676    }
677    if usage.contains(wgt::BufferUses::ACCELERATION_STRUCTURE_QUERY) {
678        stages |= vk::PipelineStageFlags::TRANSFER;
679        access |= vk::AccessFlags::TRANSFER_WRITE;
680    }
681
682    (stages, access)
683}
684
685pub fn map_view_dimension(dim: wgt::TextureViewDimension) -> vk::ImageViewType {
686    match dim {
687        wgt::TextureViewDimension::D1 => vk::ImageViewType::TYPE_1D,
688        wgt::TextureViewDimension::D2 => vk::ImageViewType::TYPE_2D,
689        wgt::TextureViewDimension::D2Array => vk::ImageViewType::TYPE_2D_ARRAY,
690        wgt::TextureViewDimension::Cube => vk::ImageViewType::CUBE,
691        wgt::TextureViewDimension::CubeArray => vk::ImageViewType::CUBE_ARRAY,
692        wgt::TextureViewDimension::D3 => vk::ImageViewType::TYPE_3D,
693    }
694}
695
696pub fn map_copy_extent(extent: &crate::CopyExtent) -> vk::Extent3D {
697    vk::Extent3D {
698        width: extent.width,
699        height: extent.height,
700        depth: extent.depth,
701    }
702}
703
704pub fn map_subresource_range(
705    range: &wgt::ImageSubresourceRange,
706    format: wgt::TextureFormat,
707) -> vk::ImageSubresourceRange {
708    vk::ImageSubresourceRange {
709        aspect_mask: map_aspects(crate::FormatAspects::new(format, range.aspect)),
710        base_mip_level: range.base_mip_level,
711        level_count: range.mip_level_count.unwrap_or(vk::REMAINING_MIP_LEVELS),
712        base_array_layer: range.base_array_layer,
713        layer_count: range
714            .array_layer_count
715            .unwrap_or(vk::REMAINING_ARRAY_LAYERS),
716    }
717}
718
719// Special subresource range mapping for dealing with barriers
720// so that we account for the "hidden" depth aspect in emulated Stencil8.
721pub(super) fn map_subresource_range_combined_aspect(
722    range: &wgt::ImageSubresourceRange,
723    format: wgt::TextureFormat,
724    private_caps: &super::PrivateCapabilities,
725) -> vk::ImageSubresourceRange {
726    let mut range = map_subresource_range(range, format);
727    if !private_caps.texture_s8 && format == wgt::TextureFormat::Stencil8 {
728        range.aspect_mask |= vk::ImageAspectFlags::DEPTH;
729    }
730    range
731}
732
733pub fn map_subresource_layers(
734    base: &crate::TextureCopyBase,
735) -> (vk::ImageSubresourceLayers, vk::Offset3D) {
736    let offset = vk::Offset3D {
737        x: base.origin.x as i32,
738        y: base.origin.y as i32,
739        z: base.origin.z as i32,
740    };
741    let subresource = vk::ImageSubresourceLayers {
742        aspect_mask: map_aspects(base.aspect),
743        mip_level: base.mip_level,
744        base_array_layer: base.array_layer,
745        layer_count: 1,
746    };
747    (subresource, offset)
748}
749
750pub fn map_filter_mode(mode: wgt::FilterMode) -> vk::Filter {
751    match mode {
752        wgt::FilterMode::Nearest => vk::Filter::NEAREST,
753        wgt::FilterMode::Linear => vk::Filter::LINEAR,
754    }
755}
756
757pub fn map_mip_filter_mode(mode: wgt::MipmapFilterMode) -> vk::SamplerMipmapMode {
758    match mode {
759        wgt::MipmapFilterMode::Nearest => vk::SamplerMipmapMode::NEAREST,
760        wgt::MipmapFilterMode::Linear => vk::SamplerMipmapMode::LINEAR,
761    }
762}
763
764pub fn map_address_mode(mode: wgt::AddressMode) -> vk::SamplerAddressMode {
765    match mode {
766        wgt::AddressMode::ClampToEdge => vk::SamplerAddressMode::CLAMP_TO_EDGE,
767        wgt::AddressMode::Repeat => vk::SamplerAddressMode::REPEAT,
768        wgt::AddressMode::MirrorRepeat => vk::SamplerAddressMode::MIRRORED_REPEAT,
769        wgt::AddressMode::ClampToBorder => vk::SamplerAddressMode::CLAMP_TO_BORDER,
770        // wgt::AddressMode::MirrorClamp => vk::SamplerAddressMode::MIRROR_CLAMP_TO_EDGE,
771    }
772}
773
774pub fn map_border_color(border_color: wgt::SamplerBorderColor) -> vk::BorderColor {
775    match border_color {
776        wgt::SamplerBorderColor::TransparentBlack | wgt::SamplerBorderColor::Zero => {
777            vk::BorderColor::FLOAT_TRANSPARENT_BLACK
778        }
779        wgt::SamplerBorderColor::OpaqueBlack => vk::BorderColor::FLOAT_OPAQUE_BLACK,
780        wgt::SamplerBorderColor::OpaqueWhite => vk::BorderColor::FLOAT_OPAQUE_WHITE,
781    }
782}
783
784pub fn map_comparison(fun: wgt::CompareFunction) -> vk::CompareOp {
785    use wgt::CompareFunction as Cf;
786    match fun {
787        Cf::Never => vk::CompareOp::NEVER,
788        Cf::Less => vk::CompareOp::LESS,
789        Cf::LessEqual => vk::CompareOp::LESS_OR_EQUAL,
790        Cf::Equal => vk::CompareOp::EQUAL,
791        Cf::GreaterEqual => vk::CompareOp::GREATER_OR_EQUAL,
792        Cf::Greater => vk::CompareOp::GREATER,
793        Cf::NotEqual => vk::CompareOp::NOT_EQUAL,
794        Cf::Always => vk::CompareOp::ALWAYS,
795    }
796}
797
798pub fn map_shader_stage(stage: wgt::ShaderStages) -> vk::ShaderStageFlags {
799    let mut flags = vk::ShaderStageFlags::empty();
800    if stage.contains(wgt::ShaderStages::VERTEX) {
801        flags |= vk::ShaderStageFlags::VERTEX;
802    }
803    if stage.contains(wgt::ShaderStages::FRAGMENT) {
804        flags |= vk::ShaderStageFlags::FRAGMENT;
805    }
806    if stage.contains(wgt::ShaderStages::COMPUTE) {
807        flags |= vk::ShaderStageFlags::COMPUTE;
808    }
809    if stage.contains(wgt::ShaderStages::TASK) {
810        flags |= vk::ShaderStageFlags::TASK_EXT;
811    }
812    if stage.contains(wgt::ShaderStages::MESH) {
813        flags |= vk::ShaderStageFlags::MESH_EXT;
814    }
815    if stage.contains(wgt::ShaderStages::RAY_GENERATION) {
816        flags |= vk::ShaderStageFlags::RAYGEN_KHR;
817    }
818    if stage.contains(wgt::ShaderStages::MISS) {
819        flags |= vk::ShaderStageFlags::MISS_KHR;
820    }
821    if stage.contains(wgt::ShaderStages::ANY_HIT) {
822        flags |= vk::ShaderStageFlags::ANY_HIT_KHR;
823    }
824    if stage.contains(wgt::ShaderStages::CLOSEST_HIT) {
825        flags |= vk::ShaderStageFlags::CLOSEST_HIT_KHR;
826    }
827    flags
828}
829
830pub fn map_binding_type(ty: wgt::BindingType) -> vk::DescriptorType {
831    match ty {
832        wgt::BindingType::Buffer {
833            ty,
834            has_dynamic_offset,
835            ..
836        } => match ty {
837            wgt::BufferBindingType::Storage { .. } => match has_dynamic_offset {
838                true => vk::DescriptorType::STORAGE_BUFFER_DYNAMIC,
839                false => vk::DescriptorType::STORAGE_BUFFER,
840            },
841            wgt::BufferBindingType::Uniform => match has_dynamic_offset {
842                true => vk::DescriptorType::UNIFORM_BUFFER_DYNAMIC,
843                false => vk::DescriptorType::UNIFORM_BUFFER,
844            },
845        },
846        wgt::BindingType::Sampler { .. } => vk::DescriptorType::SAMPLER,
847        wgt::BindingType::Texture { .. } => vk::DescriptorType::SAMPLED_IMAGE,
848        wgt::BindingType::StorageTexture { .. } => vk::DescriptorType::STORAGE_IMAGE,
849        wgt::BindingType::AccelerationStructure { .. } => {
850            vk::DescriptorType::ACCELERATION_STRUCTURE_KHR
851        }
852        wgt::BindingType::ExternalTexture => unimplemented!(),
853    }
854}
855
856pub fn map_topology(topology: wgt::PrimitiveTopology) -> vk::PrimitiveTopology {
857    use wgt::PrimitiveTopology as Pt;
858    match topology {
859        Pt::PointList => vk::PrimitiveTopology::POINT_LIST,
860        Pt::LineList => vk::PrimitiveTopology::LINE_LIST,
861        Pt::LineStrip => vk::PrimitiveTopology::LINE_STRIP,
862        Pt::TriangleList => vk::PrimitiveTopology::TRIANGLE_LIST,
863        Pt::TriangleStrip => vk::PrimitiveTopology::TRIANGLE_STRIP,
864    }
865}
866
867pub fn map_polygon_mode(mode: wgt::PolygonMode) -> vk::PolygonMode {
868    match mode {
869        wgt::PolygonMode::Fill => vk::PolygonMode::FILL,
870        wgt::PolygonMode::Line => vk::PolygonMode::LINE,
871        wgt::PolygonMode::Point => vk::PolygonMode::POINT,
872    }
873}
874
875pub fn map_front_face(front_face: wgt::FrontFace) -> vk::FrontFace {
876    match front_face {
877        wgt::FrontFace::Cw => vk::FrontFace::CLOCKWISE,
878        wgt::FrontFace::Ccw => vk::FrontFace::COUNTER_CLOCKWISE,
879    }
880}
881
882pub fn map_cull_face(face: wgt::Face) -> vk::CullModeFlags {
883    match face {
884        wgt::Face::Front => vk::CullModeFlags::FRONT,
885        wgt::Face::Back => vk::CullModeFlags::BACK,
886    }
887}
888
889pub fn map_stencil_op(op: wgt::StencilOperation) -> vk::StencilOp {
890    use wgt::StencilOperation as So;
891    match op {
892        So::Keep => vk::StencilOp::KEEP,
893        So::Zero => vk::StencilOp::ZERO,
894        So::Replace => vk::StencilOp::REPLACE,
895        So::Invert => vk::StencilOp::INVERT,
896        So::IncrementClamp => vk::StencilOp::INCREMENT_AND_CLAMP,
897        So::IncrementWrap => vk::StencilOp::INCREMENT_AND_WRAP,
898        So::DecrementClamp => vk::StencilOp::DECREMENT_AND_CLAMP,
899        So::DecrementWrap => vk::StencilOp::DECREMENT_AND_WRAP,
900    }
901}
902
903pub fn map_stencil_face(
904    face: &wgt::StencilFaceState,
905    compare_mask: u32,
906    write_mask: u32,
907) -> vk::StencilOpState {
908    vk::StencilOpState {
909        fail_op: map_stencil_op(face.fail_op),
910        pass_op: map_stencil_op(face.pass_op),
911        depth_fail_op: map_stencil_op(face.depth_fail_op),
912        compare_op: map_comparison(face.compare),
913        compare_mask,
914        write_mask,
915        reference: 0,
916    }
917}
918
919fn map_blend_factor(factor: wgt::BlendFactor) -> vk::BlendFactor {
920    use wgt::BlendFactor as Bf;
921    match factor {
922        Bf::Zero => vk::BlendFactor::ZERO,
923        Bf::One => vk::BlendFactor::ONE,
924        Bf::Src => vk::BlendFactor::SRC_COLOR,
925        Bf::OneMinusSrc => vk::BlendFactor::ONE_MINUS_SRC_COLOR,
926        Bf::SrcAlpha => vk::BlendFactor::SRC_ALPHA,
927        Bf::OneMinusSrcAlpha => vk::BlendFactor::ONE_MINUS_SRC_ALPHA,
928        Bf::Dst => vk::BlendFactor::DST_COLOR,
929        Bf::OneMinusDst => vk::BlendFactor::ONE_MINUS_DST_COLOR,
930        Bf::DstAlpha => vk::BlendFactor::DST_ALPHA,
931        Bf::OneMinusDstAlpha => vk::BlendFactor::ONE_MINUS_DST_ALPHA,
932        Bf::SrcAlphaSaturated => vk::BlendFactor::SRC_ALPHA_SATURATE,
933        Bf::Constant => vk::BlendFactor::CONSTANT_COLOR,
934        Bf::OneMinusConstant => vk::BlendFactor::ONE_MINUS_CONSTANT_COLOR,
935        Bf::Src1 => vk::BlendFactor::SRC1_COLOR,
936        Bf::OneMinusSrc1 => vk::BlendFactor::ONE_MINUS_SRC1_COLOR,
937        Bf::Src1Alpha => vk::BlendFactor::SRC1_ALPHA,
938        Bf::OneMinusSrc1Alpha => vk::BlendFactor::ONE_MINUS_SRC1_ALPHA,
939    }
940}
941
942fn map_blend_op(operation: wgt::BlendOperation) -> vk::BlendOp {
943    use wgt::BlendOperation as Bo;
944    match operation {
945        Bo::Add => vk::BlendOp::ADD,
946        Bo::Subtract => vk::BlendOp::SUBTRACT,
947        Bo::ReverseSubtract => vk::BlendOp::REVERSE_SUBTRACT,
948        Bo::Min => vk::BlendOp::MIN,
949        Bo::Max => vk::BlendOp::MAX,
950    }
951}
952
953pub fn map_blend_component(
954    component: &wgt::BlendComponent,
955) -> (vk::BlendOp, vk::BlendFactor, vk::BlendFactor) {
956    let op = map_blend_op(component.operation);
957    let src = map_blend_factor(component.src_factor);
958    let dst = map_blend_factor(component.dst_factor);
959    (op, src, dst)
960}
961
962pub fn map_pipeline_statistics(
963    types: wgt::PipelineStatisticsTypes,
964) -> vk::QueryPipelineStatisticFlags {
965    use wgt::PipelineStatisticsTypes as Pst;
966    let mut flags = vk::QueryPipelineStatisticFlags::empty();
967    if types.contains(Pst::VERTEX_SHADER_INVOCATIONS) {
968        flags |= vk::QueryPipelineStatisticFlags::VERTEX_SHADER_INVOCATIONS;
969    }
970    if types.contains(Pst::CLIPPER_INVOCATIONS) {
971        flags |= vk::QueryPipelineStatisticFlags::CLIPPING_INVOCATIONS;
972    }
973    if types.contains(Pst::CLIPPER_PRIMITIVES_OUT) {
974        flags |= vk::QueryPipelineStatisticFlags::CLIPPING_PRIMITIVES;
975    }
976    if types.contains(Pst::FRAGMENT_SHADER_INVOCATIONS) {
977        flags |= vk::QueryPipelineStatisticFlags::FRAGMENT_SHADER_INVOCATIONS;
978    }
979    if types.contains(Pst::COMPUTE_SHADER_INVOCATIONS) {
980        flags |= vk::QueryPipelineStatisticFlags::COMPUTE_SHADER_INVOCATIONS;
981    }
982    flags
983}
984
985pub fn map_acceleration_structure_format(
986    format: crate::AccelerationStructureFormat,
987) -> vk::AccelerationStructureTypeKHR {
988    match format {
989        crate::AccelerationStructureFormat::TopLevel => vk::AccelerationStructureTypeKHR::TOP_LEVEL,
990        crate::AccelerationStructureFormat::BottomLevel => {
991            vk::AccelerationStructureTypeKHR::BOTTOM_LEVEL
992        }
993    }
994}
995
996pub fn map_acceleration_structure_build_mode(
997    format: crate::AccelerationStructureBuildMode,
998) -> vk::BuildAccelerationStructureModeKHR {
999    match format {
1000        crate::AccelerationStructureBuildMode::Build => {
1001            vk::BuildAccelerationStructureModeKHR::BUILD
1002        }
1003        crate::AccelerationStructureBuildMode::Update => {
1004            vk::BuildAccelerationStructureModeKHR::UPDATE
1005        }
1006    }
1007}
1008
1009pub fn map_acceleration_structure_flags(
1010    flags: crate::AccelerationStructureBuildFlags,
1011) -> vk::BuildAccelerationStructureFlagsKHR {
1012    let mut vk_flags = vk::BuildAccelerationStructureFlagsKHR::empty();
1013
1014    if flags.contains(crate::AccelerationStructureBuildFlags::PREFER_FAST_TRACE) {
1015        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::PREFER_FAST_TRACE;
1016    }
1017
1018    if flags.contains(crate::AccelerationStructureBuildFlags::PREFER_FAST_BUILD) {
1019        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::PREFER_FAST_BUILD;
1020    }
1021
1022    if flags.contains(crate::AccelerationStructureBuildFlags::ALLOW_UPDATE) {
1023        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::ALLOW_UPDATE;
1024    }
1025
1026    if flags.contains(crate::AccelerationStructureBuildFlags::LOW_MEMORY) {
1027        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::LOW_MEMORY;
1028    }
1029
1030    if flags.contains(crate::AccelerationStructureBuildFlags::ALLOW_COMPACTION) {
1031        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::ALLOW_COMPACTION
1032    }
1033
1034    if flags.contains(crate::AccelerationStructureBuildFlags::ALLOW_RAY_HIT_VERTEX_RETURN) {
1035        vk_flags |= vk::BuildAccelerationStructureFlagsKHR::ALLOW_DATA_ACCESS
1036    }
1037
1038    vk_flags
1039}
1040
1041pub fn map_acceleration_structure_geometry_flags(
1042    flags: crate::AccelerationStructureGeometryFlags,
1043) -> vk::GeometryFlagsKHR {
1044    let mut vk_flags = vk::GeometryFlagsKHR::empty();
1045
1046    if flags.contains(crate::AccelerationStructureGeometryFlags::OPAQUE) {
1047        vk_flags |= vk::GeometryFlagsKHR::OPAQUE;
1048    }
1049
1050    if flags.contains(crate::AccelerationStructureGeometryFlags::NO_DUPLICATE_ANY_HIT_INVOCATION) {
1051        vk_flags |= vk::GeometryFlagsKHR::NO_DUPLICATE_ANY_HIT_INVOCATION;
1052    }
1053
1054    vk_flags
1055}
1056
1057pub fn map_acceleration_structure_usage_to_barrier(
1058    usage: crate::AccelerationStructureUses,
1059    features: wgt::Features,
1060) -> (vk::PipelineStageFlags, vk::AccessFlags) {
1061    let mut stages = vk::PipelineStageFlags::empty();
1062    let mut access = vk::AccessFlags::empty();
1063
1064    if usage.contains(crate::AccelerationStructureUses::BUILD_INPUT) {
1065        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
1066        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR;
1067    }
1068    if usage.contains(crate::AccelerationStructureUses::QUERY_INPUT) {
1069        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
1070        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR;
1071    }
1072    if usage.contains(crate::AccelerationStructureUses::BUILD_OUTPUT) {
1073        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
1074        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_WRITE_KHR;
1075    }
1076    if usage.contains(crate::AccelerationStructureUses::SHADER_INPUT)
1077        && features.contains(wgt::Features::EXPERIMENTAL_RAY_QUERY)
1078    {
1079        stages |= vk::PipelineStageFlags::VERTEX_SHADER
1080            | vk::PipelineStageFlags::FRAGMENT_SHADER
1081            | vk::PipelineStageFlags::COMPUTE_SHADER;
1082        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR;
1083    }
1084    if usage.contains(crate::AccelerationStructureUses::SHADER_INPUT)
1085        && features.contains(wgt::Features::EXPERIMENTAL_RAY_TRACING_PIPELINES)
1086    {
1087        stages |= vk::PipelineStageFlags::RAY_TRACING_SHADER_KHR;
1088        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR;
1089    }
1090    if usage.contains(crate::AccelerationStructureUses::COPY_SRC) {
1091        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
1092        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_READ_KHR;
1093    }
1094    if usage.contains(crate::AccelerationStructureUses::COPY_DST) {
1095        stages |= vk::PipelineStageFlags::ACCELERATION_STRUCTURE_BUILD_KHR;
1096        access |= vk::AccessFlags::ACCELERATION_STRUCTURE_WRITE_KHR;
1097    }
1098
1099    (stages, access)
1100}
1101
1102#[cfg(test)]
1103mod tests {
1104    use super::*;
1105
1106    /// `map_vk_color_space` and `map_surface_color_space` must stay mutually
1107    /// inverse so that a color space reported in the surface capabilities is
1108    /// exactly what the swapchain is created with.
1109    #[test]
1110    fn color_space_round_trip() {
1111        for vk_color_space in [
1112            vk::ColorSpaceKHR::SRGB_NONLINEAR,
1113            vk::ColorSpaceKHR::EXTENDED_SRGB_LINEAR_EXT,
1114            vk::ColorSpaceKHR::EXTENDED_SRGB_NONLINEAR_EXT,
1115            vk::ColorSpaceKHR::DISPLAY_P3_NONLINEAR_EXT,
1116            vk::ColorSpaceKHR::HDR10_ST2084_EXT,
1117            vk::ColorSpaceKHR::HDR10_HLG_EXT,
1118        ] {
1119            let mapped = map_vk_color_space(vk_color_space).unwrap();
1120            assert_eq!(map_surface_color_space(mapped), vk_color_space);
1121        }
1122    }
1123
1124    #[test]
1125    fn unknown_color_spaces_are_dropped() {
1126        for vk_color_space in [
1127            vk::ColorSpaceKHR::BT2020_LINEAR_EXT,
1128            vk::ColorSpaceKHR::DOLBYVISION_EXT,
1129            vk::ColorSpaceKHR::PASS_THROUGH_EXT,
1130            vk::ColorSpaceKHR::ADOBERGB_NONLINEAR_EXT,
1131        ] {
1132            assert!(map_vk_color_space(vk_color_space).is_none());
1133            assert!(map_vk_surface_formats(vk::SurfaceFormatKHR {
1134                format: vk::Format::B8G8R8A8_UNORM,
1135                color_space: vk_color_space,
1136            })
1137            .is_none());
1138        }
1139    }
1140
1141    #[test]
1142    fn hdr10_surface_format_maps() {
1143        let (format, color_space) = map_vk_surface_formats(vk::SurfaceFormatKHR {
1144            format: vk::Format::A2B10G10R10_UNORM_PACK32,
1145            color_space: vk::ColorSpaceKHR::HDR10_ST2084_EXT,
1146        })
1147        .unwrap();
1148        assert_eq!(format, wgt::TextureFormat::Rgb10a2Unorm);
1149        assert_eq!(color_space, wgt::SurfaceColorSpace::Bt2100Pq);
1150    }
1151}
wgpu_hal/vulkan/conv.rs

wgpu_hal/vulkan/
conv.rs
