fixup! generator: Separate Fn struct

ash-rs · Mar 17, 2024 · f06c0c7 · f06c0c7
1 parent 05d0cf0
commit f06c0c7
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 21 deletions.
diff --git a/ash-examples/src/lib.rs b/ash-examples/src/lib.rs
@@ -23,7 +23,7 @@ use std::os::raw::c_char;
 
 #[cfg(any(target_os = "macos", target_os = "ios"))]
 use ash::vk::{
-    KhrGetPhysicalDeviceProperties2Fn, KhrPortabilityEnumerationFn, KhrPortabilitySubsetFn,
+    khr_get_physical_device_properties2, khr_portability_enumeration, khr_portability_subset,
 };
 
 use winit::{
@@ -238,9 +238,9 @@ impl ExampleBase {
 
             #[cfg(any(target_os = "macos", target_os = "ios"))]
             {
-                extension_names.push(KhrPortabilityEnumerationFn::NAME.as_ptr());
+                extension_names.push(khr_portability_enumeration::NAME.as_ptr());
                 // Enabling this extension is a requirement when using `VK_KHR_portability_subset`
-                extension_names.push(KhrGetPhysicalDeviceProperties2Fn::NAME.as_ptr());
+                extension_names.push(khr_get_physical_device_properties2::NAME.as_ptr());
             }
 
             let appinfo = vk::ApplicationInfo::default()
@@ -324,7 +324,7 @@ impl ExampleBase {
             let device_extension_names_raw = [
                 swapchain::NAME.as_ptr(),
                 #[cfg(any(target_os = "macos", target_os = "ios"))]
-                KhrPortabilitySubsetFn::NAME.as_ptr(),
+                khr_portability_subset::NAME.as_ptr(),
             ];
             let features = vk::PhysicalDeviceFeatures {
                 shader_clip_distance: 1,

diff --git a/ash-window/src/lib.rs b/ash-window/src/lib.rs
@@ -2,6 +2,8 @@
 
 use std::os::raw::c_char;
 
+#[cfg(doc)]
+use ash::extensions::khr;
 use ash::{
     extensions::{
         ext::metal_surface,
@@ -23,9 +25,9 @@ use raw_window_handle::{RawDisplayHandle, RawWindowHandle};
 ///
 /// There is a [parent/child relation] between [`Instance`] and [`Entry`], and the resulting
 /// [`vk::SurfaceKHR`].  The application must not [destroy][Instance::destroy_instance()] these
-/// parent objects before first [destroying][khr::Surface::destroy_surface()] the returned
+/// parent objects before first [destroying][khr::surface::Instance::destroy_surface()] the returned
 /// [`vk::SurfaceKHR`] child object.  [`vk::SurfaceKHR`] does _not_ implement [drop][drop()]
-/// semantics and can only be destroyed via [`destroy_surface()`][khr::Surface::destroy_surface()].
+/// semantics and can only be destroyed via [`destroy_surface()`][khr::surface::Instance::destroy_surface()].
 ///
 /// See the [`Entry::create_instance()`] documentation for more destruction ordering rules on
 /// [`Instance`].

diff --git a/ash/src/extensions/ext/host_image_copy.rs b/ash/src/extensions/ext/host_image_copy.rs
@@ -1,7 +1,7 @@
 //! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_host_image_copy.html>
 
 #[cfg(doc)]
-use super::{super::khr::Maintenance5, ImageCompressionControl};
+use super::{super::khr::maintenance5, image_compression_control};
 use crate::prelude::*;
 use crate::vk;
 use std::ffi::CStr;
@@ -67,10 +67,10 @@ impl Device {
 
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetImageSubresourceLayout2EXT.html>
     ///
-    /// Also available as [`Maintenance5::get_image_subresource_layout2()`]
+    /// Also available as [`maintenance5::Device::get_image_subresource_layout2()`]
     /// when [`VK_KHR_maintenance5`] is enabled.
     ///
-    /// Also available as [`ImageCompressionControl::get_image_subresource_layout2()`]
+    /// Also available as [`image_compression_control::Device::get_image_subresource_layout2()`]
     /// when [`VK_EXT_image_compression_control`] is enabled.
     ///
     /// [`VK_KHR_maintenance5`]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_maintenance5.html

diff --git a/ash/src/extensions/ext/image_compression_control.rs b/ash/src/extensions/ext/image_compression_control.rs
@@ -1,7 +1,7 @@
 //! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_image_compression_control.html>
 
 #[cfg(doc)]
-use super::{super::khr::Maintenance5, HostImageCopy};
+use super::{super::khr::maintenance5, host_image_copy};
 use crate::vk;
 use std::ffi::CStr;
 use std::mem;
@@ -25,10 +25,10 @@ impl Device {
 
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetImageSubresourceLayout2EXT.html>
     ///
-    /// Also available as [`Maintenance5::get_image_subresource_layout2()`]
+    /// Also available as [`maintenance5::Device::get_image_subresource_layout2()`]
     /// when [`VK_KHR_maintenance5`] is enabled.
     ///
-    /// Also available as [`HostImageCopy::get_image_subresource_layout2()`]
+    /// Also available as [`host_image_copy::Device::get_image_subresource_layout2()`]
     /// when [`VK_EXT_host_image_copy`] is enabled.
     ///
     /// [`VK_KHR_maintenance5`]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_maintenance5.html

diff --git a/ash/src/extensions/khr/device_group.rs b/ash/src/extensions/khr/device_group.rs
@@ -1,7 +1,7 @@
 //! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_device_group.html>
 
 #[cfg(doc)]
-use super::swapchain::{Device, Instance};
+use super::swapchain;
 use crate::prelude::*;
 use crate::vk;
 use std::ffi::CStr;

diff --git a/ash/src/extensions/khr/maintenance5.rs b/ash/src/extensions/khr/maintenance5.rs
@@ -1,7 +1,7 @@
 //! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_maintenance5.html>
 
 #[cfg(doc)]
-use super::super::ext::{HostImageCopy, ImageCompressionControl};
+use super::super::ext::{host_image_copy, image_compression_control};
 use crate::vk;
 use std::ffi::CStr;
 use std::mem;
@@ -63,10 +63,10 @@ impl Device {
 
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetImageSubresourceLayout2KHR.html>
     ///
-    /// Also available as [`HostImageCopy::get_image_subresource_layout2()`]
+    /// Also available as [`host_image_copy::Device::get_image_subresource_layout2()`]
     /// when [`VK_EXT_host_image_copy`] is enabled.
     ///
-    /// Also available as [`ImageCompressionControl::get_image_subresource_layout2()`]
+    /// Also available as [`image_compression_control::Device::get_image_subresource_layout2()`]
     /// when [`VK_EXT_image_compression_control`] is enabled.
     ///
     /// [`VK_EXT_host_image_copy`]: https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_EXT_host_image_copy.html

diff --git a/ash/src/extensions/khr/swapchain.rs b/ash/src/extensions/khr/swapchain.rs
@@ -1,7 +1,7 @@
 //! <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VK_KHR_swapchain.html>
 
 #[cfg(doc)]
-use super::{DeviceGroupDevice, DeviceGroupInstance};
+use super::device_group;
 use crate::prelude::*;
 use crate::vk;
 use crate::RawPtr;
@@ -110,7 +110,7 @@ impl Device {
 
     /// Only available since [Vulkan 1.1].
     ///
-    /// Also available as [`DeviceGroupDevice::get_device_group_present_capabilities()`]
+    /// Also available as [`device_group::Device::get_device_group_present_capabilities()`]
     /// when [`VK_KHR_surface`] is enabled.
     ///
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetDeviceGroupPresentCapabilitiesKHR.html>
@@ -131,7 +131,7 @@ impl Device {
 
     /// Only available since [Vulkan 1.1].
     ///
-    /// Also available as [`DeviceGroupDevice::get_device_group_surface_present_modes()`]
+    /// Also available as [`device_group::Device::get_device_group_surface_present_modes()`]
     /// when [`VK_KHR_surface`] is enabled.
     ///
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetDeviceGroupSurfacePresentModesKHR.html>
@@ -156,7 +156,7 @@ impl Device {
     ///
     /// Only available since [Vulkan 1.1].
     ///
-    /// Also available as [`DeviceGroupDevice::acquire_next_image2()`]
+    /// Also available as [`device_group::Device::acquire_next_image2()`]
     /// when [`VK_KHR_swapchain`] is enabled.
     ///
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkAcquireNextImage2KHR.html>
@@ -205,7 +205,7 @@ impl Instance {
 
     /// Only available since [Vulkan 1.1].
     ///
-    /// Also available as [`DeviceGroupInstance::get_physical_device_present_rectangles()`]
+    /// Also available as [`device_group::Instance::get_physical_device_present_rectangles()`]
     /// when [`VK_KHR_surface`] is enabled.
     ///
     /// <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/vkGetPhysicalDevicePresentRectanglesKHR.html>

diff --git a/ash/src/vk/extensions.rs b/ash/src/vk/extensions.rs
@@ -1,4 +1,5 @@
 #![allow(unused_qualifications)]
+#![allow(unused_imports)]
 use crate::vk::aliases::*;
 use crate::vk::bitflags::*;
 use crate::vk::definitions::*;

diff --git a/generator/src/lib.rs b/generator/src/lib.rs
@@ -3269,6 +3269,7 @@ pub fn write_source_code<P: AsRef<Path>>(vk_headers_dir: &Path, src_dir: P) {
 
     let extension_code = quote! {
         #![allow(unused_qualifications)] // Because we do not know in what file the PFNs are defined
+        #![allow(unused_imports)]        // for sometimes-dead `use super::*` from generate_extension_commands
 
         use std::os::raw::*;
         use crate::vk::platform_types::*;