Unrestricted constant buffers

.github/workflows/TestCompilerSupport.yml

@@ -11,8 +11,8 @@ on:
       - "main"
 
 env:
-    MSVC_VERSION: 14.37
-    VS_VERSION: 17.7
+    MSVC_VERSION: 14.41
+    VS_VERSION: 17.11
 
 jobs:
   Test-Compiler-Support:

docs/STF/Bindings.md

@@ -10,7 +10,7 @@
 
 All code snippets for this section will be taken from ([Ex8_ConstantBuffers](../../examples/Ex8_ConstantBuffers))
 
-Shader Test Framework provides a simple way of specifying constant buffer bindings. i.e. bindings which are not buffers, samples or textures. `stf::ShaderTestFixture::RuntimeTestDesc` contains a member called `Bindings` which can be populated with a `std::vector` of pairs of `std::string`s and constant buffer data. Bindings must refer to global names. Meaning that you can't bind individual members of global parameters or constant buffers. You must provide all of the data to bind to a global name in the shader.
+Shader Test Framework provides a simple way of specifying constant buffer bindings. i.e. bindings which are not buffers, samplers or textures. `stf::ShaderTestFixture::RuntimeTestDesc` contains a member called `Bindings` which can be populated with a `std::vector` of pairs of `std::string`s and constant buffer data. Bindings must refer to global names. Meaning that you can't bind individual members of global parameters or constant buffers. You must provide all of the data to bind to a global name in the shader.
 
 Given the following HLSL test:
 

examples/Ex8_ConstantBuffers/ConstantBuffers.cpp

@@ -1,5 +1,7 @@
-#include <Framework/HLSLTypes.h>
+
 #include <Framework/ShaderTestFixture.h>
+#include <Utility/HLSLTypes.h>
+
 #include <catch2/catch_test_macros.hpp>
 
 SCENARIO("Example8Tests")

src/CMakeLists.txt

