Render state cache: fixed resource arrays in WebGPU

Author: TheMostDiligent

Graphics/GraphicsEngineWebGPU/include/ShaderWebGPUImpl.hpp

@@ -75,9 +75,15 @@ class ShaderWebGPUImpl final : public ShaderBase<EngineWebGPUImplTraits>
     /// Implementation of IShader::GetBytecode() in WebGPU backend.
     void DILIGENT_CALL_TYPE GetBytecode(const void** ppBytecode, Uint64& Size) const override final;
 
-    /// Implementation of IShaderWebGPU::GetWGSL() in WebGPU backend.
+    /// Implementation of IShaderWebGPU::GetWGSL().
     const std::string& DILIGENT_CALL_TYPE GetWGSL() const override final;
 
+    /// Implementation of IShaderWebGPU::GetEmulatedArrayIndexSuffix().
+    const char* DILIGENT_CALL_TYPE GetEmulatedArrayIndexSuffix() const override final
+    {
+        return m_pShaderResources->GetEmulatedArrayIndexSuffix();
+    }
+
     const char* GetEntryPoint() const;
 
     const std::shared_ptr<const WGSLShaderResources>& GetShaderResources() const
@@ -86,11 +92,6 @@ class ShaderWebGPUImpl final : public ShaderBase<EngineWebGPUImplTraits>
         return m_pShaderResources;
     }
 
-    const char* GetEmulatedArrayIndexSuffix() const
-    {
-        return m_pShaderResources->GetEmulatedArrayIndexSuffix();
-    }
-
 private:
     void Initialize(const ShaderCreateInfo& ShaderCI,
                     const CreateInfo&       WebGPUShaderCI) noexcept(false);

Graphics/GraphicsEngineWebGPU/interface/ShaderWebGPU.h

@@ -54,6 +54,13 @@ class IShaderWebGPU : public IShader
 public:
     /// Returns WGSL source code
     virtual const std::string& DILIGENT_CALL_TYPE GetWGSL() const = 0;
+
+    /// Returns a suffix to append to the name of emulated array variables to get
+    /// the indexed array element name.
+    ///
+    /// \remarks    This value is defined by ShaderCI.WebGPUEmulatedArrayIndexSuffix,
+    ///             see Diligent::ShaderCreateInfo::WebGPUEmulatedArrayIndexSuffix.
+    virtual const char* DILIGENT_CALL_TYPE GetEmulatedArrayIndexSuffix() const = 0;
 };
 
 #endif

Graphics/GraphicsTools/CMakeLists.txt

@@ -37,6 +37,11 @@ set(SOURCE
     src/DynamicTextureArray.cpp
     src/DynamicTextureAtlas.cpp
     src/GraphicsUtilities.cpp
+    src/GraphicsUtilitiesD3D11.cpp
+    src/GraphicsUtilitiesD3D12.cpp
+    src/GraphicsUtilitiesGL.cpp
+    src/GraphicsUtilitiesVk.cpp
+    src/GraphicsUtilitiesWebGPU.cpp
     src/OffScreenSwapChain.cpp
     src/ScopedQueryHelper.cpp
     src/ScreenCapture.cpp
@@ -73,18 +78,16 @@ endif()
 set(DEPENDENCIES)
 
 if(D3D11_SUPPORTED)
-    list(APPEND SOURCE src/TextureUploaderD3D11.cpp src/GraphicsUtilitiesD3D11.cpp)
+    list(APPEND SOURCE src/TextureUploaderD3D11.cpp)
     list(APPEND INTERFACE interface/TextureUploaderD3D11.hpp)
     list(APPEND DEPENDENCIES Diligent-GraphicsEngineD3D11Interface)
 endif()
 
 if(D3D12_SUPPORTED)
-    list(APPEND SOURCE src/GraphicsUtilitiesD3D12.cpp)
     list(APPEND DEPENDENCIES Diligent-GraphicsEngineD3D12Interface)
 endif()
 
 if(VULKAN_SUPPORTED)
-    list(APPEND SOURCE src/GraphicsUtilitiesVk.cpp)
     list(APPEND DEPENDENCIES Diligent-GraphicsEngineVkInterface Vulkan::Headers)
 endif()
 
@@ -94,7 +97,7 @@ if(D3D12_SUPPORTED OR VULKAN_SUPPORTED)
 endif()
 
 if(GL_SUPPORTED OR GLES_SUPPORTED)
-    list(APPEND SOURCE src/TextureUploaderGL.cpp src/GraphicsUtilitiesGL.cpp)
+    list(APPEND SOURCE src/TextureUploaderGL.cpp)
     list(APPEND INTERFACE interface/TextureUploaderGL.hpp)
     list(APPEND DEPENDENCIES Diligent-GraphicsEngineOpenGLInterface)
 endif()

Graphics/GraphicsTools/interface/GraphicsUtilities.h

@@ -206,6 +206,13 @@ IBufferView* DILIGENT_GLOBAL_FUNCTION(GetBufferDefaultSRV)(IObject* pBuffer);
 /// If the buffer is null, returns null.
 IBufferView* DILIGENT_GLOBAL_FUNCTION(GetBufferDefaultUAV)(IObject* pBuffer);
 
+
+/// For WebGPU shaders, returns the suffix to append to the name of emulated array variables to get
+/// the indexed array element name.
+/// For other shader types, returns null.
+const char* DILIGENT_GLOBAL_FUNCTION(GetWebGPUEmulatedArrayIndexSuffix)(IShader* pShader);
+
+
 #include "../../../Primitives/interface/UndefRefMacro.h"
 
 DILIGENT_END_NAMESPACE // namespace Diligent

Graphics/GraphicsTools/src/GraphicsUtilities.cpp

@@ -611,4 +611,9 @@ extern "C"
     {
         return Diligent::GetBufferDefaultUAV(pBuffer);
     }
+
+    const char* Diligent_GetWebGPUEmulatedArrayIndexSuffix(Diligent::IShader* pShader)
+    {
+        return Diligent::GetWebGPUEmulatedArrayIndexSuffix(pShader);
+    }
 }

