Renamed static sampler to immutable sampler (API240076)

4 files changed, 52 insertions, 51 deletions

diff --git a/Graphics/GraphicsEngineD3D11/include/PipelineStateD3D11Impl.hpp b/Graphics/GraphicsEngineD3D11/include/PipelineStateD3D11Impl.hpp
index eb184710..0fa62606 100644
--- a/Graphics/GraphicsEngineD3D11/include/PipelineStateD3D11Impl.hpp
+++ b/Graphics/GraphicsEngineD3D11/include/PipelineStateD3D11Impl.hpp
@@ -134,7 +134,7 @@ public:
     const ShaderD3D11Impl* GetShaderByType(SHADER_TYPE ShaderType) const;
     const ShaderD3D11Impl* GetShader(Uint32 Index) const;
 
-    void SetStaticSamplers(ShaderResourceCacheD3D11& ResourceCache, Uint32 ShaderInd) const;
+    void SetImmutableSamplers(ShaderResourceCacheD3D11& ResourceCache, Uint32 ShaderInd) const;
 
 private:
     template <typename PSOCreateInfoType>
@@ -166,20 +166,20 @@ private:
     // indexed by the shader type pipeline index (returned by GetShaderTypePipelineIndex)
     std::array<Int8, MAX_SHADERS_IN_PIPELINE> m_ResourceLayoutIndex = {-1, -1, -1, -1, -1};
 
-    std::array<Uint16, MAX_SHADERS_IN_PIPELINE + 1> m_StaticSamplerOffsets = {};
-    struct StaticSamplerInfo
+    std::array<Uint16, MAX_SHADERS_IN_PIPELINE + 1> m_ImmutableSamplerOffsets = {};
+    struct ImmutableSamplerInfo
     {
         const D3DShaderResourceAttribs& Attribs;
         RefCntAutoPtr<ISampler>         pSampler;
-        StaticSamplerInfo(const D3DShaderResourceAttribs& _Attribs,
-                          RefCntAutoPtr<ISampler>         _pSampler) :
+        ImmutableSamplerInfo(const D3DShaderResourceAttribs& _Attribs,
+                             RefCntAutoPtr<ISampler>         _pSampler) :
             // clang-format off
             Attribs  {_Attribs},
             pSampler {std::move(_pSampler)}
         // clang-format on
         {}
     };
-    std::vector<StaticSamplerInfo, STDAllocatorRawMem<StaticSamplerInfo>> m_StaticSamplers;
+    std::vector<ImmutableSamplerInfo, STDAllocatorRawMem<ImmutableSamplerInfo>> m_ImmutableSamplers;
 };
 
 } // namespace Diligent
diff --git a/Graphics/GraphicsEngineD3D11/src/PipelineStateD3D11Impl.cpp b/Graphics/GraphicsEngineD3D11/src/PipelineStateD3D11Impl.cpp
index 292a9323..722318f2 100644
--- a/Graphics/GraphicsEngineD3D11/src/PipelineStateD3D11Impl.cpp
+++ b/Graphics/GraphicsEngineD3D11/src/PipelineStateD3D11Impl.cpp
@@ -74,7 +74,7 @@ PipelineStateD3D11Impl::PipelineStateD3D11Impl(IReferenceCounters*
         CreateInfo
     },
     m_SRBMemAllocator{GetRawAllocator()},
