Compilation error in createWindowSurfaceUnique

[cone-forest]

Hi there!
I've been using vkfw for quite a while now and recently it broke my compilation.

System Info:
Vulkan Instance Version: 1.4.321
Compiler: GCC 15.1.1

Compilation error on glfw-3.4 branch

vkfw.hpp: In function ‘vk::UniqueSurfaceKHR vkfw::createWindowSurfaceUnique(const vk::Instance&, const Window&, const VkAllocationCallbacks*)’:
vkfw.hpp:3076:9: error: ‘ObjectDestroy’ is not a member of ‘vk’; did you mean ‘vk::detail::ObjectDestroy’?
 3076 |     vk::ObjectDestroy<vk::Instance, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE> deleter(instance, nullptr);
      |         ^~~~~~~~~~~~~
In file included from /home/michael/Development/Personal/mr-graphics/src/pch.hpp:40:
/usr/include/vulkan/vulkan.hpp:6538:11: note: ‘vk::detail::ObjectDestroy’ declared here
 6538 |     class ObjectDestroy
      |           ^~~~~~~~~~~~~
vkfw.hpp:3076:35: error: expected primary-expression before ‘,’ token
 3076 |     vk::ObjectDestroy<vk::Instance, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE> deleter(instance, nullptr);
      |                                   ^
vkfw.hpp:3076:71: error: expected primary-expression before ‘>’ token
 3076 |     vk::ObjectDestroy<vk::Instance, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE> deleter(instance, nullptr);
      |                                                                       ^
vkfw.hpp:3076:73: error: ‘deleter’ was not declared in this scope
 3076 |     vk::ObjectDestroy<vk::Instance, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE> deleter(instance, nullptr);
      |                                                                         ^~~~~~~

Then switched to main branch

vkfw.hpp:3134:34: error: cannot convert ‘const VkAllocationCallbacks’ to ‘void*’ in initialization
 3134 |       vulkan_hpp_allocator = vk::AllocationCallbacks(*allocator);
      |                                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Then switched to 85f510d

