IEngineFactoryVk: added GetVulkanVersion method (API256009)

Author: TheMostDiligent

Graphics/GraphicsEngine/interface/APIInfo.h

@@ -30,7 +30,7 @@
 /// \file
 /// Diligent API information
 
-#define DILIGENT_API_VERSION 256008
+#define DILIGENT_API_VERSION 256009
 
 #include "../../../Primitives/interface/BasicTypes.h"
 

Graphics/GraphicsEngineVulkan/include/VulkanUtilities/Instance.hpp

@@ -48,6 +48,8 @@ class Instance : public std::enable_shared_from_this<Instance>
     Instance& operator = (      Instance&&) = delete;
     // clang-format on
 
+    static uint32_t GetApiVersion();
+
     struct CreateInfo
     {
         uint32_t           ApiVersion             = 0;

Graphics/GraphicsEngineVulkan/interface/EngineFactoryVk.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -99,13 +99,19 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactoryVk, IEngineFactory)
                                            const NativeWindow REF  Window,
                                            ISwapChain**            ppSwapChain) PURE;
 
-    /// Enable device simulation layer (if available).
+    /// Enables device simulation layer (if available).
 
     /// Vulkan instance will be created with the device simulation layer.
     /// Use VK_DEVSIM_FILENAME environment variable to define the path to the .json file.
     ///
     /// \remarks Use this function before calling EnumerateAdapters() and CreateDeviceAndContextsVk().
     VIRTUAL void METHOD(EnableDeviceSimulation)(THIS) PURE;
+
+
+    /// Returns the supported Vulkan version. If Vulkan is not supported, returns 0.
+
+    /// This function can be used to check whether Vulkan is supported on the platform.
+    VIRTUAL Version METHOD(GetVulkanVersion)(THIS) CONST PURE;
 };
 DILIGENT_END_INTERFACE
 
@@ -118,6 +124,7 @@ DILIGENT_END_INTERFACE
 #    define IEngineFactoryVk_CreateDeviceAndContextsVk(This, ...) CALL_IFACE_METHOD(EngineFactoryVk, CreateDeviceAndContextsVk, This, __VA_ARGS__)
 #    define IEngineFactoryVk_CreateSwapChainVk(This, ...)         CALL_IFACE_METHOD(EngineFactoryVk, CreateSwapChainVk,         This, __VA_ARGS__)
 #    define IEngineFactoryVk_EnableDeviceSimulation(This)         CALL_IFACE_METHOD(EngineFactoryVk, EnableDeviceSimulation,    This)
+#    define IEngineFactoryVk_GetVulkanVersion(This)               CALL_IFACE_METHOD(EngineFactoryVk, GetVulkanVersion,          This)
 
 // clang-format on
 

Graphics/GraphicsEngineVulkan/src/EngineFactoryVk.cpp

@@ -116,6 +116,12 @@ class EngineFactoryVkImpl final : public EngineFactoryBase<IEngineFactoryVk>
         m_EnableDeviceSimulation = true;
     }
 
+    virtual Version DILIGENT_CALL_TYPE GetVulkanVersion() const override final
+    {
+        uint32_t ApiVersion = VulkanUtilities::Instance::GetApiVersion();
+        return {VK_VERSION_MAJOR(ApiVersion), VK_VERSION_MINOR(ApiVersion)};
+    }
+
     virtual void DILIGENT_CALL_TYPE CreateDearchiver(const DearchiverCreateInfo& CreateInfo,
                                                      IDearchiver**               ppDearchiver) const override final
     {

Graphics/GraphicsEngineVulkan/src/VulkanUtilities/Instance.cpp

@@ -257,15 +257,65 @@ static bool LoadVulkan()
     if (VulkanLoaded)
         return true;
 
-    if (volkInitialize() == VK_SUCCESS)
+    VulkanLoaded = (volkInitialize() == VK_SUCCESS);
+    return VulkanLoaded;
+}
+#endif
+
+uint32_t Instance::GetApiVersion()
+{
+#if DILIGENT_USE_VOLK
+    if (!LoadVulkan())
     {
-        VulkanLoaded = true;
+        return 0;
     }
+#endif
 
-    return VulkanLoaded;
-}
+    uint32_t ApiVersion = VK_API_VERSION_1_0;
+#if DILIGENT_USE_VOLK
+    if (vkEnumerateInstanceVersion != nullptr)
+    {
+        vkEnumerateInstanceVersion(&ApiVersion);
+    }
 #endif
 
+    VkApplicationInfo AppInfo{};
+    AppInfo.sType      = VK_STRUCTURE_TYPE_APPLICATION_INFO;
+    AppInfo.apiVersion = ApiVersion;
+
+    VkInstanceCreateInfo InstCI{};
+    InstCI.sType            = VK_STRUCTURE_TYPE_INSTANCE_CREATE_INFO;
+    InstCI.pApplicationInfo = &AppInfo;
+
+    VkInstance vkInstance = VK_NULL_HANDLE;
+    VkResult   Result     = vkCreateInstance(&InstCI, nullptr, &vkInstance);
+    if (Result != VK_SUCCESS)
+    {
+        return 0;
+    }
+
+    uint32_t DeviceCount = 0;
+    if (PFN_vkEnumeratePhysicalDevices EnumeratePhysicalDevices = reinterpret_cast<PFN_vkEnumeratePhysicalDevices>(vkGetInstanceProcAddr(vkInstance, "vkEnumeratePhysicalDevices")))
+    {
+        Result = EnumeratePhysicalDevices(vkInstance, &DeviceCount, nullptr);
+    }
+    else
+    {
+        UNEXPECTED("Unable to load vkEnumeratePhysicalDevices function.");
+    }
+
+    if (PFN_vkDestroyInstance DestroyInstance = reinterpret_cast<PFN_vkDestroyInstance>(vkGetInstanceProcAddr(vkInstance, "vkDestroyInstance")))
+    {
+        DestroyInstance(vkInstance, nullptr);
+    }
+    else
+    {
+        UNEXPECTED("Unable to load vkDestroyInstance function.");
+    }
+
+    return DeviceCount > 0 ? ApiVersion : 0;
+}
+
 Instance::Instance(const CreateInfo& CI) :
     m_pvkAllocator{CI.pVkAllocator}
 {

ReleaseHistory.md

@@ -2,6 +2,7 @@
 
 ## Current progress
 
+* Added `IEngineFactoryVk::GetVulkanVersion` method (API256009)
 * Added `SHADER_COMPILE_FLAG_HLSL_TO_SPIRV_VIA_GLSL` flag (API256008)
 * Added `IRenderDevice::CreateDeferredContext()` method (API256007)
 * Added `HostImageCopy` member to `DeviceFeaturesVk` struct (API256006)

Tests/GPUTestFramework/src/GPUTestingEnvironment.cpp

@@ -393,6 +393,9 @@ GPUTestingEnvironment::GPUTestingEnvironment(const CreateInfo& EnvCI, const Swap
             pFactoryVk->SetMessageCallback(EnvCI.MessageCallback);
             pFactoryVk->SetBreakOnError(false);
 
+            Version VulkanVersion = pFactoryVk->GetVulkanVersion();
+            VERIFY(VulkanVersion >= Version(1, 0), "Vulkan is not supported on this platform.");
+
             if (EnvCI.EnableDeviceSimulation)
                 pFactoryVk->EnableDeviceSimulation();