Added SourceLength to ShaderCreateInfo (close #282)

Author: TheMostDiligent

Graphics/GraphicsEngine/interface/Shader.h

@@ -240,10 +240,22 @@ struct ShaderCreateInfo
     ///        HLSL shaders need to be compiled against 4.0 profile or higher.
     const void* ByteCode DEFAULT_INITIALIZER(nullptr);
 
-    /// Size of the compiled shader bytecode
+    union
+    {
+        /// Length of the source code, when Source is not null.
 
-    /// Byte code size (in bytes) must be provided if ByteCode is not null
-    size_t ByteCodeSize DEFAULT_INITIALIZER(0);
+        /// When Source is not null and is not a null-terminated string, this member
+        /// should be used to specify the length of the source code.
+        /// If SourceLength is zero, the source code string is assumed to be
+        /// null-terminated.
+        size_t SourceLength DEFAULT_INITIALIZER(0);
+
+
+        /// Size of the compiled shader byte code, when ByteCode is not null.
+
+        /// Byte code size (in bytes) must not be zero if ByteCode is not null.
+        size_t ByteCodeSize;
+    };
 
     /// Shader entry point
 

Graphics/GraphicsEngineD3DBase/src/ShaderD3DBase.cpp

@@ -139,7 +139,6 @@ ShaderD3DBase::ShaderD3DBase(const ShaderCreateInfo& ShaderCI, const ShaderVersi
     if (ShaderCI.Source || ShaderCI.FilePath)
     {
         DEV_CHECK_ERR(ShaderCI.ByteCode == nullptr, "'ByteCode' must be null when shader is created from the source code or a file");
-        DEV_CHECK_ERR(ShaderCI.ByteCodeSize == 0, "'ByteCodeSize' must be 0 when shader is created from the source code or a file");
         DEV_CHECK_ERR(ShaderCI.EntryPoint != nullptr, "Entry point must not be null");
 
         bool UseDXC = false;

Graphics/GraphicsEngineOpenGL/src/ShaderGLImpl.cpp

@@ -60,7 +60,6 @@ ShaderGLImpl::ShaderGLImpl(IReferenceCounters*     pRefCounters,
 // clang-format on
 {
     DEV_CHECK_ERR(ShaderCI.ByteCode == nullptr, "'ByteCode' must be null when shader is created from the source code or a file");
-    DEV_CHECK_ERR(ShaderCI.ByteCodeSize == 0, "'ByteCodeSize' must be 0 when shader is created from the source code or a file");
     DEV_CHECK_ERR(ShaderCI.ShaderCompiler == SHADER_COMPILER_DEFAULT, "only default compiler is supported in OpenGL");
 
     const auto& DeviceInfo  = pDeviceGL->GetDeviceInfo();
@@ -93,9 +92,9 @@ ShaderGLImpl::ShaderGLImpl(IReferenceCounters*     pRefCounters,
         }
 
         // Read the source file directly and use it as is
-        size_t SourceLen = 0;
+        size_t SourceLen = ShaderCI.SourceLength;
         ShaderStrings[0] = ReadShaderSourceFile(ShaderCI.Source, ShaderCI.pShaderSourceStreamFactory, ShaderCI.FilePath, pSourceFileData, SourceLen);
-        Lengths[0]       = static_cast<GLint>(SourceLen);
+        Lengths[0]       = StaticCast<GLint>(SourceLen);
     }
     else
     {

Graphics/GraphicsEngineVulkan/src/ShaderVkImpl.cpp

@@ -60,7 +60,6 @@ ShaderVkImpl::ShaderVkImpl(IReferenceCounters*     pRefCounters,
     if (ShaderCI.Source != nullptr || ShaderCI.FilePath != nullptr)
     {
         DEV_CHECK_ERR(ShaderCI.ByteCode == nullptr, "'ByteCode' must be null when shader is created from source code or a file");
-        DEV_CHECK_ERR(ShaderCI.ByteCodeSize == 0, "'ByteCodeSize' must be 0 when shader is created from source code or a file");
 
         static constexpr char VulkanDefine[] =
             "#ifndef VULKAN\n"
@@ -110,7 +109,7 @@ ShaderVkImpl::ShaderVkImpl(IReferenceCounters*     pRefCounters,
                     RefCntAutoPtr<IDataBlob> pSourceFileData;
 
                     const char*        ShaderSource = nullptr;
-                    size_t             SourceLength = 0;
+                    size_t             SourceLength = ShaderCI.SourceLength;
                     const ShaderMacro* Macros       = nullptr;
                     if (ShaderCI.SourceLanguage == SHADER_SOURCE_LANGUAGE_GLSL_VERBATIM)
                     {

Graphics/ShaderTools/src/GLSLUtils.cpp

@@ -272,7 +272,7 @@ String BuildGLSLSourceString(const ShaderCreateInfo&    ShaderCI,
     AppendShaderMacros(GLSLSource, ShaderCI.Macros);
 
     RefCntAutoPtr<IDataBlob> pFileData;
-    size_t                   SourceLen = 0;
+    size_t                   SourceLen = ShaderCI.SourceLength;
 
     const auto* ShaderSource = ReadShaderSourceFile(ShaderCI.Source, ShaderCI.pShaderSourceStreamFactory, ShaderCI.FilePath, pFileData, SourceLen);
 

Graphics/ShaderTools/src/GLSLangUtils.cpp

@@ -359,7 +359,7 @@ std::vector<unsigned int> HLSLtoSPIRV(const ShaderCreateInfo& ShaderCI,
     Shader.setEnvTargetHlslFunctionality1();
 
     RefCntAutoPtr<IDataBlob> pFileData;
-    size_t                   SourceCodeLen = 0;
+    size_t                   SourceCodeLen = ShaderCI.SourceLength;
 
     const char* SourceCode = ReadShaderSourceFile(ShaderCI.Source, ShaderCI.pShaderSourceStreamFactory, ShaderCI.FilePath, pFileData, SourceCodeLen);
 

Graphics/ShaderTools/src/ShaderToolsCommon.cpp

@@ -109,11 +109,11 @@ const char* ReadShaderSourceFile(const char*                      SourceCode,
                                  RefCntAutoPtr<IDataBlob>&        pFileData,
                                  size_t&                          SourceCodeLen) noexcept(false)
 {
-    SourceCodeLen = 0;
     if (SourceCode != nullptr)
     {
         VERIFY(FilePath == nullptr, "FilePath must be null when SourceCode is not null");
-        SourceCodeLen = strlen(SourceCode);
+        if (SourceCodeLen == 0)
+            SourceCodeLen = strlen(SourceCode);
     }
     else
     {
@@ -147,9 +147,11 @@ const char* ReadShaderSourceFile(const char*                      SourceCode,
 
 void AppendShaderSourceCode(std::string& Source, const ShaderCreateInfo& ShaderCI) noexcept(false)
 {
+    VERIFY_EXPR(ShaderCI.ByteCode == nullptr);
+
     RefCntAutoPtr<IDataBlob> pFileData;
 
-    size_t SourceCodeLen = 0;
+    size_t SourceCodeLen = ShaderCI.SourceLength;
 
     const auto* SourceCode =
         ReadShaderSourceFile(ShaderCI.Source, ShaderCI.pShaderSourceStreamFactory,