Add helper wrappers for Vulkan core 1.4 Device functions

Author: MarijnS95

Changelog.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added `push()` method to all root structs to insert a single extension-struct in the pointer chain. (#909)
 - Update Vulkan-Headers to 1.3.296 (#910)
+- Added helper wrappers for Vulkan core 1.4 `Device` functions (#1000)
 - Added `VK_KHR_get_display_properties2` instance extension (#932)
 - Added `VK_EXT_metal_objects` device extension (#942)
 - Added `VK_AMD_anti_lag` device extension (#943)

README.md

@@ -19,7 +19,7 @@ A very lightweight wrapper around Vulkan
 - [x] No validation, everything is **unsafe**
 - [x] Lifetime-safety on structs created with the builder pattern
 - [x] Generated from `vk.xml`
-- [x] Support for Vulkan `1.1`, `1.2`, `1.3`
+- [x] Support for Vulkan `1.1`, `1.2`, `1.3`, `1.4`
 - [x] `no_std` support
 
 ## ⚠️ Semver compatibility warning

ash/src/device.rs

@@ -18,6 +18,7 @@ pub struct Device {
     pub(crate) device_fn_1_1: crate::DeviceFnV1_1,
     pub(crate) device_fn_1_2: crate::DeviceFnV1_2,
     pub(crate) device_fn_1_3: crate::DeviceFnV1_3,
+    pub(crate) device_fn_1_4: crate::DeviceFnV1_4,
 }
 
 impl Device {
@@ -38,6 +39,7 @@ impl Device {
             crate::DeviceFnV1_1::load(&mut load_fn),
             crate::DeviceFnV1_2::load(&mut load_fn),
             crate::DeviceFnV1_3::load(&mut load_fn),
+            crate::DeviceFnV1_4::load(&mut load_fn),
         )
     }
 
@@ -48,6 +50,7 @@ impl Device {
         device_fn_1_1: crate::DeviceFnV1_1,
         device_fn_1_2: crate::DeviceFnV1_2,
         device_fn_1_3: crate::DeviceFnV1_3,
+        device_fn_1_4: crate::DeviceFnV1_4,
     ) -> Self {
         Self {
             handle,
@@ -56,6 +59,7 @@ impl Device {
             device_fn_1_1,
             device_fn_1_2,
             device_fn_1_3,
+            device_fn_1_4,
         }
     }
 
@@ -65,6 +69,274 @@ impl Device {
     }
 }
 
+/// Vulkan core 1.4
+impl Device {
+    #[inline]
+    pub fn fp_v1_4(&self) -> &crate::DeviceFnV1_4 {
+        &self.device_fn_1_4
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdSetLineStipple.html>
+    #[inline]
+    #[doc(alias = "vkCmdSetLineStipple")]
+    pub unsafe fn cmd_set_line_stipple(
+        &self,
+        command_buffer: vk::CommandBuffer,
+        line_stipple_factor: u32,
+        line_stipple_pattern: u16,
+    ) {
+        (self.device_fn_1_4.cmd_set_line_stipple)(
+            command_buffer,
+            line_stipple_factor,
+            line_stipple_pattern,
+        )
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkMapMemory2.html>
+    #[inline]
+    #[doc(alias = "vkMapMemory2")]
+    pub unsafe fn map_memory2(
+        &self,
+        memory_map_info: &vk::MemoryMapInfo<'_>,
+    ) -> VkResult<*mut ffi::c_void> {
+        let mut data = mem::MaybeUninit::uninit();
+        (self.device_fn_1_4.map_memory2)(self.handle, memory_map_info, data.as_mut_ptr())
+            .assume_init_on_success(data)
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkUnmapMemory2.html>
+    #[inline]
+    #[doc(alias = "vkUnmapMemory2")]
+    pub unsafe fn unmap_memory2(
+        &self,
+        memory_unmap_info: &vk::MemoryUnmapInfo<'_>,
+    ) -> VkResult<()> {
+        (self.device_fn_1_4.unmap_memory2)(self.handle, memory_unmap_info).result()
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdBindIndexBuffer2.html>
+    #[inline]
+    #[doc(alias = "vkCmdBindIndexBuffer2")]
+    pub unsafe fn cmd_bind_index_buffer2(
+        &self,
+        command_buffer: vk::CommandBuffer,
+        buffer: vk::Buffer,
+        offset: vk::DeviceSize,
+        size: vk::DeviceSize,
+        index_type: vk::IndexType,
+    ) {
+        (self.device_fn_1_4.cmd_bind_index_buffer2)(
+            command_buffer,
+            buffer,
+            offset,
+            size,
+            index_type,
+        )
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetRenderingAreaGranularity.html>
+    #[inline]
+    #[doc(alias = "vkGetRenderingAreaGranularity")]
+    pub unsafe fn get_rendering_area_granularity(
+        &self,
+        rendering_area_info: &vk::RenderingAreaInfo<'_>,
+    ) -> vk::Extent2D {
+        let mut granularity = mem::MaybeUninit::uninit();
+        (self.device_fn_1_4.get_rendering_area_granularity)(
+            self.handle,
+            rendering_area_info,
+            granularity.as_mut_ptr(),
+        );
+        granularity.assume_init()
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetDeviceImageSubresourceLayout.html>
+    #[inline]
+    #[doc(alias = "vkGetDeviceImageSubresourceLayout")]
+    pub unsafe fn get_device_image_subresource_layout(
+        &self,
+        info: &vk::DeviceImageSubresourceInfo<'_>,
+        layout: &mut vk::SubresourceLayout2<'_>,
+    ) {
+        (self.device_fn_1_4.get_device_image_subresource_layout)(self.handle, info, layout)
+    }
+
+    // XXX: Replicate comments from VK_EXT_host_image_copy, VK_EXT_image_compression_control
+    // and VK_KHR_maintenance5 about alternative ways to fetch and use a suffixed vesion of this
+    // function?  And retroactively update those docs?
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetImageSubresourceLayout2.html>
+    #[inline]
+    #[doc(alias = "vkGetImageSubresourceLayout2")]
+    pub unsafe fn get_image_subresource_layout2(
+        &self,
+        image: vk::Image,
+        subresource: &vk::ImageSubresource2<'_>,
+        layout: &mut vk::SubresourceLayout2<'_>,
+    ) {
+        (self.device_fn_1_4.get_image_subresource_layout2)(self.handle, image, subresource, layout)
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdPushDescriptorSet.html>
+    #[inline]
+    #[doc(alias = "vkCmdPushDescriptorSet")]
+    pub unsafe fn cmd_push_descriptor_set(
+        &self,
+        command_buffer: vk::CommandBuffer,
+        pipeline_bind_point: vk::PipelineBindPoint,
+        layout: vk::PipelineLayout,
+        set: u32,
+        descriptor_writes: &[vk::WriteDescriptorSet<'_>],
+    ) {
+        (self.device_fn_1_4.cmd_push_descriptor_set)(
+            command_buffer,
+            pipeline_bind_point,
+            layout,
+            set,
+            descriptor_writes.len() as u32,
+            descriptor_writes.as_ptr(),
+        )
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdPushDescriptorSetWithTemplate.html>
+    #[inline]
+    #[doc(alias = "vkCmdPushDescriptorSetWithTemplate")]
+    pub unsafe fn cmd_push_descriptor_set_with_template(
+        &self,
+        command_buffer: vk::CommandBuffer,
+        descriptor_update_template: vk::DescriptorUpdateTemplate,
+        layout: vk::PipelineLayout,
+        set: u32,
+        p_data: *const ffi::c_void,
+    ) {
+        (self.device_fn_1_4.cmd_push_descriptor_set_with_template)(
+            command_buffer,
+            descriptor_update_template,
+            layout,
+            set,
+            p_data,
+        )
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdSetRenderingAttachmentLocations.html>
+    #[inline]
+    #[doc(alias = "vkCmdSetRenderingAttachmentLocations")]
+    pub unsafe fn cmd_set_rendering_attachment_locations(
+        &self,
+        command_buffer: vk::CommandBuffer,
+        location_info: &vk::RenderingAttachmentLocationInfo<'_>,
+    ) {
+        (self.device_fn_1_4.cmd_set_rendering_attachment_locations)(command_buffer, location_info)
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdSetRenderingInputAttachmentIndices.html>
+    #[inline]
+    #[doc(alias = "vkCmdSetRenderingInputAttachmentIndices")]
+    pub unsafe fn cmd_set_rendering_input_attachment_indices(
+        &self,
+        command_buffer: vk::CommandBuffer,
+        input_attachment_index_info: &vk::RenderingInputAttachmentIndexInfo<'_>,
+    ) {
+        (self
+            .device_fn_1_4
+            .cmd_set_rendering_input_attachment_indices)(
+            command_buffer,
+            input_attachment_index_info,
+        )
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdBindDescriptorSets2.html>
+    #[inline]
+    #[doc(alias = "vkCmdBindDescriptorSets2")]
+    pub unsafe fn cmd_bind_descriptor_sets2(
+        &self,
+        command_buffer: vk::CommandBuffer,
+        bind_descriptor_sets_info: &vk::BindDescriptorSetsInfo<'_>,
+    ) {
+        (self.device_fn_1_4.cmd_bind_descriptor_sets2)(command_buffer, bind_descriptor_sets_info)
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdPushConstants2.html>
+    #[inline]
+    #[doc(alias = "vkCmdPushConstants2")]
+    pub unsafe fn cmd_push_constants2(
+        &self,
+        command_buffer: vk::CommandBuffer,
+        push_constants_info: &vk::PushConstantsInfo<'_>,
+    ) {
+        (self.device_fn_1_4.cmd_push_constants2)(command_buffer, push_constants_info)
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdPushDescriptorSet2.html>
+    #[inline]
+    #[doc(alias = "vkCmdPushDescriptorSet2")]
+    pub unsafe fn cmd_push_descriptor_set2(
+        &self,
+        command_buffer: vk::CommandBuffer,
+        push_descriptor_set_info: &vk::PushDescriptorSetInfo<'_>,
+    ) {
+        (self.device_fn_1_4.cmd_push_descriptor_set2)(command_buffer, push_descriptor_set_info)
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdPushDescriptorSetWithTemplate2.html>
+    #[inline]
+    #[doc(alias = "vkCmdPushDescriptorSetWithTemplate2")]
+    pub unsafe fn cmd_push_descriptor_set_with_template2(
+        &self,
+        command_buffer: vk::CommandBuffer,
+        push_descriptor_set_with_template_info: &vk::PushDescriptorSetWithTemplateInfo<'_>,
+    ) {
+        (self.device_fn_1_4.cmd_push_descriptor_set_with_template2)(
+            command_buffer,
+            push_descriptor_set_with_template_info,
+        )
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCopyMemoryToImage.html>
+    #[inline]
+    #[doc(alias = "vkCopyMemoryToImage")]
+    pub unsafe fn copy_memory_to_image(
+        &self,
+        copy_memory_to_image_info: &vk::CopyMemoryToImageInfo<'_>,
+    ) -> VkResult<()> {
+        (self.device_fn_1_4.copy_memory_to_image)(self.handle, copy_memory_to_image_info).result()
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCopyImageToMemory.html>
+    #[inline]
+    #[doc(alias = "vkCopyImageToMemory")]
+    pub unsafe fn copy_image_to_memory(
+        &self,
+        copy_image_to_memory_info: &vk::CopyImageToMemoryInfo<'_>,
+    ) -> VkResult<()> {
+        (self.device_fn_1_4.copy_image_to_memory)(self.handle, copy_image_to_memory_info).result()
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCopyImageToImage.html>
+    #[inline]
+    #[doc(alias = "vkCopyImageToImage")]
+    pub unsafe fn copy_image_to_image(
+        &self,
+        copy_image_to_image_info: &vk::CopyImageToImageInfo<'_>,
+    ) -> VkResult<()> {
+        (self.device_fn_1_4.copy_image_to_image)(self.handle, copy_image_to_image_info).result()
+    }
+
+    /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkTransitionImageLayout.html>
+    #[inline]
+    #[doc(alias = "vkTransitionImageLayout")]
+    pub unsafe fn transition_image_layout(
+        &self,
+        transitions: &[vk::HostImageLayoutTransitionInfo<'_>],
+    ) -> VkResult<()> {
+        (self.device_fn_1_4.transition_image_layout)(
+            self.handle,
+            transitions.len() as u32,
+            transitions.as_ptr(),
+        )
+        .result()
+    }
+}
+
 /// Vulkan core 1.3
 impl Device {
     #[inline]

ash/src/extensions/ext/host_image_copy.rs

@@ -8,6 +8,7 @@ use crate::{ext, khr};
 impl crate::ext::host_image_copy::Device {
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCopyMemoryToImageEXT.html>
     #[inline]
+    #[doc(alias = "vkCopyMemoryToImageEXT")]
     pub unsafe fn copy_memory_to_image(
         &self,
         copy_memory_to_image_info: &vk::CopyMemoryToImageInfoEXT<'_>,
@@ -17,6 +18,7 @@ impl crate::ext::host_image_copy::Device {
 
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCopyImageToMemoryEXT.html>
     #[inline]
+    #[doc(alias = "vkCopyImageToMemoryEXT")]
     pub unsafe fn copy_image_to_memory(
         &self,
         copy_image_to_memory_info: &vk::CopyImageToMemoryInfoEXT<'_>,
@@ -26,6 +28,7 @@ impl crate::ext::host_image_copy::Device {
 
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCopyImageToImageEXT.html>
     #[inline]
+    #[doc(alias = "vkCopyImageToImageEXT")]
     pub unsafe fn copy_image_to_image(
         &self,
         copy_image_to_image_info: &vk::CopyImageToImageInfoEXT<'_>,
@@ -35,6 +38,7 @@ impl crate::ext::host_image_copy::Device {
 
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkTransitionImageLayoutEXT.html>
     #[inline]
+    #[doc(alias = "vkTransitionImageLayoutEXT")]
     pub unsafe fn transition_image_layout(
         &self,
         transitions: &[vk::HostImageLayoutTransitionInfoEXT<'_>],

ash/src/extensions/khr/dynamic_rendering_local_read.rs

@@ -5,6 +5,7 @@ use crate::vk;
 impl crate::khr::dynamic_rendering_local_read::Device {
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdSetRenderingAttachmentLocationsKHR.html>
     #[inline]
+    #[doc(alias = "vkCmdSetRenderingAttachmentLocations")]
     pub unsafe fn cmd_set_rendering_attachment_locations(
         &self,
         command_buffer: vk::CommandBuffer,
@@ -15,6 +16,7 @@ impl crate::khr::dynamic_rendering_local_read::Device {
 
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkCmdSetRenderingInputAttachmentIndicesKHR.html>
     #[inline]
+    #[doc(alias = "vkCmdSetRenderingInputAttachmentIndices")]
     pub unsafe fn cmd_set_rendering_input_attachment_indices(
         &self,
         command_buffer: vk::CommandBuffer,