Added SHADER_COMPILE_FLAG_HLSL_TO_SPIRV_VIA_GLSL flag (API256008)

Author: TheMostDiligent

Graphics/GraphicsEngine/interface/APIInfo.h

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

Graphics/GraphicsEngine/interface/Shader.h

@@ -369,7 +369,29 @@ DILIGENT_TYPED_ENUM(SHADER_COMPILE_FLAGS, Uint32)
     ///             they are laid out in memory row-by-row.
     SHADER_COMPILE_FLAG_PACK_MATRIX_ROW_MAJOR   = 1u << 3u,
 
-    SHADER_COMPILE_FLAG_LAST = SHADER_COMPILE_FLAG_PACK_MATRIX_ROW_MAJOR
+    /// Convert HLSL to GLSL when compiling HLSL shaders to SPIRV.
+    ///
+    /// \remarks    HLSL shaders can be compiled to SPIRV directly using either DXC or glslang.
+    ///             While glslang supports most HLSL 5.1 features, some Vulkan-specific functionality
+    ///             is missing. Notably, glslang does not support UAV texture format annotations
+    ///             (see https://github.com/KhronosGroup/glslang/issues/3790), for example:
+    ///
+    ///                 [[vk::image_format("rgba8")]] RWTexture2D<float4> g_rwTexture;
+    ///
+    ///             This flag provides a workaround by converting HLSL to GLSL before compiling it
+    ///             to SPIRV. The converter supports specially formatted comments to specify UAV
+    ///             texture formats:
+    ///
+    ///                 RWTexture2D<float4 /*format = rgba8*/> g_rwTexture;
+    ///
+    ///             Another use case for this flag is to leverage GLSL-specific keywords in HLSL
+    ///             shaders, such as `gl_DrawID` for multi-draw or manually setting `gl_PointSize`.
+    ///
+    /// \note       This flag only takes effect when compiling HLSL to SPIRV with glslang.
+    ///             Since DXC does not support GLSL, this flag is ignored when SHADER_COMPILER_DXC is used.
+    SHADER_COMPILE_FLAG_HLSL_TO_SPIRV_VIA_GLSL = 1u << 4u,
+
+    SHADER_COMPILE_FLAG_LAST = SHADER_COMPILE_FLAG_HLSL_TO_SPIRV_VIA_GLSL
 };
 DEFINE_FLAG_ENUM_OPERATORS(SHADER_COMPILE_FLAGS);
 

Graphics/GraphicsEngineD3DBase/src/ShaderD3DBase.cpp

@@ -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");
@@ -73,7 +73,7 @@ class D3DIncludeImpl : public ID3DInclude
             return E_FAIL;
         }
 
-        auto pFileData = DataBlobImpl::Create();
+        RefCntAutoPtr<DataBlobImpl> pFileData = DataBlobImpl::Create();
         pSourceStream->ReadBlob(pFileData);
         *ppData = pFileData->GetDataPtr();
         *pBytes = StaticCast<UINT>(pFileData->GetSize());
@@ -115,7 +115,7 @@ HRESULT CompileShader(const char*             Source,
     // dwShaderFlags |= D3D10_SHADER_OPTIMIZATION_LEVEL3;
 #endif
 
-    static_assert(SHADER_COMPILE_FLAG_LAST == 1u << 3u, "Did you add a new shader compile flag? You may need to handle it here.");
+    static_assert(SHADER_COMPILE_FLAG_LAST == 1u << 4u, "Did you add a new shader compile flag? You may need to handle it here.");
     if (ShaderCI.CompileFlags & SHADER_COMPILE_FLAG_ENABLE_UNBOUNDED_ARRAYS)
         dwShaderFlags |= D3DCOMPILE_ENABLE_UNBOUNDED_DESCRIPTOR_TABLES;
 
@@ -177,7 +177,7 @@ RefCntAutoPtr<IDataBlob> CompileD3DBytecode(const ShaderCreateInfo& ShaderCI,
             CComPtr<ID3DBlob> CompilerOutput;
             CComPtr<ID3DBlob> pShaderByteCode;
 
-            auto hr = CompileShader(HLSLSource.c_str(), HLSLSource.length(), ShaderCI, Profile.c_str(), &pShaderByteCode, &CompilerOutput);
+            HRESULT hr = CompileShader(HLSLSource.c_str(), HLSLSource.length(), ShaderCI, Profile.c_str(), &pShaderByteCode, &CompilerOutput);
             HandleHLSLCompilerResult(SUCCEEDED(hr), CompilerOutput.p, HLSLSource, ShaderCI.Desc.Name, ppCompilerOutput);
             return DataBlobImpl::Create(pShaderByteCode->GetBufferSize(), pShaderByteCode->GetBufferPointer());
         }

Graphics/GraphicsEngineVulkan/src/ShaderVkImpl.cpp

@@ -98,7 +98,7 @@ std::vector<uint32_t> CompileShaderGLSLang(const ShaderCreateInfo&         Shade
 #if DILIGENT_NO_GLSLANG
     LOG_ERROR_AND_THROW("Diligent engine was not linked with glslang, use DXC or precompiled SPIRV bytecode.");
 #else
-    if (ShaderCI.SourceLanguage == SHADER_SOURCE_LANGUAGE_HLSL)
+    if (ShaderCI.SourceLanguage == SHADER_SOURCE_LANGUAGE_HLSL && (ShaderCI.CompileFlags & SHADER_COMPILE_FLAG_HLSL_TO_SPIRV_VIA_GLSL) == 0)
     {
         SPIRV = GLSLangUtils::HLSLtoSPIRV(ShaderCI, GLSLangUtils::SpirvVersion::Vk100, VulkanDefine, VkShaderCI.ppCompilerOutput);
     }

Graphics/HLSL2GLSLConverterLib/include/GLSLDefinitions.h

@@ -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");
@@ -458,10 +458,12 @@ void DeviceMemoryBarrier()
     // returns with no other effect.
     memoryBarrierImage();
 
+#ifndef VULKAN
     // OpenGL.org: memoryBarrierAtomicCounter() waits on the completion of
     // all accesses resulting from the use of ATOMIC COUNTERS and then returns
     // with no other effect.
     memoryBarrierAtomicCounter();
+#endif
 }
 
 // MSDN: DeviceMemoryBarrierWithGroupSync() blocks execution of
@@ -502,10 +504,12 @@ void AllMemoryBarrier()
     // returns with no other effect.
     memoryBarrierImage();
 
+#ifndef VULKAN
     // OpenGL.org: memoryBarrierAtomicCounter() waits on the completion of
     // all accesses resulting from the use of ATOMIC COUNTERS and then returns
     // with no other effect.
     memoryBarrierAtomicCounter();
+#endif
 
     // groupMemoryBarrier waits on the completion of all memory accesses performed
     // by an invocation of a compute shader relative to the same access performed by

ReleaseHistory.md

@@ -1,5 +1,6 @@
 ## Current progress
 
+* Added `SHADER_COMPILE_FLAG_HLSL_TO_SPIRV_VIA_GLSL` flag (API256008)
 * Added `IRenderDevice::CreateDeferredContext()` method (API256007)
 * Added `HostImageCopy` member to `DeviceFeaturesVk` struct (API256006)
 * Added `IRenderDeviceVk::GetDeviceFeaturesVk()` method (API256005)