TransitionImageLayout()

void Spices::VulkanImage::TransitionImageLayout	(	VkFormat	format,
		VkImageLayout	oldLayout,
		VkImageLayout	newLayout )

@breif Transform this VkImage's layout.

Parameters

[in]	format	This VkImage's format, see m_Format.
[in]	oldLayout	The original layout, pass VK_IMAGE_LAYOUT_UNDEFINED if don't known the actual layout.
[in]	newLayout	The new layout.

Instance a VkImageMemoryBarrier.

@breif transform imagelayout from undefined to transferdst. Used during CopyBuffertoImage.

@breif transform imagelayout from undefined to transfersrc. Used during CopyImagetoBuffer.

@breif transform imagelayout from undefined to shaderread. Used during CopyImagetoBuffer.

@breif transform imagelayout from transferdst to shaderread. Used combine with CopyBuffertoImage.

transform imagelayout from transfersrc to shaderread. Used combine with CopyImagetoBuffer.

transfer imagelayout from undefined to depthattachment. Used during Creating depth renderresource.

transfer imagelayout from undefined to depthattachment. Used during Creating depth renderresource.

Use Custom Cmd.

Instance a VkImageMemoryBarrier.

@breif transform imagelayout from undefined to transferdst. Used during CopyBuffertoImage.

@breif transform imagelayout from undefined to transfersrc. Used during CopyImagetoBuffer.

@breif transform imagelayout from undefined to shaderread. Used during CopyImagetoBuffer.

@breif transform imagelayout from transferdst to shaderread. Used combine with CopyBuffertoImage.

transform imagelayout from transfersrc to shaderread. Used combine with CopyImagetoBuffer.

transfer imagelayout from undefined to depthattachment. Used during Creating depth renderresource.

transfer imagelayout from undefined to depthattachment. Used during Creating depth renderresource.

Use Custom Cmd.

Definition at line 110 of file VulkanImage.cpp.

    {
        SPICES_PROFILE_ZONE;
 
        VkPipelineStageFlags sourceStage;
        VkPipelineStageFlags destinationStage;
 
        VkImageMemoryBarrier                        barrier{};
        barrier.sType                             = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
        barrier.oldLayout                         = oldLayout;
        barrier.newLayout                         = newLayout;
        barrier.srcQueueFamilyIndex               = VK_QUEUE_FAMILY_IGNORED;
        barrier.dstQueueFamilyIndex               = VK_QUEUE_FAMILY_IGNORED;
        barrier.image                             = m_Image;
        barrier.subresourceRange.aspectMask       = VK_IMAGE_ASPECT_COLOR_BIT;
        barrier.subresourceRange.baseMipLevel     = 0;
        barrier.subresourceRange.levelCount       = m_MipLevels;
        barrier.subresourceRange.baseArrayLayer   = 0;
        barrier.subresourceRange.layerCount       = m_Layers;
        barrier.srcAccessMask                     = 0;
        barrier.dstAccessMask                     = 0;
 
        if (oldLayout == VK_IMAGE_LAYOUT_UNDEFINED && newLayout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL) 
        {
            barrier.srcAccessMask = 0;
            barrier.dstAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
 
            // Don't care what stage the pipeline is in at the start.
            sourceStage = VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT;
 
            // Used for copying
            destinationStage = VK_PIPELINE_STAGE_TRANSFER_BIT;
        }
 
        else if (oldLayout == VK_IMAGE_LAYOUT_UNDEFINED && newLayout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL) 
        {
            barrier.srcAccessMask = 0;
            barrier.dstAccessMask = VK_ACCESS_TRANSFER_READ_BIT;
 
            // Don't care what stage the pipeline is in at the start.
            sourceStage = VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT;
 
            // Used for copying
            destinationStage = VK_PIPELINE_STAGE_TRANSFER_BIT;
        }
 
        else if (oldLayout == VK_IMAGE_LAYOUT_UNDEFINED && newLayout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL)
        {
            barrier.srcAccessMask = 0;
            barrier.dstAccessMask = VK_ACCESS_SHADER_READ_BIT;
 
            // Don't care what stage the pipeline is in at the start.
            sourceStage = VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT;
 
            // Used for sampling.
            destinationStage = VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT;
        }
 
        else if (oldLayout == VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL && newLayout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) 
        {
            barrier.srcAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
            barrier.dstAccessMask = VK_ACCESS_SHADER_READ_BIT;
 
            // From a copying stage to...
            sourceStage = VK_PIPELINE_STAGE_TRANSFER_BIT;
 
            // The fragment stage.
            destinationStage = VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT;
        }
 
        else if (oldLayout == VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL && newLayout == VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL) 
        {
            barrier.srcAccessMask = VK_ACCESS_TRANSFER_READ_BIT;
            barrier.dstAccessMask = VK_ACCESS_SHADER_READ_BIT;
 
            // From a copying stage to...
            sourceStage = VK_PIPELINE_STAGE_TRANSFER_BIT;
 
            // The fragment stage.
            destinationStage = VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT;
        }
 
        else if (oldLayout == VK_IMAGE_LAYOUT_UNDEFINED && newLayout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL) 
        {
            barrier.srcAccessMask = 0;
            barrier.dstAccessMask = VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT | VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT;
 
            sourceStage = VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT;
            destinationStage = VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT;
        }
 
        else if (oldLayout == VK_IMAGE_LAYOUT_UNDEFINED && newLayout == VK_IMAGE_LAYOUT_GENERAL)
        {
            barrier.srcAccessMask = 0;
            barrier.dstAccessMask = VK_IMAGE_ASPECT_NONE;
 
            sourceStage = VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT;
            destinationStage = VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT;
        }
        else 
        {
            SPICES_CORE_WARN("Unsupported layout transition!");
        }
 
        if (newLayout == VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL) 
        {
            barrier.subresourceRange.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
 
            if (format == VK_FORMAT_D32_SFLOAT_S8_UINT || format == VK_FORMAT_D24_UNORM_S8_UINT) 
            {
                barrier.subresourceRange.aspectMask |= VK_IMAGE_ASPECT_STENCIL_BIT;
            }
        }
        else 
        {
            barrier.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
        }
 
        VulkanCommandBuffer::CustomGraphicCmd(m_VulkanState, [&](auto& commandBuffer) {
            vkCmdPipelineBarrier(
                commandBuffer,
                sourceStage, 
                destinationStage,
                0,
                0, 
                nullptr,
                0, 
                nullptr,
                1, 
                &barrier
            );
        });
    }

References Spices::VulkanObject::m_VulkanState.