VulkanCommandBuffer: fixed references to the spec

TheMostDiligent · TheMostDiligent · commit 98f5c1f6c34d · 2025-01-29T19:44:09.000-08:00
diff --git a/Graphics/GraphicsEngineVulkan/include/VulkanUtilities/VulkanCommandBuffer.hpp b/Graphics/GraphicsEngineVulkan/include/VulkanUtilities/VulkanCommandBuffer.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");
@@ -51,8 +51,12 @@ class VulkanCommandBuffer
                                        const VkImageSubresourceRange& Subresource)
     {
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass == VK_NULL_HANDLE, "vkCmdClearColorImage() must be called outside of render pass (17.1)");
-        VERIFY(Subresource.aspectMask == VK_IMAGE_ASPECT_COLOR_BIT, "The aspectMask of all image subresource ranges must only include VK_IMAGE_ASPECT_COLOR_BIT (17.1)");
+        VERIFY(m_State.RenderPass == VK_NULL_HANDLE,
+               "vkCmdClearColorImage() must be called outside of render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdClearColorImage-renderpass)");
+        VERIFY(Subresource.aspectMask == VK_IMAGE_ASPECT_COLOR_BIT,
+               "The aspectMask of all image subresource ranges must only include VK_IMAGE_ASPECT_COLOR_BIT "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdClearColorImage-aspectMask-02498)");
 
         FlushBarriers();
         vkCmdClearColorImage(
@@ -69,11 +73,14 @@ class VulkanCommandBuffer
                                               const VkImageSubresourceRange&  Subresource)
     {
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass == VK_NULL_HANDLE, "vkCmdClearDepthStencilImage() must be called outside of render pass (17.1)");
+        VERIFY(m_State.RenderPass == VK_NULL_HANDLE,
+               "vkCmdClearDepthStencilImage() must be called outside of render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdClearDepthStencilImage-renderpass)");
         // clang-format off
         VERIFY((Subresource.aspectMask &  (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) != 0 &&
                (Subresource.aspectMask & ~(VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) == 0,
-               "The aspectMask of all image subresource ranges must only include VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT(17.1)");
+               "The aspectMask of all image subresource ranges must only include VK_IMAGE_ASPECT_DEPTH_BIT or VK_IMAGE_ASPECT_STENCIL_BIT "
+                "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdClearDepthStencilImage-aspectMask-02824)");
         // clang-format on
 
         FlushBarriers();
@@ -89,7 +96,9 @@ class VulkanCommandBuffer
     __forceinline void ClearAttachment(const VkClearAttachment& Attachment, const VkClearRect& ClearRect)
     {
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdClearAttachments() must be called inside render pass (17.2)");
+        VERIFY(m_State.RenderPass != VK_NULL_HANDLE,
+               "vkCmdClearAttachments() must be called inside render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdClearAttachments-renderpass)");
 
         vkCmdClearAttachments(
             m_VkCmdBuffer,
@@ -104,7 +113,9 @@ class VulkanCommandBuffer
     __forceinline void Draw(uint32_t VertexCount, uint32_t InstanceCount, uint32_t FirstVertex, uint32_t FirstInstance)
     {
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdDraw() must be called inside render pass (19.3)");
+        VERIFY(m_State.RenderPass != VK_NULL_HANDLE,
+               "vkCmdDraw() must be called inside render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdDraw-renderpass)");
         VERIFY(m_State.GraphicsPipeline != VK_NULL_HANDLE, "No graphics pipeline bound");
 
         vkCmdDraw(m_VkCmdBuffer, VertexCount, InstanceCount, FirstVertex, FirstInstance);
@@ -113,7 +124,9 @@ class VulkanCommandBuffer
     __forceinline void DrawIndexed(uint32_t IndexCount, uint32_t InstanceCount, uint32_t FirstIndex, int32_t VertexOffset, uint32_t FirstInstance)
     {
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdDrawIndexed() must be called inside render pass (19.3)");
+        VERIFY(m_State.RenderPass != VK_NULL_HANDLE,
+               "vkCmdDrawIndexed() must be called inside render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdDrawIndexed-renderpass)");
         VERIFY(m_State.GraphicsPipeline != VK_NULL_HANDLE, "No graphics pipeline bound");
         VERIFY(m_State.IndexBuffer != VK_NULL_HANDLE, "No index buffer bound");
 
@@ -123,7 +136,9 @@ class VulkanCommandBuffer
     __forceinline void DrawIndirect(VkBuffer Buffer, VkDeviceSize Offset, uint32_t DrawCount, uint32_t Stride)
     {
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdDrawIndirect() must be called inside render pass (19.3)");
+        VERIFY(m_State.RenderPass != VK_NULL_HANDLE,
+               "vkCmdDrawIndirect() must be called inside render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdDrawIndirect-renderpass)");
         VERIFY(m_State.GraphicsPipeline != VK_NULL_HANDLE, "No graphics pipeline bound");
 
         vkCmdDrawIndirect(m_VkCmdBuffer, Buffer, Offset, DrawCount, Stride);
@@ -132,7 +147,9 @@ class VulkanCommandBuffer
     __forceinline void DrawIndexedIndirect(VkBuffer Buffer, VkDeviceSize Offset, uint32_t DrawCount, uint32_t Stride)
     {
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdDrawIndirect() must be called inside render pass (19.3)");
+        VERIFY(m_State.RenderPass != VK_NULL_HANDLE,
+               "vkCmdDrawIndexedIndirect() must be called inside render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdDrawIndexedIndirect-renderpass)");
         VERIFY(m_State.GraphicsPipeline != VK_NULL_HANDLE, "No graphics pipeline bound");
         VERIFY(m_State.IndexBuffer != VK_NULL_HANDLE, "No index buffer bound");
 
@@ -143,7 +160,9 @@ class VulkanCommandBuffer
     {
 #if DILIGENT_USE_VOLK
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdDrawIndirectCountKHR() must be called inside render pass (19.3)");
+        VERIFY(m_State.RenderPass != VK_NULL_HANDLE,
+               "vkCmdDrawIndirectCountKHR() must be called inside render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdDrawIndirectCount-renderpass)");
         VERIFY(m_State.GraphicsPipeline != VK_NULL_HANDLE, "No graphics pipeline bound");
 
         vkCmdDrawIndirectCountKHR(m_VkCmdBuffer, Buffer, Offset, CountBuffer, CountBufferOffset, MaxDrawCount, Stride);
@@ -156,7 +175,9 @@ class VulkanCommandBuffer
     {
 #if DILIGENT_USE_VOLK
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdDrawIndirect() must be called inside render pass (19.3)");
+        VERIFY(m_State.RenderPass != VK_NULL_HANDLE,
+               "vkCmdDrawIndexedIndirectCountKHR() must be called inside render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdDrawIndexedIndirectCount-renderpass)");
         VERIFY(m_State.GraphicsPipeline != VK_NULL_HANDLE, "No graphics pipeline bound");
         VERIFY(m_State.IndexBuffer != VK_NULL_HANDLE, "No index buffer bound");
 
@@ -212,7 +233,7 @@ class VulkanCommandBuffer
     {
 #if DILIGENT_USE_VOLK
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdDraw() must be called inside render pass (19.3)");
+        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdDrawMultiEXT() must be called inside render pass");
         VERIFY(m_State.GraphicsPipeline != VK_NULL_HANDLE, "No graphics pipeline bound");
 
         vkCmdDrawMultiEXT(m_VkCmdBuffer, DrawCount, pVertexInfo, InstanceCount, FirstInstance, sizeof(VkMultiDrawInfoEXT));
@@ -228,7 +249,7 @@ class VulkanCommandBuffer
     {
 #if DILIGENT_USE_VOLK
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdDrawIndexed() must be called inside render pass (19.3)");
+        VERIFY(m_State.RenderPass != VK_NULL_HANDLE, "vkCmdDrawMultiIndexedEXT() must be called inside render pass");
         VERIFY(m_State.GraphicsPipeline != VK_NULL_HANDLE, "No graphics pipeline bound");
         VERIFY(m_State.IndexBuffer != VK_NULL_HANDLE, "No index buffer bound");
 
@@ -244,7 +265,9 @@ class VulkanCommandBuffer
     __forceinline void Dispatch(uint32_t GroupCountX, uint32_t GroupCountY, uint32_t GroupCountZ)
     {
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass == VK_NULL_HANDLE, "vkCmdDispatch() must be called outside of render pass (27)");
+        VERIFY(m_State.RenderPass == VK_NULL_HANDLE,
+               "vkCmdDispatch() must be called outside of render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdDispatch-renderpass)");
         VERIFY(m_State.ComputePipeline != VK_NULL_HANDLE, "No compute pipeline bound");
 
         FlushBarriers();
@@ -254,7 +277,9 @@ class VulkanCommandBuffer
     __forceinline void DispatchIndirect(VkBuffer Buffer, VkDeviceSize Offset)
     {
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
-        VERIFY(m_State.RenderPass == VK_NULL_HANDLE, "vkCmdDispatchIndirect() must be called outside of render pass (27)");
+        VERIFY(m_State.RenderPass == VK_NULL_HANDLE,
+               "vkCmdDispatchIndirect() must be called outside of render pass "
+               "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdDispatchIndirect-renderpass)");
         VERIFY(m_State.ComputePipeline != VK_NULL_HANDLE, "No compute pipeline bound");
 
         FlushBarriers();
@@ -316,7 +341,8 @@ class VulkanCommandBuffer
             LOG_ERROR_MESSAGE("Ending render pass while there are outstanding queries that have been started inside the pass, "
                               "but have not been ended. Vulkan requires that a query must either begin and end inside the same "
                               "subpass of a render pass instance, or must both begin and end outside of a render pass "
-                              "instance (i.e. contain entire render pass instances). (17.2)");
+                              "instance (i.e. contain entire render pass instances). "
+                              "(https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdEndRenderPass-None-07004)");
         }
     }
 
@@ -562,7 +588,8 @@ class VulkanCommandBuffer
         }
 
         // A query must either begin and end inside the same subpass of a render pass instance, or must both
-        // begin and end outside a render pass instance (i.e. contain entire render pass instances) (17.2).
+        // begin and end outside a render pass instance (i.e. contain entire render pass instances)
+        // (https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#VUID-vkCmdEndRenderPass-None-07004).
 
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
         vkCmdBeginQuery(m_VkCmdBuffer, queryPool, query, flags);
@@ -623,7 +650,7 @@ class VulkanCommandBuffer
         VERIFY_EXPR(m_VkCmdBuffer != VK_NULL_HANDLE);
         if (m_State.RenderPass != VK_NULL_HANDLE)
         {
-            // Copy query results must be performed outside of render pass (17.2).
+            // Copy query results must be performed outside of render pass.
             EndRenderPass();
         }
         FlushBarriers();
diff --git a/Graphics/GraphicsEngineVulkan/src/VulkanUtilities/VulkanCommandBuffer.cpp b/Graphics/GraphicsEngineVulkan/src/VulkanUtilities/VulkanCommandBuffer.cpp
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2019-2022 Diligent Graphics LLC
+ *  Copyright 2019-2025 Diligent Graphics LLC
  *  Copyright 2015-2019 Egor Yusov
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
@@ -45,56 +45,56 @@ static VkAccessFlags AccessMaskFromImageLayout(VkImageLayout Layout,
     {
         // does not support device access. This layout must only be used as the initialLayout member
         // of VkImageCreateInfo or VkAttachmentDescription, or as the oldLayout in an image transition.
-        // When transitioning out of this layout, the contents of the memory are not guaranteed to be preserved (11.4)
+        // When transitioning out of this layout, the contents of the memory are not guaranteed to be preserved
         case VK_IMAGE_LAYOUT_UNDEFINED:
             if (IsDstMask)
             {
                 UNEXPECTED("The new layout used in a transition must not be VK_IMAGE_LAYOUT_UNDEFINED. "
                            "This layout must only be used as the initialLayout member of VkImageCreateInfo "
-                           "or VkAttachmentDescription, or as the oldLayout in an image transition. (11.4)");
+                           "or VkAttachmentDescription, or as the oldLayout in an image transition.");
             }
             break;
 
         // supports all types of device access
         case VK_IMAGE_LAYOUT_GENERAL:
-            // VK_IMAGE_LAYOUT_GENERAL must be used for image load/store operations (13.1.1, 13.2.4)
+            // VK_IMAGE_LAYOUT_GENERAL must be used for image load/store operations
             AccessMask = VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_SHADER_WRITE_BIT;
             break;
 
-        // must only be used as a color or resolve attachment in a VkFramebuffer (11.4)
+        // must only be used as a color or resolve attachment in a VkFramebuffer
         case VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL:
             AccessMask = VK_ACCESS_COLOR_ATTACHMENT_READ_BIT | VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT;
             break;
 
-        // must only be used as a depth/stencil attachment in a VkFramebuffer (11.4)
+        // must only be used as a depth/stencil attachment in a VkFramebuffer
         case VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL:
             AccessMask = VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT;
             break;
 
-        // must only be used as a read-only depth/stencil attachment in a VkFramebuffer and/or as a read-only image in a shader (11.4)
+        // must only be used as a read-only depth/stencil attachment in a VkFramebuffer and/or as a read-only image in a shader
         case VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL:
             AccessMask = VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT;
             break;
 
         // must only be used as a read-only image in a shader (which can be read as a sampled image,
-        // combined image/sampler and/or input attachment) (11.4)
+        // combined image/sampler and/or input attachment)
         case VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL:
             AccessMask = VK_ACCESS_SHADER_READ_BIT | VK_ACCESS_INPUT_ATTACHMENT_READ_BIT;
             break;
 
-        //  must only be used as a source image of a transfer command (11.4)
+        //  must only be used as a source image of a transfer command
         case VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL:
             AccessMask = VK_ACCESS_TRANSFER_READ_BIT;
             break;
 
-        // must only be used as a destination image of a transfer command (11.4)
+        // must only be used as a destination image of a transfer command
         case VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL:
             AccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
             break;
 
         // does not support device access. This layout must only be used as the initialLayout member
         // of VkImageCreateInfo or VkAttachmentDescription, or as the oldLayout in an image transition.
-        // When transitioning out of this layout, the contents of the memory are preserved. (11.4)
+        // When transitioning out of this layout, the contents of the memory are preserved.
         case VK_IMAGE_LAYOUT_PREINITIALIZED:
             if (!IsDstMask)
             {
@@ -104,7 +104,7 @@ static VkAccessFlags AccessMaskFromImageLayout(VkImageLayout Layout,
             {
                 UNEXPECTED("The new layout used in a transition must not be VK_IMAGE_LAYOUT_PREINITIALIZED. "
                            "This layout must only be used as the initialLayout member of VkImageCreateInfo "
-                           "or VkAttachmentDescription, or as the oldLayout in an image transition. (11.4)");
+                           "or VkAttachmentDescription, or as the oldLayout in an image transition.");
             }
             break;
 