-    m_StaticSamplers (STD_ALLOCATOR_RAW_MEM(StaticSamplerInfo, GetRawAllocator(), "Allocator for vector<StaticSamplerInfo>"))
+    m_ImmutableSamplers (STD_ALLOCATOR_RAW_MEM(ImmutableSamplerInfo, GetRawAllocator(), "Allocator for vector<ImmutableSamplerInfo>"))
 // clang-format on
 {
     auto MemPool = InitInternalObjects(CreateInfo);
@@ -153,7 +153,7 @@ PipelineStateD3D11Impl::PipelineStateD3D11Impl(IReferenceCounters*
         CreateInfo
     },
     m_SRBMemAllocator{GetRawAllocator()},
-    m_StaticSamplers (STD_ALLOCATOR_RAW_MEM(StaticSamplerInfo, GetRawAllocator(), "Allocator for vector<StaticSamplerInfo>"))
+    m_ImmutableSamplers(STD_ALLOCATOR_RAW_MEM(ImmutableSamplerInfo, GetRawAllocator(), "Allocator for vector<ImmutableSamplerInfo>"))
 // clang-format on
 {
     auto MemPool = InitInternalObjects(CreateInfo);
@@ -209,11 +209,11 @@ void PipelineStateD3D11Impl::InitResourceLayouts(const PipelineStateCreateInfo&
         }
         ShaderResources::DvpVerifyResourceLayout(ResourceLayout, pResources, GetNumShaderStages(),
                                                  (CreateInfo.Flags & PSO_CREATE_FLAG_IGNORE_MISSING_VARIABLES) == 0,
-                                                 (CreateInfo.Flags & PSO_CREATE_FLAG_IGNORE_MISSING_STATIC_SAMPLERS) == 0);
+                                                 (CreateInfo.Flags & PSO_CREATE_FLAG_IGNORE_MISSING_IMMUTABLE_SAMPLERS) == 0);
     }
 #endif
 
-    decltype(m_StaticSamplers)                  StaticSamplers(STD_ALLOCATOR_RAW_MEM(StaticSamplerInfo, GetRawAllocator(), "Allocator for vector<StaticSamplerInfo>"));
+    decltype(m_ImmutableSamplers)               ImmutableSamplers(STD_ALLOCATOR_RAW_MEM(ImmutableSamplerInfo, GetRawAllocator(), "Allocator for vector<ImmutableSamplerInfo>"));
     std::array<size_t, MAX_SHADERS_IN_PIPELINE> ShaderResLayoutDataSizes = {};
     std::array<size_t, MAX_SHADERS_IN_PIPELINE> ShaderResCacheDataSizes  = {};
     for (Uint32 s = 0; s < ShaderStages.size(); ++s)
@@ -243,21 +243,22 @@ void PipelineStateD3D11Impl::InitResourceLayouts(const PipelineStateCreateInfo&
             };
         // clang-format on
 
-        // Initialize static samplers
+        // Initialize immutable samplers
         for (Uint32 sam = 0; sam < ShaderResources.GetNumSamplers(); ++sam)
         {
-            const auto&    SamplerAttribs             = ShaderResources.GetSampler(sam);
-            constexpr bool LogStaticSamplerArrayError = true;
-            auto           SrcStaticSamplerInd        = ShaderResources.FindStaticSampler(SamplerAttribs, ResourceLayout, LogStaticSamplerArrayError);
-            if (SrcStaticSamplerInd >= 0)
+            const auto&    SamplerAttribs            = ShaderResources.GetSampler(sam);
+            constexpr bool LogImtblSamplerArrayError = true;
+            auto           SrcImtblSamplerInd        = ShaderResources.FindImmutableSampler(SamplerAttribs, ResourceLayout, LogImtblSamplerArrayError);
+            if (SrcImtblSamplerInd >= 0)
             {
-                const auto&             SrcStaticSamplerInfo = ResourceLayout.StaticSamplers[SrcStaticSamplerInd];
-                RefCntAutoPtr<ISampler> pStaticSampler;
-                GetDevice()->CreateSampler(SrcStaticSamplerInfo.Desc, &pStaticSampler);
-                StaticSamplers.emplace_back(SamplerAttribs, std::move(pStaticSampler));
+                const auto& SrcImtblSamplerInfo = ResourceLayout.ImmutableSamplers[SrcImtblSamplerInd];
+
+                RefCntAutoPtr<ISampler> pImbtlSampler;
+                GetDevice()->CreateSampler(SrcImtblSamplerInfo.Desc, &pImbtlSampler);
+                ImmutableSamplers.emplace_back(SamplerAttribs, std::move(pImbtlSampler));
             }
         }