vkfw.hpp:3132:81: error: no matching function for call to ‘vk::detail::ObjectDestroy<vk::Instance, vk::detail::DispatchLoaderStatic>::ObjectDestroy(const vk::Instance&, const vk::detail::DispatchLoaderStatic&)’
 3132 |     vk::detail::ObjectDestroy<vk::Instance, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE> deleter(instance,
      |                                                                                 ^~~~~~~
vkfw.hpp:3132:81: note: there are 4 candidates
In file included from pch.hpp:40:
/usr/include/vulkan/vulkan.hpp:6543:7: note: candidate 1: ‘vk::detail::ObjectDestroy<OwnerType, Dispatch>::ObjectDestroy(OwnerType, vk::Optional<const vk::AllocationCallbacks>, const Dispatch&) [with OwnerType = vk::Instance; Dispatch = vk::detail::DispatchLoaderStatic]’
 6543 |       ObjectDestroy( OwnerType                                               owner,
      |       ^~~~~~~~~~~~~
/usr/include/vulkan/vulkan.hpp:6544:58: note: no known conversion for argument 2 from ‘const vk::detail::DispatchLoaderStatic’ to ‘vk::Optional<const vk::AllocationCallbacks>’
 6544 |                      Optional<const AllocationCallbacks> allocationCallbacks VULKAN_HPP_DEFAULT_ARGUMENT_NULLPTR_ASSIGNMENT,
      |                                                          ^
/usr/include/vulkan/vulkan.hpp:6541:7: note: candidate 2: ‘constexpr vk::detail::ObjectDestroy<OwnerType, Dispatch>::ObjectDestroy() [with OwnerType = vk::Instance; Dispatch = vk::detail::DispatchLoaderStatic]’
 6541 |       ObjectDestroy() = default;
      |       ^~~~~~~~~~~~~
/usr/include/vulkan/vulkan.hpp:6541:7: note: candidate expects 0 arguments, 2 provided
/usr/include/vulkan/vulkan.hpp:6538:11: note: candidate 3: ‘constexpr vk::detail::ObjectDestroy<vk::Instance, vk::detail::DispatchLoaderStatic>::ObjectDestroy(const vk::detail::ObjectDestroy<vk::Instance, vk::detail::DispatchLoaderStatic>&)’
 6538 |     class ObjectDestroy
      |           ^~~~~~~~~~~~~

Not sure what is going on here. Looks like a battle with type system. I ended up commenting deleter out

diff --git a/include/vkfw/vkfw.hpp b/include/vkfw/vkfw.hpp
index d6adf65..ab134fa 100644
--- a/include/vkfw/vkfw.hpp
+++ b/include/vkfw/vkfw.hpp
@@ -3073,8 +3073,9 @@ namespace VKFW_NAMESPACE {
     VkSurfaceKHR output;
     glfwCreateWindowSurface(instance, window, allocator, &output);
 
-    vk::ObjectDestroy<vk::Instance, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE> deleter(instance, nullptr);
-    return vk::UniqueSurfaceKHR(output, deleter);
+    // vk::ObjectDestroy<vk::Instance, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE> deleter(instance, nullptr);
+    // return vk::UniqueSurfaceKHR(output, deleter);
+    return vk::UniqueSurfaceKHR(output);
   }
     #endif
   #endif

[Cvelth]

Hi, thanks making this issue!

First of all, looks like glfw-3.4 is quite a bit outdated, so I just pushed it to match master (I had no idea anyone was using it :D)

Then, about your fix with omitting the deleter. Doing it that way makes it so the surface is never properly cleaned up. It might not be a big deal if your program only creates a handful of long-living surfaces, but it's a memory leak nevertheless.

As for the proper fix, what do vk::ObjectDestroy constructors look like under your specific vulkan version? From the error message, it looks like they want allocationCallbacks too (which we already have in this context (see the allocator argument), so it might just be a matter of passing that in!

[Cvelth]

Ah, wait! It only now hit me that I have already seen this one!

Can you verify whether this commit helps, please?

[Cvelth]

Ah, I'm blind, you already did 😅.

The real issue is this one:

vkfw.hpp:3134:34: error: cannot convert ‘const VkAllocationCallbacks’ to ‘void*’ in initialization
 3134 |       vulkan_hpp_allocator = vk::AllocationCallbacks(*allocator);
      |                                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Can you please show me the constructor of vk::AllocationCallbacks in your version of vulkan.hpp? It's strikes me as extremely weird that it expects void *.

[cone-forest]

Yeah I saw you wrote which constructor you expected to be used in #18 and it is present but it is under

#if !defined( VULKAN_HPP_NO_CONSTRUCTORS ) && !defined( VULKAN_HPP_NO_STRUCT_CONSTRUCTORS )

so it's not available in my application. There is an always-available analogous operator= though.

[cone-forest]

I was able to force usage of assignment operator with this:

diff --git a/include/vkfw/vkfw.hpp b/include/vkfw/vkfw.hpp
index 820d196..9d3bec0 100644
--- a/include/vkfw/vkfw.hpp
+++ b/include/vkfw/vkfw.hpp
@@ -3130,8 +3130,11 @@ namespace VKFW_NAMESPACE {
     glfwCreateWindowSurface(instance, window, allocator, &output);
 
     vk::Optional<vk::AllocationCallbacks const> vulkan_hpp_allocator = nullptr;
-    if (allocator)
-      vulkan_hpp_allocator = vk::AllocationCallbacks(*allocator);
+    if (allocator) {
+      vk::AllocationCallbacks tmp;
+      tmp = *allocator;
+      vulkan_hpp_allocator = tmp;
+    }
 
       #if (VK_HEADER_VERSION) >= 301
     vk::detail::ObjectDestroy<vk::Instance, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE>

[Cvelth]

Ah, great, then I think we should go with something like

     glfwCreateWindowSurface(instance, window, allocator, &output);
 
     vk::Optional<vk::AllocationCallbacks const> vulkan_hpp_allocator = nullptr;
     if (allocator)
+ #if !defined( VULKAN_HPP_NO_CONSTRUCTORS ) && !defined( VULKAN_HPP_NO_STRUCT_CONSTRUCTORS )
       vulkan_hpp_allocator = vk::AllocationCallbacks(*allocator);
+ #else
+      vulkan_hpp_allocator = (vk::AllocationCallbacks() = *allocator);
+ #endif
 
       #if (VK_HEADER_VERSION) >= 301
     vk::detail::ObjectDestroy<vk::Instance, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE>

What do you think?

If this works, can you open the PR please?

P. S. If this one-liner trick doesn't work, let's go with your suggestion and use an explicit tmp!

[Cvelth]

Actually, maybe we should use explicit tmp anyway. No point being extra tricky to save a line or two 🤔.

[cone-forest]

Damn that one liner trickery is crazy. Gonna open PR right now!

[cone-forest]

This trick did work but I feel like it might brake much more likely than explicit tmp. Opened #23