Graphics/GraphicsTools/src/GraphicsUtilitiesWebGPU.cpp

@@ -0,0 +1,49 @@
+/*
+ *  Copyright 2024 Diligent Graphics LLC
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *  In no event and under no legal theory, whether in tort (including negligence),
+ *  contract, or otherwise, unless required by applicable law (such as deliberate
+ *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
+ *  liable for any damages, including any direct, indirect, special, incidental,
+ *  or consequential damages of any character arising as a result of this License or
+ *  out of the use or inability to use the software (including but not limited to damages
+ *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and
+ *  all other commercial damages or losses), even if such Contributor has been advised
+ *  of the possibility of such damages.
+ */
+
+#include "GraphicsUtilities.h"
+
+#if WEBGPU_SUPPORTED
+#    include "ShaderWebGPU.h"
+#endif
+
+#include "RefCntAutoPtr.hpp"
+
+namespace Diligent
+{
+
+const char* GetWebGPUEmulatedArrayIndexSuffix(IShader* pShader)
+{
+#if WEBGPU_SUPPORTED
+    if (RefCntAutoPtr<IShaderWebGPU> pShaderWGPU{pShader, IID_ShaderWebGPU})
+    {
+        return pShaderWGPU->GetEmulatedArrayIndexSuffix();
+    }
+#endif
+    return nullptr;
+}
+
+} // namespace Diligent

Graphics/GraphicsTools/src/RenderStateCacheImpl.cpp

@@ -47,6 +47,7 @@
 #include "SerializedShader.h"
 #include "CallbackWrapper.hpp"
 #include "GraphicsAccessories.hpp"
+#include "GraphicsUtilities.h"
 #include "ShaderSourceFactoryUtils.hpp"
 
 namespace Diligent
@@ -560,9 +561,10 @@ struct RenderStateCacheImpl::SerializedPsoCIWrapperBase
             }
             else if (DeviceType == RENDER_DEVICE_TYPE_WEBGPU)
             {
-                ShaderCI.Source         = static_cast<const char*>(ShaderCI.ByteCode);
-                ShaderCI.ByteCode       = nullptr;
-                ShaderCI.SourceLanguage = SHADER_SOURCE_LANGUAGE_WGSL;
+                ShaderCI.Source                         = static_cast<const char*>(ShaderCI.ByteCode);
+                ShaderCI.ByteCode                       = nullptr;
+                ShaderCI.SourceLanguage                 = SHADER_SOURCE_LANGUAGE_WGSL;
+                ShaderCI.WebGPUEmulatedArrayIndexSuffix = GetWebGPUEmulatedArrayIndexSuffix(pShader);
             }
             ShaderArchiveInfo ArchiveInfo;
             ArchiveInfo.DeviceFlags = RenderDeviceTypeToArchiveDataFlag(DeviceType);

Tests/DiligentCoreAPITest/assets/shaders/RenderStateCache/PixelShader.psh

@@ -1,11 +1,24 @@
 #include "GraphicsCommon.h"
 