-        m_StaticSamplerOffsets[s + 1] = static_cast<Uint16>(StaticSamplers.size());
+        m_ImmutableSamplerOffsets[s + 1] = static_cast<Uint16>(ImmutableSamplers.size());
 
         if (m_Desc.SRBAllocationGranularity > 1)
         {
@@ -279,14 +280,14 @@ void PipelineStateD3D11Impl::InitResourceLayouts(const PipelineStateCreateInfo&
         m_SRBMemAllocator.Initialize(m_Desc.SRBAllocationGranularity, GetNumShaderStages(), ShaderResLayoutDataSizes.data(), GetNumShaderStages(), ShaderResCacheDataSizes.data());
     }
 
-    m_StaticSamplers.reserve(StaticSamplers.size());
-    for (auto& Sam : StaticSamplers)
-        m_StaticSamplers.emplace_back(std::move(Sam));
+    m_ImmutableSamplers.reserve(ImmutableSamplers.size());
+    for (auto& ImtblSam : ImmutableSamplers)
+        m_ImmutableSamplers.emplace_back(std::move(ImtblSam));
 
     for (Uint32 s = 0; s < GetNumShaderStages(); ++s)
     {
-        // Initialize static samplers in the static resource cache to avoid warning messages
-        SetStaticSamplers(m_pStaticResourceCaches[s], s);
+        // Initialize immutable samplers in the static resource cache to avoid warning messages
+        SetImmutableSamplers(m_pStaticResourceCaches[s], s);
     }
 }
 
@@ -431,15 +432,15 @@ IShaderResourceVariable* PipelineStateD3D11Impl::GetStaticVariableByIndex(SHADER
     return m_pStaticResourceLayouts[LayoutInd].GetShaderVariable(Index);
 }
 
