Added support for user implementation of device memory interface

Author: azhirnov

Graphics/GraphicsEngine/interface/DeviceContext.h

@@ -1703,6 +1703,9 @@ struct SparseBufferMemoryBindRange
     ///                 all previous bindings are invalidated.
     ///     Vulkan & Direct3D12: different resource regions may be bound to different memory objects.
     ///     Vulkan: memory object must be compatible with the resource, use IDeviceMemory::IsCompatible() to ensure that.
+    ///
+    /// \note  Memory object can be created by the engine using IRenderDevice::CreateDeviceMemory() or can be implemented by the user.
+    ///        Memory object must implement interface methods for each backend (IDeviceMemoryD3D11, IDeviceMemoryD3D12, IDeviceMemoryVk).
     IDeviceMemory*   pMemory       DEFAULT_INITIALIZER(nullptr);
 
 #if DILIGENT_CPP_INTERFACE
@@ -1781,10 +1784,13 @@ struct SparseTextureMemoryBindRange
     /// \remarks
     ///     Direct3D11: the entire texture must use a single memory object; when a resource is bound to a new memory
     ///                 object, all previous bindings are invalidated.
-    ///     Vulkan & Direct3D12: different resource regions may be bound to different memory objects.    
+    ///     Vulkan & Direct3D12: different resource regions may be bound to different memory objects.
     ///     Metal: must be the same memory object that was used to create the sparse texture,
     ///            see IRenderDeviceMtl::CreateSparseTexture().
     ///     Vulkan: memory object must be compatible with the resource, use IDeviceMemory::IsCompatible() to ensure that.
+    ///
+    /// \note  Memory object can be created by the engine using IRenderDevice::CreateDeviceMemory() or can be implemented by the user.
+    ///        Memory object must implement interface methods for each backend (IDeviceMemoryD3D11, IDeviceMemoryD3D12, IDeviceMemoryVk).
     IDeviceMemory*   pMemory       DEFAULT_INITIALIZER(nullptr);
 };
 typedef struct SparseTextureMemoryBindRange SparseTextureMemoryBindRange;

Graphics/GraphicsEngineD3D12/include/DeviceMemoryD3D12Impl.hpp

@@ -61,7 +61,8 @@ class DeviceMemoryD3D12Impl final : public DeviceMemoryBase<EngineD3D12ImplTrait
     /// Implementation of IDeviceMemoryD3D12::GetRange().
     virtual DeviceMemoryRangeD3D12 DILIGENT_CALL_TYPE GetRange(Uint64 Offset, Uint64 Size) const override final;
 
-    bool IsUsingNVApi() const { return m_UseNVApi; }
+    /// Implementation of IDeviceMemoryD3D12::IsUsingNVApi().
+    virtual Bool DILIGENT_CALL_TYPE IsUsingNVApi() const override final { return m_UseNVApi; }
 
 private:
     D3D12_HEAP_FLAGS m_d3d12HeapFlags = D3D12_HEAP_FLAG_NONE;

Graphics/GraphicsEngineD3D12/interface/DeviceMemoryD3D12.h

@@ -70,14 +70,18 @@ DILIGENT_BEGIN_INTERFACE(IDeviceMemoryD3D12, IDeviceMemory)
     VIRTUAL DeviceMemoryRangeD3D12 METHOD(GetRange)(THIS_
                                                     Uint64 Offset,
                                                     Uint64 Size) CONST PURE;
+
+    /// Returns true if the heap was created using NVApi.
+    VIRTUAL Bool METHOD(IsUsingNVApi)(THIS) CONST PURE;
 };
 DILIGENT_END_INTERFACE
 
 #include "../../../Primitives/interface/UndefInterfaceHelperMacros.h"
 
 #if DILIGENT_C_INTERFACE
 
-#    define IDeviceMemoryD3D12_GetRange(This, ...) CALL_IFACE_METHOD(DeviceMemoryD3D12, GetRange, This, __VA_ARGS__)
+#    define IDeviceMemoryD3D12_GetRange(This, ...)  CALL_IFACE_METHOD(DeviceMemoryD3D12, GetRange,     This, __VA_ARGS__)
+#    define IDeviceMemoryD3D12_IsUsingNVApi(This)   CALL_IFACE_METHOD(DeviceMemoryD3D12, IsUsingNVApi, This)
 
 #endif
 

Graphics/GraphicsEngineD3D12/src/DeviceContextD3D12Impl.cpp

