EngineCreateInfo: replace pRawMemAllocator member with IEngineFactory::SetMemoryAllocator() (API256011)

Added SetMemoryAllocator method to IArchiverFactory (close #703)

Author: TheMostDiligent

Graphics/Archiver/interface/ArchiverFactory.h

@@ -338,6 +338,20 @@ DILIGENT_BEGIN_INTERFACE(IArchiverFactory, IObject)
     /// \param [in]     BreakOnError - Whether to break on assertion failure.
     VIRTUAL void METHOD(SetBreakOnError)(THIS_
                                          bool BreakOnError) CONST PURE;
+
+    /// Sets the memory allocator to be used by the archiver.
+    
+    /// \param [in] pAllocator - Pointer to the memory allocator.
+    ///
+    /// The allocator is a global setting that applies to the entire execution unit
+    /// (executable or shared library that contains the archiver implementation).
+    ///
+    /// The allocator should be set before any other factory method is called and
+    /// should not be changed afterwards.
+    /// The allocator object must remain valid until all objects created by the factory
+    /// are destroyed.
+    VIRTUAL void METHOD(SetMemoryAllocator)(THIS_
+                                            IMemoryAllocator* pAllocator) CONST PURE;
 };
 DILIGENT_END_INTERFACE
 
@@ -353,7 +367,8 @@ DILIGENT_END_INTERFACE
 #    define IArchiverFactory_MergeArchives(This, ...)                           CALL_IFACE_METHOD(ArchiverFactory, MergeArchives,                          This, __VA_ARGS__)
 #    define IArchiverFactory_PrintArchiveContent(This, ...)                     CALL_IFACE_METHOD(ArchiverFactory, PrintArchiveContent,                    This, __VA_ARGS__)
 #    define IArchiverFactory_SetMessageCallback(This, ...)                      CALL_IFACE_METHOD(ArchiverFactory, SetMessageCallback,                     This, __VA_ARGS__)
-#    define IEngineFactory_SetBreakOnError(This, ...)                           CALL_IFACE_METHOD(EngineFactory,   SetBreakOnError,                        This, __VA_ARGS__)
+#    define IArchiverFactory_SetBreakOnError(This, ...)                         CALL_IFACE_METHOD(ArchiverFactory, SetBreakOnError,                        This, __VA_ARGS__)
+#    define IArchiverFactory_SetMemoryAllocator(This, ...)                      CALL_IFACE_METHOD(ArchiverFactory, SetMemoryAllocator,                     This, __VA_ARGS__)
 
 #endif
 

Graphics/Archiver/src/ArchiverFactory.cpp

@@ -143,6 +143,8 @@ class ArchiverFactoryImpl final : public IArchiverFactory
 
     virtual void DILIGENT_CALL_TYPE SetBreakOnError(bool BreakOnError) const override final;
 
+    virtual void DILIGENT_CALL_TYPE SetMemoryAllocator(IMemoryAllocator* pAllocator) const override final;
+
 private:
     DummyReferenceCounters<ArchiverFactoryImpl> m_RefCounters;
 };
@@ -349,6 +351,11 @@ void ArchiverFactoryImpl::SetBreakOnError(bool BreakOnError) const
     PlatformDebug::SetBreakOnError(BreakOnError);
 }
 
+void ArchiverFactoryImpl::SetMemoryAllocator(IMemoryAllocator* pAllocator) const
+{
+    SetRawAllocator(pAllocator);
+}
+
 } // namespace
 
 

Graphics/GraphicsEngine/include/EngineFactoryBase.hpp

@@ -122,6 +122,11 @@ class EngineFactoryBase : public BaseInterface
         PlatformDebug::SetBreakOnError(BreakOnError);
     }
 