-Texture2D    g_Tex2D;
+#ifdef WEBGPU
+    Texture2D g_Tex2D_0;
+    Texture2D g_Tex2D_1;
+#else
+    Texture2D g_Tex2D[2];
+#endif
 SamplerState g_Tex2D_sampler;
 
 float4 main(in PSInput PSIn) : SV_Target
 {
     float2 UV = float2(0.5, 0.5);
-    return float4(PSIn.Color.rgb, 1.0) * g_Tex2D.Sample(g_Tex2D_sampler, UV.xy);
+    float4 Color = float4(PSIn.Color.rgb, 1.0);
+#ifdef WEBGPU
+    Color *= g_Tex2D_0.Sample(g_Tex2D_sampler, UV.xy);
+    Color *= g_Tex2D_1.Sample(g_Tex2D_sampler, UV.xy);
+#else
+    Color *= g_Tex2D[0].Sample(g_Tex2D_sampler, UV.xy);
+    Color *= g_Tex2D[1].Sample(g_Tex2D_sampler, UV.xy);
+#endif
+    return Color;
     // NB: no new line at the end of file!
 }

Tests/DiligentCoreAPITest/assets/shaders/RenderStateCache/PixelShader2.psh

@@ -1,10 +1,23 @@
 #include "GraphicsCommon.h"
 
-Texture2D    g_Tex2D;
+#ifdef WEBGPU
+    Texture2D g_Tex2D_0;
+    Texture2D g_Tex2D_1;
+#else
+    Texture2D g_Tex2D[2];
+#endif
 SamplerState g_Tex2D_sampler;
 
 float4 main(in PSInput PSIn) : SV_Target
 {
     float2 UV = float2(0.5, 0.5);
-    return float4(PSIn.Color.bgr, 1.0) * g_Tex2D.Sample(g_Tex2D_sampler, UV.xy);
+    float4 Color = float4(PSIn.Color.bgr, 1.0);
+#ifdef WEBGPU
+    Color *= g_Tex2D_0.Sample(g_Tex2D_sampler, UV.xy);
+    Color *= g_Tex2D_1.Sample(g_Tex2D_sampler, UV.xy);
+#else
+    Color *= g_Tex2D[0].Sample(g_Tex2D_sampler, UV.xy);
+    Color *= g_Tex2D[1].Sample(g_Tex2D_sampler, UV.xy);
+#endif
+    return Color;
 }

Tests/DiligentCoreAPITest/assets/shaders/RenderStateCache/PixelShaderRld.psh

@@ -7,7 +7,12 @@ cbuffer Colors
 
 Texture2D g_Tex2D_Static0;
 Texture2D g_Tex2D_Static1;
-Texture2D g_Tex2D_Mut;
+#ifdef WEBGPU
+    Texture2D g_Tex2D_Mut_0;
+    Texture2D g_Tex2D_Mut_1;    
+#else
+    Texture2D g_Tex2D_Mut[2];
+#endif
 Texture2D g_Tex2D_Dyn;
 
 SamplerState g_Tex2D_Static0_sampler;
@@ -18,10 +23,17 @@ SamplerState g_Tex2D_Dyn_sampler;
 float4 main(in PSInput PSIn) : SV_Target
 {
     float2 UV = float2(0.5, 0.5);
-    return float4(0.0, 0.0, 0.0, PSIn.Color.r) *
-        g_Tex2D_Static0.Sample(g_Tex2D_Static0_sampler, UV.xy) * 
-        g_Tex2D_Static1.Sample(g_Tex2D_Static1_sampler, UV.xy) *
-        g_Tex2D_Mut.Sample(g_Tex2D_Mut_sampler, UV.xy) *
-        g_Tex2D_Dyn.Sample(g_Tex2D_Dyn_sampler, UV.xy) * 
-        g_Data.RefTexColors[0];
+    float4 Color = float4(0.0, 0.0, 0.0, PSIn.Color.r);
+    Color *= g_Tex2D_Static0.Sample(g_Tex2D_Static0_sampler, UV.xy);
+    Color *= g_Tex2D_Static1.Sample(g_Tex2D_Static1_sampler, UV.xy);
+#ifdef WEBGPU 
+    Color *= g_Tex2D_Mut_0.Sample(g_Tex2D_Mut_sampler, UV.xy);
+    Color *= g_Tex2D_Mut_1.Sample(g_Tex2D_Mut_sampler, UV.xy);
+#else
+    Color *= g_Tex2D_Mut[0].Sample(g_Tex2D_Mut_sampler, UV.xy);
+    Color *= g_Tex2D_Mut[1].Sample(g_Tex2D_Mut_sampler, UV.xy);
+#endif
+    Color *= g_Tex2D_Dyn.Sample(g_Tex2D_Dyn_sampler, UV.xy); 
+    Color *= g_Data.RefTexColors[0];
+    return Color;
 }