@@ -3044,9 +3044,11 @@ void DeviceContextD3D12Impl::BindSparseResourceMemory(const BindSparseResourceMe
         for (Uint32 r = 0; r < BuffBind.NumRanges; ++r)
         {
             const auto& BindRange = BuffBind.pRanges[r];
-            const auto* pMemD3D12 = ClassPtrCast<const DeviceMemoryD3D12Impl>(BindRange.pMemory);
-            const auto  MemRange  = pMemD3D12 ? pMemD3D12->GetRange(BindRange.MemoryOffset, BindRange.MemorySize) : DeviceMemoryRangeD3D12{};
+            const auto  pMemD3D12 = RefCntAutoPtr<IDeviceMemoryD3D12>{BindRange.pMemory, IID_DeviceMemoryD3D12};
+            DEV_CHECK_ERR((BindRange.pMemory != nullptr) == (pMemD3D12 != nullptr),
+                          "Failed to query IDeviceMemoryD3D12 interface from non-null memory object");
 
+            const auto MemRange = pMemD3D12 ? pMemD3D12->GetRange(BindRange.MemoryOffset, BindRange.MemorySize) : DeviceMemoryRangeD3D12{};
             DEV_CHECK_ERR((MemRange.Offset % D3D12_TILED_RESOURCE_TILE_SIZE_IN_BYTES) == 0,
                           "MemoryOffset must be a multiple of sparse block size");
 
@@ -3066,9 +3068,13 @@ void DeviceContextD3D12Impl::BindSparseResourceMemory(const BindSparseResourceMe
         for (Uint32 r = 0; r < TexBind.NumRanges; ++r)
         {
             const auto& BindRange = TexBind.pRanges[r];
-            const auto* pMemD3D12 = ClassPtrCast<const DeviceMemoryD3D12Impl>(BindRange.pMemory);
-            const auto  MemRange  = pMemD3D12 ? pMemD3D12->GetRange(BindRange.MemoryOffset, BindRange.MemorySize) : DeviceMemoryRangeD3D12{};
+            const auto  pMemD3D12 = RefCntAutoPtr<IDeviceMemoryD3D12>{BindRange.pMemory, IID_DeviceMemoryD3D12};
+            DEV_CHECK_ERR((BindRange.pMemory != nullptr) == (pMemD3D12 != nullptr),
+                          "Failed to query IDeviceMemoryD3D12 interface from non-null memory object");
 
+            const auto MemRange = pMemD3D12 ? pMemD3D12->GetRange(BindRange.MemoryOffset, BindRange.MemorySize) : DeviceMemoryRangeD3D12{};
+            DEV_CHECK_ERR((MemRange.Offset % D3D12_TILED_RESOURCE_TILE_SIZE_IN_BYTES) == 0,
+                          "MemoryOffset must be a multiple of sparse block size");
             VERIFY_EXPR(pMemD3D12 == nullptr || pMemD3D12->IsUsingNVApi() == UseNVApi);
 
             auto& DstMapping = TileMappingMap[TileMappingKey{pTexD3D12->GetD3D12Resource(), MemRange.pHandle}];

Graphics/GraphicsEngineVulkan/src/DeviceContextVkImpl.cpp

@@ -3800,10 +3800,12 @@ void DeviceContextVkImpl::BindSparseResourceMemory(const BindSparseResourceMemor
 
         for (Uint32 r = 0; r < BuffBind.NumRanges; ++r)
         {
-            const auto& SrcRange   = BuffBind.pRanges[r];
-            const auto* pMemVk     = ClassPtrCast<const DeviceMemoryVkImpl>(SrcRange.pMemory);
-            const auto  MemRangeVk = pMemVk ? pMemVk->GetRange(SrcRange.MemoryOffset, SrcRange.MemorySize) : DeviceMemoryRangeVk{};
+            const auto& SrcRange = BuffBind.pRanges[r];
+            const auto  pMemVk   = RefCntAutoPtr<IDeviceMemoryVk>{SrcRange.pMemory, IID_DeviceMemoryVk};
+            DEV_CHECK_ERR((SrcRange.pMemory != nullptr) == (pMemVk != nullptr),
+                          "Failed to query IDeviceMemoryVk interface from non-null memory object");
 
+            const auto MemRangeVk = pMemVk ? pMemVk->GetRange(SrcRange.MemoryOffset, SrcRange.MemorySize) : DeviceMemoryRangeVk{};
             DEV_CHECK_ERR(MemRangeVk.Offset % BuffSparseProps.BlockSize == 0,
                           "MemoryOffset must be multiple of the SparseBufferProperties::BlockSize");
 
@@ -3837,10 +3839,12 @@ void DeviceContextVkImpl::BindSparseResourceMemory(const BindSparseResourceMemor
         Uint32 NumImageBindsInRange = 0;
         for (Uint32 r = 0; r < TexBind.NumRanges; ++r)
         {
-            const auto& SrcRange   = TexBind.pRanges[r];
-            const auto* pMemVk     = ClassPtrCast<const DeviceMemoryVkImpl>(SrcRange.pMemory);
-            const auto  MemRangeVk = pMemVk ? pMemVk->GetRange(SrcRange.MemoryOffset, SrcRange.MemorySize) : DeviceMemoryRangeVk{};
+            const auto& SrcRange = TexBind.pRanges[r];
+            const auto  pMemVk   = RefCntAutoPtr<IDeviceMemoryVk>{SrcRange.pMemory, IID_DeviceMemoryVk};
+            DEV_CHECK_ERR((SrcRange.pMemory != nullptr) == (pMemVk != nullptr),
+                          "Failed to query IDeviceMemoryVk interface from non-null memory object");
 
+            const auto MemRangeVk = pMemVk ? pMemVk->GetRange(SrcRange.MemoryOffset, SrcRange.MemorySize) : DeviceMemoryRangeVk{};
             DEV_CHECK_ERR((MemRangeVk.Offset % TexSparseProps.BlockSize) == 0,
                           "MemoryOffset must be a multiple of the SparseTextureProperties::BlockSize");
 

Tests/DiligentCoreAPITest/src/SparseResourcesTest.cpp

@@ -1906,8 +1906,10 @@ TEST_F(SparseResourceTest, SparseTexture3D)
     {
         GTEST_SKIP() << "Sparse texture 3D is not supported by this device";
     }
-    if (pDevice->GetDeviceInfo().IsMetalDevice())
-        GTEST_SKIP() << "UAV sparse texture is not supported in Metal"; // AZ TODO: query texture bind flags
+    if ((pDevice->GetSparseTextureFormatInfo(TEX_FORMAT_RGBA8_UNORM, RESOURCE_DIM_TEX_3D, 1).BindFlags & BIND_UNORDERED_ACCESS) != 0)
+    {
+        GTEST_SKIP() << "Sparse texture UAV is not supported by this device";
+    }
 
     TestingEnvironment::ScopedReset EnvironmentAutoReset;