-void PipelineStateD3D11Impl::SetStaticSamplers(ShaderResourceCacheD3D11& ResourceCache, Uint32 ShaderInd) const
+void PipelineStateD3D11Impl::SetImmutableSamplers(ShaderResourceCacheD3D11& ResourceCache, Uint32 ShaderInd) const
 {
     auto NumCachedSamplers = ResourceCache.GetSamplerCount();
-    for (Uint32 s = m_StaticSamplerOffsets[ShaderInd]; s < m_StaticSamplerOffsets[ShaderInd + 1]; ++s)
+    for (Uint32 s = m_ImmutableSamplerOffsets[ShaderInd]; s < m_ImmutableSamplerOffsets[ShaderInd + 1]; ++s)
     {
-        auto&       SamplerInfo       = m_StaticSamplers[s];
+        auto&       SamplerInfo       = m_ImmutableSamplers[s];
         const auto& SamAttribs        = SamplerInfo.Attribs;
         auto*       pSamplerD3D11Impl = SamplerInfo.pSampler.RawPtr<SamplerD3D11Impl>();
-        // Limiting EndBindPoint is required when initializing static samplers in a Shader's static cache
+        // Limiting EndBindPoint is required when initializing immutable samplers in a Shader's static cache
         auto EndBindPoint = std::min(static_cast<Uint32>(SamAttribs.BindPoint) + SamAttribs.BindCount, NumCachedSamplers);
         for (Uint32 BindPoint = SamAttribs.BindPoint; BindPoint < EndBindPoint; ++BindPoint)
             ResourceCache.SetSampler(BindPoint, pSamplerD3D11Impl);
diff --git a/Graphics/GraphicsEngineD3D11/src/ShaderResourceBindingD3D11Impl.cpp b/Graphics/GraphicsEngineD3D11/src/ShaderResourceBindingD3D11Impl.cpp
index 88c7b77f..5e95db97 100644
--- a/Graphics/GraphicsEngineD3D11/src/ShaderResourceBindingD3D11Impl.cpp
+++ b/Graphics/GraphicsEngineD3D11/src/ShaderResourceBindingD3D11Impl.cpp
@@ -177,7 +177,7 @@ void ShaderResourceBindingD3D11Impl::InitializeStaticResources(const IPipelineSt
         }
 #endif
         StaticResLayout.CopyResources(m_pBoundResourceCaches[shader]);
-        pPSOD3D11->SetStaticSamplers(m_pBoundResourceCaches[shader], shader);
+        pPSOD3D11->SetImmutableSamplers(m_pBoundResourceCaches[shader], shader);
     }
 
     m_bIsStaticResourcesBound = true;
diff --git a/Graphics/GraphicsEngineD3D11/src/ShaderResourceLayoutD3D11.cpp b/Graphics/GraphicsEngineD3D11/src/ShaderResourceLayoutD3D11.cpp
index 723e190a..c1e6e65a 100755
--- a/Graphics/GraphicsEngineD3D11/src/ShaderResourceLayoutD3D11.cpp
+++ b/Graphics/GraphicsEngineD3D11/src/ShaderResourceLayoutD3D11.cpp
@@ -86,9 +86,9 @@ size_t ShaderResourceLayoutD3D11::GetRequiredMemorySize(const ShaderResourcesD3D
                                                         const SHADER_RESOURCE_VARIABLE_TYPE* AllowedVarTypes,

                                                         Uint32                               NumAllowedTypes)

 {

-    // Skip static samplers as they are initialized directly in the resource cache by the PSO

-    constexpr bool CountStaticSamplers = false;

-    auto           ResCounters         = SrcResources.CountResources(ResourceLayout, AllowedVarTypes, NumAllowedTypes, CountStaticSamplers);

+    // Skip immutable samplers as they are initialized directly in the resource cache by the PSO

+    constexpr bool CountImtblSamplers = false;

+    auto           ResCounters        = SrcResources.CountResources(ResourceLayout, AllowedVarTypes, NumAllowedTypes, CountImtblSamplers);

     // clang-format off

     auto MemSize = ResCounters.NumCBs      * sizeof(ConstBuffBindInfo) +

                    ResCounters.NumTexSRVs  * sizeof(TexSRVBindInfo)    +

@@ -120,9 +120,9 @@ ShaderResourceLayoutD3D11::ShaderResourceLayoutD3D11(IObject&
     const auto AllowedTypeBits = GetAllowedTypeBits(VarTypes, NumVarTypes);

 

     // Count total number of resources of allowed types

-    // Skip static samplers as they are initialized directly in the resource cache by the PSO

-    constexpr bool CountStaticSamplers = false;

-    auto           ResCounters         = m_pResources->CountResources(ResourceLayout, VarTypes, NumVarTypes, CountStaticSamplers);

+    // Skip immutable samplers as they are initialized directly in the resource cache by the PSO

+    constexpr bool CountImtblSamplers = false;

+    auto           ResCounters        = m_pResources->CountResources(ResourceLayout, VarTypes, NumVarTypes, CountImtblSamplers);

 

     // Initialize offsets

     size_t CurrentOffset = 0;

@@ -192,12 +192,12 @@ ShaderResourceLayoutD3D11::ShaderResourceLayoutD3D11(IObject&
             auto VarType = m_pResources->FindVariableType(Sampler, ResourceLayout);

             if (IsAllowedType(VarType, AllowedTypeBits))

             {

-                // Constructor of PipelineStateD3D11Impl initializes static samplers and will log the error, if any

-                constexpr bool LogStaticSamplerArrayError = false;

-                auto           StaticSamplerInd           = m_pResources->FindStaticSampler(Sampler, ResourceLayout, LogStaticSamplerArrayError);

-                if (StaticSamplerInd >= 0)

+                // Constructor of PipelineStateD3D11Impl initializes immutable samplers and will log the error, if any

+                constexpr bool LogImtblSamplerArrayError = false;

+                auto           ImtblSamplerInd           = m_pResources->FindImmutableSampler(Sampler, ResourceLayout, LogImtblSamplerArrayError);

+                if (ImtblSamplerInd >= 0)

                 {

-                    // Skip static samplers as they are initialized directly in the resource cache by the PSO

+                    // Skip immutble samplers as they are initialized directly in the resource cache by the PSO

                     return;

                 }

                 // Initialize current sampler in place, increment sampler counter

@@ -241,10 +241,10 @@ ShaderResourceLayoutD3D11::ShaderResourceLayoutD3D11(IObject&
                     AssignedSamplerIndex = TexSRVBindInfo::InvalidSamplerIndex;

 #ifdef DILIGENT_DEBUG

                     // Shader error will be logged by the PipelineStateD3D11Impl

-                    constexpr bool LogStaticSamplerArrayError = false;

-                    if (m_pResources->FindStaticSampler(AssignedSamplerAttribs, ResourceLayout, LogStaticSamplerArrayError) < 0)

+                    constexpr bool LogImtblSamplerArrayError = false;

+                    if (m_pResources->FindImmutableSampler(AssignedSamplerAttribs, ResourceLayout, LogImtblSamplerArrayError) < 0)

                     {

-                        UNEXPECTED("Unable to find non-static sampler assigned to texture SRV '", TexSRV.Name, "'.");

+                        UNEXPECTED("Unable to find non-immutable sampler assigned to texture SRV '", TexSRV.Name, "'.");

                     }

 #endif

                 }

@@ -252,10 +252,10 @@ ShaderResourceLayoutD3D11::ShaderResourceLayoutD3D11(IObject&
                 {

 #ifdef DILIGENT_DEBUG

                     // Shader error will be logged by the PipelineStateD3D11Impl

-                    constexpr bool LogStaticSamplerArrayError = false;

-                    if (m_pResources->FindStaticSampler(AssignedSamplerAttribs, ResourceLayout, LogStaticSamplerArrayError) >= 0)

+                    constexpr bool LogImtblSamplerArrayError = false;

+                    if (m_pResources->FindImmutableSampler(AssignedSamplerAttribs, ResourceLayout, LogImtblSamplerArrayError) >= 0)

                     {

-                        UNEXPECTED("Static sampler '", AssignedSamplerAttribs.Name, "' is assigned to texture SRV '", TexSRV.Name, "'.");

+                        UNEXPECTED("Immutable sampler '", AssignedSamplerAttribs.Name, "' is assigned to texture SRV '", TexSRV.Name, "'.");

                     }

 #endif

                 }

@@ -412,7 +412,7 @@ void ShaderResourceLayoutD3D11::CopyResources(ShaderResourceCacheD3D11& DstCache
 

         [&](const SamplerBindInfo& sam) //

         {

-            //VERIFY(!sam.IsStaticSampler, "Variables are not created for static samplers");

+            //VERIFY(!sam.IsImmutableSampler, "Variables are not created for immutable samplers");

             for (auto SamSlot = sam.m_Attribs.BindPoint; SamSlot < sam.m_Attribs.BindPoint + sam.m_Attribs.BindCount; ++SamSlot)

             {

                 VERIFY_EXPR(SamSlot < m_ResourceCache.GetSamplerCount() && SamSlot < DstCache.GetSamplerCount());

@@ -460,7 +460,7 @@ void ShaderResourceLayoutD3D11::TexSRVBindInfo::BindResource(IDeviceObject* pVie
     if (ValidSamplerAssigned())

     {

         auto& Sampler = m_ParentResLayout.GetResource<SamplerBindInfo>(SamplerIndex);

-        //VERIFY(!Sampler.IsStaticSampler, "Static samplers are not assigned to texture SRVs as they are initialized directly in the shader resource cache");

+        //VERIFY(!Sampler.IsImmutableSampler, "Immutable samplers are not assigned to texture SRVs as they are initialized directly in the shader resource cache");

         VERIFY_EXPR(Sampler.m_Attribs.BindCount == m_Attribs.BindCount || Sampler.m_Attribs.BindCount == 1);

         auto SamplerBindPoint = Sampler.m_Attribs.BindPoint + (Sampler.m_Attribs.BindCount != 1 ? ArrayIndex : 0);

 

@@ -502,7 +502,7 @@ void ShaderResourceLayoutD3D11::SamplerBindInfo::BindResource(IDeviceObject* pSa
                   "Array index (", ArrayIndex, ") is out of range for variable '", m_Attribs.Name,

                   "'. Max allowed index: ", m_Attribs.BindCount - 1);

     auto& ResourceCache = m_ParentResLayout.m_ResourceCache;

-    //VERIFY(!IsStaticSampler, "Cannot bind sampler to a static sampler");

+    //VERIFY(!IsImmutableSampler, "Cannot bind sampler to an immutable sampler");

 

     // We cannot use ValidatedCast<> here as the resource retrieved from the

     // resource mapping can be of wrong type

@@ -737,7 +737,7 @@ IShaderResourceVariable* ShaderResourceLayoutD3D11::GetShaderVariable(const Char
 

     if (!m_pResources->IsUsingCombinedTextureSamplers())

     {

-        // Static samplers are never created in the resource layout

+        // Immutable samplers are never created in the resource layout

         if (auto* pSampler = GetResourceByName<SamplerBindInfo>(Name))

             return pSampler;

     }