+    virtual void DILIGENT_CALL_TYPE SetMemoryAllocator(IMemoryAllocator* pAllocator) const override final
+    {
+        SetRawAllocator(pAllocator);
+    }
+
 protected:
     template <typename DearchiverImplType>
     void CreateDearchiver(const DearchiverCreateInfo& CreateInfo,

Graphics/GraphicsEngine/interface/APIInfo.h

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

Graphics/GraphicsEngine/interface/EngineFactory.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2024 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -33,6 +33,7 @@
 #include "../../../Primitives/interface/Object.h"
 #include "../../../Primitives/interface/DebugOutput.h"
 #include "../../../Primitives/interface/DataBlob.h"
+#include "../../../Primitives/interface/MemoryAllocator.h"
 #include "GraphicsTypes.h"
 
 
@@ -128,16 +129,38 @@ DILIGENT_BEGIN_INTERFACE(IEngineFactory, IObject)
 
     /// Sets a user-provided debug message callback.
 
-    /// \param [in]     MessageCallback - Debug message callback function to use instead of the default one.
+    /// \param [in] MessageCallback - Debug message callback function to use instead of the default one.
+    ///
+    /// MessageCallback is a global setting that applies to the entire execution unit
+    /// (executable or shared library that contains the engine implementation).
     VIRTUAL void METHOD(SetMessageCallback)(THIS_
                                             DebugMessageCallbackType MessageCallback) CONST PURE;
 
+
     /// Sets whether to break program execution on assertion failure.
 
-    /// \param [in]     BreakOnError - Whether to break on assertion failure.
+    /// \param [in] BreakOnError - Whether to break on assertion failure.
+    ///
+    /// BreakOnError is a global setting that applies to the entire execution unit 
+    /// (executable or shared library that contains the engine implementation).
     VIRTUAL void METHOD(SetBreakOnError)(THIS_
                                          bool BreakOnError) CONST PURE;
 
+
+    /// Sets the memory allocator to be used by the engine.
+    
+    /// \param [in] pAllocator - Pointer to the memory allocator.
+    ///
+    /// The allocator is a global setting that applies to the entire execution unit
+    /// (executable or shared library that contains the engine implementation).
+    ///
+    /// The allocator should be set before any other factory method is called and
+    /// should not be changed afterwards.
+    /// The allocator object must remain valid for the lifetime of the
+    /// engine until all engine objects are destroyed.
+    VIRTUAL void METHOD(SetMemoryAllocator)(THIS_
+                                            IMemoryAllocator* pAllocator) CONST PURE;
+
 #if PLATFORM_ANDROID
     /// On Android platform, it is necessary to initialize the file system before
     /// CreateDefaultShaderSourceStreamFactory() method can be called.
@@ -171,6 +194,7 @@ DILIGENT_END_INTERFACE
 #    define IEngineFactory_CreateDearchiver(This, ...)                       CALL_IFACE_METHOD(EngineFactory, CreateDearchiver,                       This, __VA_ARGS__)
 #    define IEngineFactory_SetMessageCallback(This, ...)                     CALL_IFACE_METHOD(EngineFactory, SetMessageCallback,                     This, __VA_ARGS__)
 #    define IEngineFactory_SetBreakOnError(This, ...)                        CALL_IFACE_METHOD(EngineFactory, SetBreakOnError,                        This, __VA_ARGS__)
+#    define IEngineFactory_SetMemoryAllocator(This, ...)                     CALL_IFACE_METHOD(EngineFactory, SetMemoryAllocator,                     This, __VA_ARGS__)
 // clang-format on
 
 #endif

Graphics/GraphicsEngine/interface/GraphicsTypes.h

@@ -3517,10 +3517,6 @@ struct EngineCreateInfo
     /// Validation options, see Diligent::VALIDATION_FLAGS.
     VALIDATION_FLAGS    ValidationFlags             DEFAULT_INITIALIZER(VALIDATION_FLAG_NONE);
 
-    /// Pointer to the raw memory allocator that will be used for all memory allocation/deallocation
-    /// operations in the engine
-    struct IMemoryAllocator* pRawMemAllocator       DEFAULT_INITIALIZER(nullptr);
-
     /// An optional thread pool for asynchronous shader and pipeline state compilation.
     ///
     /// When AsyncShaderCompilation device feature is enabled, the engine will use

Graphics/GraphicsEngineD3D11/src/EngineFactoryD3D11.cpp

@@ -374,7 +374,6 @@ void EngineFactoryD3D11Impl::AttachToD3D11Device(void*                        pd
         const GraphicsAdapterInfo AdapterInfo = GetGraphicsAdapterInfo(pd3d11NativeDevice, pDXGIAdapter1);
         VerifyEngineCreateInfo(EngineCI, AdapterInfo);
 
-        SetRawAllocator(EngineCI.pRawMemAllocator);
         IMemoryAllocator& RawAllocator = GetRawAllocator();
 
         RenderDeviceD3D11Impl* pRenderDeviceD3D11{

Graphics/GraphicsEngineD3D12/src/EngineFactoryD3D12.cpp

@@ -309,7 +309,6 @@ void EngineFactoryD3D12Impl::CreateDeviceAndContextsD3D12(const EngineD3D12Creat
     try
     {
         ValidateD3D12CreateInfo(EngineCI);
-        SetRawAllocator(EngineCI.pRawMemAllocator);
 
         // Enable the D3D12 debug layer.
         if (EngineCI.EnableValidation)
@@ -601,7 +600,6 @@ void EngineFactoryD3D12Impl::AttachToD3D12Device(void*                        pd
 
     try
     {
-        SetRawAllocator(EngineCI.pRawMemAllocator);
         IMemoryAllocator&      RawMemAllocator = GetRawAllocator();
         ID3D12Device*          d3d12Device     = reinterpret_cast<ID3D12Device*>(pd3d12NativeDevice);
         CComPtr<IDXGIAdapter1> pDXGIAdapter1   = DXGIAdapterFromD3D12Device(d3d12Device);

Graphics/GraphicsEngineOpenGL/src/EngineFactoryOpenGL.cpp

@@ -235,7 +235,6 @@ void EngineFactoryOpenGLImpl::CreateDeviceAndSwapChainGL(const EngineGLCreateInf
         SetDefaultGraphicsAdapterInfo(AdapterInfo);
         VerifyEngineCreateInfo(EngineCI, AdapterInfo);
 
-        SetRawAllocator(EngineCI.pRawMemAllocator);
         IMemoryAllocator& RawMemAllocator = GetRawAllocator();
 
         SetPreferredAdapter(EngineCI);
@@ -334,7 +333,6 @@ void EngineFactoryOpenGLImpl::AttachToActiveGLContext(const EngineGLCreateInfo&
         SetDefaultGraphicsAdapterInfo(AdapterInfo);
         VerifyEngineCreateInfo(EngineCI, AdapterInfo);
 
-        SetRawAllocator(EngineCI.pRawMemAllocator);
         IMemoryAllocator& RawMemAllocator = GetRawAllocator();
 
         SetPreferredAdapter(EngineCI);

Graphics/GraphicsEngineVulkan/src/EngineFactoryVk.cpp

@@ -695,8 +695,6 @@ void EngineFactoryVkImpl::CreateDeviceAndContextsVk(const EngineVkCreateInfo& En
         return;
     }
 
-    SetRawAllocator(EngineCI.pRawMemAllocator);
-
     try
     {
         const Version GraphicsAPIVersion = EngineCI.GraphicsAPIVersion == Version{0, 0} ?