Added SerializationDeviceGLInfo struct (API254005)

Author: TheMostDiligent

Graphics/Archiver/include/SerializationDeviceImpl.hpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-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.
@@ -143,6 +143,11 @@ class SerializationDeviceImpl final : public RenderDeviceBase<SerializationEngin
         Version      ShaderVersion;
     };
 
+    struct GLProperties
+    {
+        bool ValidateShaders = false;
+    };
+
     struct VkProperties
     {
         IDXCompiler* pDxCompiler     = nullptr;
@@ -162,6 +167,7 @@ class SerializationDeviceImpl final : public RenderDeviceBase<SerializationEngin
 
     const D3D11Properties& GetD3D11Properties() const { return m_D3D11Props; }
     const D3D12Properties& GetD3D12Properties() const { return m_D3D12Props; }
+    const GLProperties&    GetGLProperties() const { return m_GLProps; }
     const VkProperties&    GetVkProperties() const { return m_VkProps; }
     const MtlProperties&   GetMtlProperties() const { return m_MtlProps; }
 
@@ -198,6 +204,7 @@ class SerializationDeviceImpl final : public RenderDeviceBase<SerializationEngin
 
     D3D11Properties m_D3D11Props;
     D3D12Properties m_D3D12Props;
+    GLProperties    m_GLProps;
     VkProperties    m_VkProps;
     MtlProperties   m_MtlProps;
 

Graphics/Archiver/interface/ArchiverFactory.h

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-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.
@@ -95,6 +95,33 @@ struct SerializationDeviceD3D12Info
 typedef struct SerializationDeviceD3D12Info SerializationDeviceD3D12Info;
 
 
+/// Serialization device attributes for OpenGL backend
+struct SerializationDeviceGLInfo
+{
+    /// Whether to validate OpenGL shaders.
+
+    /// \remarks    In OpenGL backend, shaders are converted from HLSL to GLSL
+    ///             (if necessary) and packed into an archive as source code.
+    ///             When this flag is set to True, the archiver will compile
+    ///             the source code to validate it is correct.
+    ///             This may be time-consuming and could be disabled to speed up
+    ///             the archiving process.
+    Bool  ValidateShaders DEFAULT_INITIALIZER(True);
+
+#if DILIGENT_CPP_INTERFACE
+    bool operator==(const SerializationDeviceGLInfo& RHS) const noexcept
+    {
+        return ValidateShaders == RHS.ValidateShaders;
+    }
+    bool operator!=(const SerializationDeviceGLInfo& RHS) const noexcept
+    {
+        return !(*this == RHS);
+    }
+#endif
+};
+typedef struct SerializationDeviceGLInfo SerializationDeviceGLInfo;
+
+
 /// Serialization device attributes for Vulkan backend
 struct SerializationDeviceVkInfo
 {
@@ -176,6 +203,9 @@ struct SerializationDeviceCreateInfo
     /// Direct3D12 attributes, see Diligent::SerializationDeviceD3D12Info.
     SerializationDeviceD3D12Info D3D12;
 
+    /// OpenGL attributes, see Diligent::SerializationDeviceGLInfo.
+    SerializationDeviceGLInfo GL;
+
     /// Vulkan attributes, see Diligent::SerializationDeviceVkInfo.
     SerializationDeviceVkInfo Vulkan;
 

Graphics/Archiver/src/Archiver_GL.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-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.
@@ -239,27 +239,30 @@ void SerializedShaderImpl::CreateShaderGL(IReferenceCounters*     pRefCounters,
     CreateShader<CompiledShaderGL>(DeviceType::OpenGL, pRefCounters, ShaderCI, GLShaderCI, m_pDevice->GetRenderDevice(RENDER_DEVICE_TYPE_GL));
 
 #if !DILIGENT_NO_GLSLANG
-    const auto* pCompiledShaderGL = GetShader<CompiledShaderGL>(DeviceObjectArchive::DeviceType::OpenGL);
-    VERIFY_EXPR(pCompiledShaderGL != nullptr);
+    if (m_pDevice->GetGLProperties().ValidateShaders)
+    {
+        const auto* pCompiledShaderGL = GetShader<CompiledShaderGL>(DeviceObjectArchive::DeviceType::OpenGL);
+        VERIFY_EXPR(pCompiledShaderGL != nullptr);
 
-    const void* Source    = nullptr;
-    Uint64      SourceLen = 0;
-    // For OpenGL, GetBytecode returns the full GLSL source
-    pCompiledShaderGL->pShaderGL->GetBytecode(&Source, SourceLen);
-    VERIFY_EXPR(Source != nullptr && SourceLen != 0);
+        const void* Source    = nullptr;
+        Uint64      SourceLen = 0;
+        // For OpenGL, GetBytecode returns the full GLSL source
+        pCompiledShaderGL->pShaderGL->GetBytecode(&Source, SourceLen);
+        VERIFY_EXPR(Source != nullptr && SourceLen != 0);
 
-    GLSLangUtils::GLSLtoSPIRVAttribs Attribs;
+        GLSLangUtils::GLSLtoSPIRVAttribs Attribs;
 
-    Attribs.ShaderType = ShaderCI.Desc.ShaderType;
-    VERIFY_EXPR(DeviceType == RENDER_DEVICE_TYPE_GL || DeviceType == RENDER_DEVICE_TYPE_GLES);
-    Attribs.Version = DeviceType == RENDER_DEVICE_TYPE_GL ? GLSLangUtils::SpirvVersion::GL : GLSLangUtils::SpirvVersion::GLES;
+        Attribs.ShaderType = ShaderCI.Desc.ShaderType;
+        VERIFY_EXPR(DeviceType == RENDER_DEVICE_TYPE_GL || DeviceType == RENDER_DEVICE_TYPE_GLES);
+        Attribs.Version = DeviceType == RENDER_DEVICE_TYPE_GL ? GLSLangUtils::SpirvVersion::GL : GLSLangUtils::SpirvVersion::GLES;
 
-    Attribs.ppCompilerOutput = ppCompilerOutput;
-    Attribs.ShaderSource     = static_cast<const char*>(Source);
-    Attribs.SourceCodeLen    = static_cast<int>(SourceLen);
+        Attribs.ppCompilerOutput = ppCompilerOutput;
+        Attribs.ShaderSource     = static_cast<const char*>(Source);
+        Attribs.SourceCodeLen    = static_cast<int>(SourceLen);
 
-    if (GLSLangUtils::GLSLtoSPIRV(Attribs).empty())
-        LOG_ERROR_AND_THROW("Failed to compile shader '", ShaderCI.Desc.Name, "'");
+        if (GLSLangUtils::GLSLtoSPIRV(Attribs).empty())
+            LOG_ERROR_AND_THROW("Failed to compile shader '", ShaderCI.Desc.Name, "'");
+    }
 #endif
 }
 

Graphics/Archiver/src/SerializationDeviceImpl.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-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.
@@ -81,6 +81,11 @@ SerializationDeviceImpl::SerializationDeviceImpl(IReferenceCounters* pRefCounter
         m_D3D12Props.ShaderVersion = CreateInfo.D3D12.ShaderVersion;
     }
 
+    if (m_ValidDeviceFlags & (ARCHIVE_DEVICE_DATA_FLAG_GL | ARCHIVE_DEVICE_DATA_FLAG_GLES))
+    {
+        m_GLProps.ValidateShaders = CreateInfo.GL.ValidateShaders;
+    }
+
     if (m_ValidDeviceFlags & ARCHIVE_DEVICE_DATA_FLAG_VULKAN)
     {
         const auto& ApiVersion    = CreateInfo.Vulkan.ApiVersion;

Graphics/GraphicsEngine/interface/APIInfo.h

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

Graphics/GraphicsTools/src/RenderStateCache.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-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.
@@ -506,7 +506,8 @@ RenderStateCacheImpl::RenderStateCacheImpl(IReferenceCounters*               pRe
 
         case RENDER_DEVICE_TYPE_GL:
         case RENDER_DEVICE_TYPE_GLES:
-            // Nothing to do
+            // Do not validate shaders as compiling them is time-consuming
+            SerializationDeviceCI.GL.ValidateShaders = false;
             break;
 
         case RENDER_DEVICE_TYPE_VULKAN:

ReleaseHistory.md

@@ -1,5 +1,7 @@
 ## Current progress
 
+* Added `SerializationDeviceGLInfo` struct (API254005)
+  * The `ValidateShaders` member allows disabling time-consuming shader compilation
 * Replaced `AnisotropicFilteringSupported` member of `SamplerProperties` struct with `MaxAnisotropy` (API254004)
 * Added `TextureSubresourceViews` device feature (API254003)
 * Added device context rendering statistics (API254002)