DXCompiler: replaced ExtraDefinitions parameter with Preamble

Author: TheMostDiligent

Graphics/GraphicsEngineVulkan/src/ShaderVkImpl.cpp

@@ -63,7 +63,7 @@ static constexpr char VulkanDefine[] =
     "#   define METAL 1\n"
     "#endif\n"
 #endif
-    ;
+    "\n";
 
 std::vector<uint32_t> CompileShaderDXC(const ShaderCreateInfo&         ShaderCI,
                                        const ShaderVkImpl::CreateInfo& VkShaderCI)

Graphics/ShaderTools/include/DXCompiler.hpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2024 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -85,7 +85,7 @@ class IDXCompiler
 
     virtual void Compile(const ShaderCreateInfo& ShaderCI,
                          ShaderVersion           ShaderModel,
-                         const char*             ExtraDefinitions,
+                         const char*             Preamble,
                          IDxcBlob**              ppByteCodeBlob,
                          std::vector<uint32_t>*  pByteCode,
                          IDataBlob**             ppCompilerOutput) noexcept(false) = 0;

Graphics/ShaderTools/include/HLSLUtils.hpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2024 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -39,8 +39,7 @@
 namespace Diligent
 {
 
-String BuildHLSLSourceString(const ShaderCreateInfo& ShaderCI,
-                             const char*             ExtraDefinitions = nullptr) noexcept(false);
+String BuildHLSLSourceString(const ShaderCreateInfo& ShaderCI) noexcept(false);
 
 String GetHLSLProfileString(SHADER_TYPE ShaderType, ShaderVersion ShaderModel);
 
@@ -56,8 +55,8 @@ void HandleHLSLCompilerResult(bool               CompilationSucceeded,
 
     if (ppOutputLog != nullptr)
     {
-        const auto ShaderSourceLen = ShaderSource.length();
-        auto       pOutputLogBlob  = DataBlobImpl::Create(ShaderSourceLen + 1 + CompilerMsgLen + 1);
+        const size_t                ShaderSourceLen = ShaderSource.length();
+        RefCntAutoPtr<DataBlobImpl> pOutputLogBlob  = DataBlobImpl::Create(ShaderSourceLen + 1 + CompilerMsgLen + 1);
 
         char* log = pOutputLogBlob->GetDataPtr<char>();
 

Graphics/ShaderTools/src/DXCompiler.cpp

@@ -105,7 +105,7 @@ class DXCompilerImpl final : public IDXCompiler
 
     virtual void Compile(const ShaderCreateInfo& ShaderCI,
                          ShaderVersion           ShaderModel,
-                         const char*             ExtraDefinitions,
+                         const char*             Preamble,
                          IDxcBlob**              ppByteCodeBlob,
                          std::vector<uint32_t>*  pByteCode,
                          IDataBlob**             ppCompilerOutput) noexcept(false) override final;
@@ -688,7 +688,7 @@ void DXCompilerImpl::GetD3D12ShaderReflection(IDxcBlob*                pShaderBy
 
 void DXCompilerImpl::Compile(const ShaderCreateInfo& ShaderCI,
                              ShaderVersion           ShaderModel,
-                             const char*             ExtraDefinitions,
+                             const char*             Preamble,
                              IDxcBlob**              ppByteCodeBlob,
                              std::vector<uint32_t>*  pByteCode,
                              IDataBlob**             ppCompilerOutput) noexcept(false)
@@ -781,7 +781,8 @@ void DXCompilerImpl::Compile(const ShaderCreateInfo& ShaderCI,
 
     IDXCompiler::CompileAttribs CA;
 
-    const String Source = BuildHLSLSourceString(ShaderCI, ExtraDefinitions);
+    String Source{Preamble != nullptr ? Preamble : ""};
+    Source.append(BuildHLSLSourceString(ShaderCI));
 
     DxcDefine Defines[] = {{L"DXCOMPILER", L"1"}};
 

Graphics/ShaderTools/src/HLSLUtils.cpp

@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2023 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -43,17 +43,13 @@ static constexpr char g_HLSLDefinitions[] =
 // clang-format on
 
 
-String BuildHLSLSourceString(const ShaderCreateInfo& ShaderCI,
-                             const char*             ExtraDefinitions) noexcept(false)
+String BuildHLSLSourceString(const ShaderCreateInfo& ShaderCI) noexcept(false)
 {
     String HLSLSource;
 
     HLSLSource.append(g_HLSLDefinitions);
     AppendShaderTypeDefinitions(HLSLSource, ShaderCI.Desc.ShaderType);
 
-    if (ExtraDefinitions != nullptr)
-        HLSLSource += ExtraDefinitions;
-
     if (ShaderCI.Macros)
     {
         HLSLSource += '\n';