@@ -22,6 +22,7 @@ set_target_properties(WINPIX PROPERTIES
 asset_dependency_init(ShaderTestFramework)
 
 set(SOURCES
+    Public/Container/FreeList.h
     Public/Container/RingBuffer.h
     Public/D3D12/AgilityDefinitions.h
     Public/D3D12/BindlessFreeListAllocator.h
@@ -32,28 +33,31 @@ set(SOURCES
     Public/D3D12/Descriptor.h
     Public/D3D12/DescriptorFreeListAllocator.h
     Public/D3D12/DescriptorHeap.h
+    Public/D3D12/DescriptorManager.h
     Public/D3D12/DescriptorRingAllocator.h
     Public/D3D12/Fence.h
+    Public/D3D12/FencedResourceFreeList.h
+    Public/D3D12/FencedResourcePool.h
     Public/D3D12/GPUDevice.h
     Public/D3D12/GPUResource.h
+    Public/D3D12/GPUResourceManager.h
     Public/D3D12/Shader/CompiledShaderData.h
     Public/D3D12/Shader/IncludeHandler.h
     Public/D3D12/Shader/PipelineState.h
     Public/D3D12/Shader/RootSignature.h
+    Public/D3D12/Shader/Shader.h
     Public/D3D12/Shader/ShaderBinding.h
+    Public/D3D12/Shader/ShaderBindingMap.h
     Public/D3D12/Shader/ShaderCompiler.h
     Public/D3D12/Shader/ShaderEnums.h
     Public/D3D12/Shader/ShaderHash.h
     Public/D3D12/Shader/ShaderReflectionUtils.h
     Public/D3D12/Shader/VirtualShaderDirectoryMapping.h
     Public/D3D12/Shader/VirtualShaderDirectoryMappingManager.h
-    Public/Framework/HLSLTypes.h
     Public/Framework/PIXCapturer.h
     Public/Framework/ShaderTestCommon.h
-    Public/Framework/ShaderTestDescriptorManager.h
     Public/Framework/ShaderTestDriver.h
     Public/Framework/ShaderTestFixture.h
-    Public/Framework/ShaderTestShader.h
     Public/Framework/TestDataBufferLayout.h
     Public/Framework/TestDataBufferProcessor.h
     Public/Framework/TestDataBufferStructs.h
@@ -64,47 +68,53 @@ set(SOURCES
     Public/Utility/Algorithm.h
     Public/Utility/Concepts.h
     Public/Utility/EnumReflection.h
+    Public/Utility/Error.h
     Public/Utility/Exception.h
     Public/Utility/Expected.h
     Public/Utility/FixedString.h
     Public/Utility/Float.h
     Public/Utility/FunctionTraits.h
+    Public/Utility/HLSLTypes.h
     Public/Utility/Lambda.h
     Public/Utility/Math.h
     Public/Utility/MoveOnly.h
     Public/Utility/Object.h
     Public/Utility/OverloadSet.h
     Public/Utility/Pointer.h
+    Public/Utility/StringLiteral.h
     Public/Utility/Time.h
     Public/Utility/Tuple.h
     Public/Utility/Type.h
     Public/Utility/TypeList.h
     Public/Utility/TypeTraits.h
+    Public/Utility/VersionedIndex.h
     Private/D3D12/BindlessFreeListAllocator.cpp
     Private/D3D12/CommandAllocator.cpp
     Private/D3D12/CommandEngine.cpp
     Private/D3D12/CommandList.cpp
     Private/D3D12/CommandQueue.cpp
     Private/D3D12/DescriptorFreeListAllocator.cpp
     Private/D3D12/DescriptorHeap.cpp
+    Private/D3D12/DescriptorManager.cpp
     Private/D3D12/DescriptorRingAllocator.cpp
     Private/D3D12/Fence.cpp
     Private/D3D12/GPUDevice.cpp
     Private/D3D12/GPUResource.cpp
+    Private/D3D12/GPUResourceManager.cpp
     Private/D3D12/Shader/CompiledShaderData.cpp
     Private/D3D12/Shader/IncludeHandler.cpp
     Private/D3D12/Shader/PipelineState.cpp
     Private/D3D12/Shader/RootSignature.cpp
+    Private/D3D12/Shader/Shader.cpp
     Private/D3D12/Shader/ShaderBinding.cpp
+    Private/D3D12/Shader/ShaderBindingMap.cpp
     Private/D3D12/Shader/ShaderCompiler.cpp
     Private/D3D12/Shader/ShaderReflectionUtils.cpp
     Private/D3D12/Shader/VirtualShaderDirectoryMappingManager.cpp
     Private/Framework/PIXCapturer.cpp
     Private/Framework/ShaderTestCommon.cpp
-    Private/Framework/ShaderTestDescriptorManager.cpp
     Private/Framework/ShaderTestDriver.cpp
     Private/Framework/ShaderTestFixture.cpp
-    Private/Framework/ShaderTestShader.cpp
     Private/Framework/TestDataBufferLayout.cpp
     Private/Framework/TestDataBufferProcessor.cpp
     Private/Framework/TestDataBufferStructs.cpp

src/Private/D3D12/BindlessFreeListAllocator.cpp

@@ -5,6 +5,29 @@
 
 namespace stf
 {
+    namespace Errors::BindlessFreeListAllocator
+    {
+        ErrorFragment Empty()
+        {
+            return ErrorFragment::Make<"Bindless allocator is empty">();
+        }
+
+        ErrorFragment InvalidIndex(const u32 InIndex)
+        {
+            return ErrorFragment::Make<"Bindless index {} is invalid">(InIndex);
+        }
+
+        ErrorFragment IndexAlreadyReleased(const u32 InIndex)
+        {
+            return ErrorFragment::Make<"Bindless index {} has already been released">(InIndex);
+        }
+
+        ErrorFragment ShrinkAttempted(const u32 InCurrentSize, const u32 InRequestedSize)
+        {
+            return ErrorFragment::Make<"Attempted shrink which is unsupported. Current size: {}, Requested size: {}">(InCurrentSize, InRequestedSize);
+        }
+    }
+
     BindlessFreeListAllocator::BindlessFreeListAllocator(CreationParams InParams)
         : m_FreeList(InParams.NumDescriptors)
         , m_FreeSet(InParams.NumDescriptors, true)
@@ -13,7 +36,7 @@ namespace stf
         std::ranges::generate_n(std::back_inserter(m_FreeList), m_NumDescriptors, [index = 0]() mutable { return index++; });
     }
 
-    BindlessFreeListAllocator::Expected<BindlessFreeListAllocator::BindlessIndex> BindlessFreeListAllocator::Allocate()
+    ExpectedError<BindlessFreeListAllocator::BindlessIndex> BindlessFreeListAllocator::Allocate()
     {
         return m_FreeList.pop_front()
             .transform(
@@ -23,35 +46,24 @@ namespace stf
                     return BindlessIndex{ Private{}, InIndex };
                 })
             .transform_error(
-                [](const EBufferError InError)
+                [](const Error& InError) -> Error
                 {
-                    switch (InError)
-                    {
-                        case EBufferError::EmptyBuffer:
-                        {
-                            return EErrorType::EmptyError;
-                        }
-
-                        default:
-                        {
-                            return EErrorType::UnknownError;
-                        }
-                    }
+                    return InError + Errors::BindlessFreeListAllocator::Empty();
                 }
             );
     }
 
-    BindlessFreeListAllocator::Expected<void> BindlessFreeListAllocator::Release(const BindlessIndex InIndex)
+    ExpectedError<void> BindlessFreeListAllocator::Release(const BindlessIndex InIndex)
     {
         const u32 index = InIndex;
         if (index >= m_NumDescriptors)
         {
-            return Unexpected(EErrorType::InvalidIndex);
+            return Unexpected{ Error{Errors::BindlessFreeListAllocator::InvalidIndex(index) } };
         }
 
         if (m_FreeSet[index])
         {
-            return Unexpected(EErrorType::IndexAlreadyReleased);
+            return Unexpected{ Error{ Errors::BindlessFreeListAllocator::IndexAlreadyReleased(index) } };
         }
 
         m_FreeList.push_back(index);
@@ -60,11 +72,11 @@ namespace stf
         return {};
     }
 
-    BindlessFreeListAllocator::Expected<void> BindlessFreeListAllocator::Resize(const u32 InNewSize)
+    ExpectedError<void> BindlessFreeListAllocator::Resize(const u32 InNewSize)
     {
         if (InNewSize < m_NumDescriptors)
         {
-            return Unexpected(EErrorType::ShrinkAttempted);
+            return Unexpected{ Error{ Errors::BindlessFreeListAllocator::ShrinkAttempted(m_NumDescriptors, InNewSize) } };
         }
 
         if (InNewSize == m_NumDescriptors)
@@ -83,22 +95,6 @@ namespace stf
                     std::ranges::generate_n(std::back_inserter(m_FreeSet), numAdded, []() { return true; });
                     m_NumDescriptors = InNewSize;
                 }
-            ).transform_error(
-                [](const stf::RingBuffer<stf::u32>::EErrorType InError)
-                {
-                    using enum stf::RingBuffer<stf::u32>::EErrorType;
-                    switch (InError)
-                    {
-                        case AttemptedShrink:
-                        {
-                            return EErrorType::ShrinkAttempted;
-                        }
-                        default:
-                        {
-                            return EErrorType::UnknownError;
-                        }
-                    }
-                }
             );
     }
 
@@ -126,4 +122,15 @@ namespace stf
     {
         return m_Index;
     }
+
+    ExpectedError<bool> BindlessFreeListAllocator::IsAllocated(const BindlessIndex InIndex) const
+    {
+        const u32 index = InIndex;
+        if (index >= m_NumDescriptors)
+        {
+            return Unexpected{ Error{ Errors::BindlessFreeListAllocator::InvalidIndex(InIndex) } };
+        }
+
+        return !m_FreeSet[InIndex];
+    }
 }

src/Private/D3D12/CommandAllocator.cpp

@@ -4,8 +4,9 @@
 
 namespace stf
 {
-    CommandAllocator::CommandAllocator(CreationParams InParams)
-        : m_Allocator(std::move(InParams.Allocator))
+    CommandAllocator::CommandAllocator(ObjectToken InToken, CreationParams InParams)
+        : Object(InToken)
+        , m_Allocator(std::move(InParams.Allocator))
         , m_Type(InParams.Type)
     {
     }