Added convenience functions to load the required engine dll and get the factory

Author: TheMostDiligent

Graphics/Archiver/interface/ArchiverFactoryLoader.h

@@ -44,10 +44,10 @@
 
 DILIGENT_BEGIN_NAMESPACE(Diligent)
 
-#if EXPLICITLY_LOAD_ARCHIVER_FACTORY_DLL
-
 typedef struct IArchiverFactory* (*GetArchiverFactoryType)();
 
+#if EXPLICITLY_LOAD_ARCHIVER_FACTORY_DLL
+
 inline GetArchiverFactoryType DILIGENT_GLOBAL_FUNCTION(LoadArchiverFactory)()
 {
     return (GetArchiverFactoryType)LoadEngineDll("Archiver", "GetArchiverFactory");
@@ -60,4 +60,20 @@ struct IArchiverFactory* DILIGENT_GLOBAL_FUNCTION(GetArchiverFactory)();
 
 #endif
 
+/// Loads the archiver implementation DLL if necessary and returns the archiver factory.
+inline struct IArchiverFactory* DILIGENT_GLOBAL_FUNCTION(LoadAndGetArchiverFactory)()
+{
+    GetArchiverFactoryType GetFactoryFunc = NULL;
+#if EXPLICITLY_LOAD_ARCHIVER_FACTORY_DLL
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(LoadArchiverFactory)();
+    if (GetFactoryFunc == NULL)
+    {
+        return NULL;
+    }
+#else
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(GetArchiverFactory);
+#endif
+    return GetFactoryFunc();
+}
+
 DILIGENT_END_NAMESPACE // namespace Diligent

Graphics/GraphicsEngineD3D11/interface/EngineFactoryD3D11.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");
@@ -151,11 +151,10 @@ DILIGENT_END_INTERFACE
 
 #endif
 
+typedef struct IEngineFactoryD3D11* (*GetEngineFactoryD3D11Type)();
 
 #if ENGINE_DLL
 
-typedef struct IEngineFactoryD3D11* (*GetEngineFactoryD3D11Type)();
-
 inline GetEngineFactoryD3D11Type DILIGENT_GLOBAL_FUNCTION(LoadGraphicsEngineD3D11)()
 {
     return (GetEngineFactoryD3D11Type)LoadEngineDll("GraphicsEngineD3D11", "GetEngineFactoryD3D11");
@@ -167,4 +166,20 @@ struct IEngineFactoryD3D11* DILIGENT_GLOBAL_FUNCTION(GetEngineFactoryD3D11)();
 
 #endif
 
+/// Loads the graphics engine D3D11 implementation DLL if necessary and returns the engine factory.
+inline struct IEngineFactoryD3D11* DILIGENT_GLOBAL_FUNCTION(LoadAndGetEngineFactoryD3D11)()
+{
+    GetEngineFactoryD3D11Type GetFactoryFunc = NULL;
+#if ENGINE_DLL
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(LoadGraphicsEngineD3D11)();
+    if (GetFactoryFunc == NULL)
+    {
+        return NULL;
+    }
+#else
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(GetEngineFactoryD3D11);
+#endif
+    return GetFactoryFunc();
+}
+
 DILIGENT_END_NAMESPACE // namespace Diligent

Graphics/GraphicsEngineD3D12/interface/EngineFactoryD3D12.h

@@ -187,10 +187,10 @@ DILIGENT_END_INTERFACE
 #endif
 
 
-#if ENGINE_DLL
-
 typedef struct IEngineFactoryD3D12* (*GetEngineFactoryD3D12Type)();
 
+#if ENGINE_DLL
+
 inline GetEngineFactoryD3D12Type DILIGENT_GLOBAL_FUNCTION(LoadGraphicsEngineD3D12)()
 {
     return (GetEngineFactoryD3D12Type)LoadEngineDll("GraphicsEngineD3D12", "GetEngineFactoryD3D12");
@@ -202,4 +202,21 @@ struct IEngineFactoryD3D12* DILIGENT_GLOBAL_FUNCTION(GetEngineFactoryD3D12)();
 
 #endif
 
+/// Loads the graphics engine D3D12 implementation DLL if necessary and returns the engine factory.
+inline struct IEngineFactoryD3D12* DILIGENT_GLOBAL_FUNCTION(LoadAndGetEngineFactoryD3D12)()
+{
+    GetEngineFactoryD3D12Type GetFactoryFunc = NULL;
+#if ENGINE_DLL
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(LoadGraphicsEngineD3D12)();
+    if (GetFactoryFunc == NULL)
+    {
+        return NULL;
+    }
+#else
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(GetEngineFactoryD3D12);
+#endif
+    return GetFactoryFunc();
+}
+
+
 DILIGENT_END_NAMESPACE // namespace Diligent

Graphics/GraphicsEngineOpenGL/interface/EngineFactoryOpenGL.h

@@ -124,11 +124,10 @@ DILIGENT_END_INTERFACE
 
 #endif
 
+typedef struct IEngineFactoryOpenGL* (*GetEngineFactoryOpenGLType)();
 
 #if EXPLICITLY_LOAD_ENGINE_GL_DLL
 
-typedef struct IEngineFactoryOpenGL* (*GetEngineFactoryOpenGLType)();
-
 inline GetEngineFactoryOpenGLType DILIGENT_GLOBAL_FUNCTION(LoadGraphicsEngineOpenGL)()
 {
     return (GetEngineFactoryOpenGLType)LoadEngineDll("GraphicsEngineOpenGL", "GetEngineFactoryOpenGL");
@@ -142,4 +141,20 @@ struct IEngineFactoryOpenGL* DILIGENT_GLOBAL_FUNCTION(GetEngineFactoryOpenGL)();
 
 #endif
 
+/// Loads the graphics engine OpenGL implementation DLL if necessary and returns the engine factory.
+inline struct IEngineFactoryOpenGL* DILIGENT_GLOBAL_FUNCTION(LoadAndGetEngineFactoryOpenGL)()
+{
+    GetEngineFactoryOpenGLType GetFactoryFunc = NULL;
+#if EXPLICITLY_LOAD_ENGINE_GL_DLL
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(LoadGraphicsEngineOpenGL)();
+    if (GetFactoryFunc == NULL)
+    {
+        return NULL;
+    }
+#else
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(GetEngineFactoryOpenGL);
+#endif
+    return GetFactoryFunc();
+}
+
 DILIGENT_END_NAMESPACE // namespace Diligent

Graphics/GraphicsEngineVulkan/interface/EngineFactoryVk.h

@@ -130,10 +130,10 @@ DILIGENT_END_INTERFACE
 
 #endif
 
-#if EXPLICITLY_LOAD_ENGINE_VK_DLL
-
 typedef struct IEngineFactoryVk* (*GetEngineFactoryVkType)();
 
+#if EXPLICITLY_LOAD_ENGINE_VK_DLL
+
 inline GetEngineFactoryVkType DILIGENT_GLOBAL_FUNCTION(LoadGraphicsEngineVk)()
 {
     return (GetEngineFactoryVkType)LoadEngineDll("GraphicsEngineVk", "GetEngineFactoryVk");
@@ -146,4 +146,20 @@ struct IEngineFactoryVk* DILIGENT_GLOBAL_FUNCTION(GetEngineFactoryVk)();
 
 #endif
 
+/// Loads the graphics engine Vulkan implementation DLL if necessary and returns the engine factory.
+inline struct IEngineFactoryVk* DILIGENT_GLOBAL_FUNCTION(LoadAndGetEngineFactoryVk)()
+{
+    GetEngineFactoryVkType GetFactoryFunc = NULL;
+#if EXPLICITLY_LOAD_ENGINE_VK_DLL
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(LoadGraphicsEngineVk)();
+    if (GetFactoryFunc == NULL)
+    {
+        return NULL;
+    }
+#else
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(GetEngineFactoryVk);
+#endif
+    return GetFactoryFunc();
+}
+
 DILIGENT_END_NAMESPACE // namespace Diligent

Graphics/GraphicsEngineWebGPU/interface/EngineFactoryWebGPU.h

@@ -139,10 +139,10 @@ DILIGENT_END_INTERFACE
 #endif
 
 
-#if EXPLICITLY_LOAD_ENGINE_WEBGPU_DLL
-
 typedef struct IEngineFactoryWebGPU* (*GetEngineFactoryWebGPUType)();
 
+#if EXPLICITLY_LOAD_ENGINE_WEBGPU_DLL
+
 inline GetEngineFactoryWebGPUType DILIGENT_GLOBAL_FUNCTION(LoadGraphicsEngineWebGPU)()
 {
     return (GetEngineFactoryWebGPUType)LoadEngineDll("GraphicsEngineWebGPU", "GetEngineFactoryWebGPU");
@@ -155,4 +155,20 @@ struct IEngineFactoryWebGPU* DILIGENT_GLOBAL_FUNCTION(GetEngineFactoryWebGPU)();
 
 #endif
 
+/// Loads the graphics engine WebGPU implementation DLL if necessary and returns the engine factory.
+inline struct IEngineFactoryWebGPU* DILIGENT_GLOBAL_FUNCTION(LoadAndGetEngineFactoryWebGPU)()
+{
+    GetEngineFactoryWebGPUType GetFactoryFunc = NULL;
+#if EXPLICITLY_LOAD_ENGINE_WEBGPU_DLL
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(LoadGraphicsEngineWebGPU)();
+    if (GetFactoryFunc == NULL)
+    {
+        return NULL;
+    }
+#else
+    GetFactoryFunc = DILIGENT_GLOBAL_FUNCTION(GetEngineFactoryWebGPU);
+#endif
+    return GetFactoryFunc();
+}
+
 DILIGENT_END_NAMESPACE // namespace Diligent

Graphics/GraphicsTools/src/RenderStateCacheImpl.cpp

@@ -179,16 +179,7 @@ RenderStateCacheImpl::RenderStateCacheImpl(IReferenceCounters*               pRe
     if (CreateInfo.pDevice == nullptr)
         LOG_ERROR_AND_THROW("CreateInfo.pDevice must not be null");
 
-    IArchiverFactory* pArchiverFactory = nullptr;
-#if EXPLICITLY_LOAD_ARCHIVER_FACTORY_DLL
-    auto GetArchiverFactory = LoadArchiverFactory();
-    if (GetArchiverFactory != nullptr)
-    {
-        pArchiverFactory = GetArchiverFactory();
-    }
-#else
-    pArchiverFactory       = GetArchiverFactory();
-#endif
+    IArchiverFactory* pArchiverFactory = LoadAndGetArchiverFactory();
     VERIFY_EXPR(pArchiverFactory != nullptr);
 
     SerializationDeviceCreateInfo SerializationDeviceCI;

Tests/GPUTestFramework/src/GPUTestingEnvironment.cpp

@@ -607,15 +607,7 @@ GPUTestingEnvironment::GPUTestingEnvironment(const CreateInfo& EnvCI, const Swap
 #if ARCHIVER_SUPPORTED
     // Create archiver factory
     {
-#    if EXPLICITLY_LOAD_ARCHIVER_FACTORY_DLL
-        GetArchiverFactoryType GetArchiverFactory = LoadArchiverFactory();
-        if (GetArchiverFactory != nullptr)
-        {
-            m_ArchiverFactory = GetArchiverFactory();
-        }
-#    else
-        m_ArchiverFactory = Diligent::GetArchiverFactory();
-#    endif
+        m_ArchiverFactory = LoadAndGetArchiverFactory();
         m_ArchiverFactory->SetMessageCallback(EnvCI.MessageCallback);
         m_ArchiverFactory->SetBreakOnError(false);
     }