texture2d - getVulkanImage and support for Texture2DUsage::Attachment (maplibre#3632)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Adrian Cojocaru <adrian.cojocaru92@yahoo.com>
Co-authored-by: Bart Louwers <bart@emeel.net>

Author: 4 people

include/mbgl/vulkan/texture2d.hpp

@@ -80,6 +80,7 @@ class Texture2D : public gfx::Texture2D {
 
     const vk::ImageLayout& getVulkanImageLayout() const { return imageLayout; }
     const vk::UniqueImageView& getVulkanImageView() const { return imageAllocation->imageView; }
+    const vk::Image& getVulkanImage() const { return imageAllocation->image; }
     const vk::Sampler& getVulkanSampler();
 
     void copyImage(vk::Image image);

src/mbgl/vulkan/offscreen_texture.cpp

@@ -46,8 +46,12 @@ class OffscreenTextureResource final : public RenderableResource {
     const vk::UniqueFramebuffer& getFramebuffer() const override { return framebuffer; };
 
     PremultipliedImage readStillImage() {
-        assert(false);
-        return {};
+        if (!colorTexture) {
+            return {};
+        }
+
+        const auto& image = static_cast<Texture2D&>(*colorTexture).readImage();
+        return image ? image->clone() : PremultipliedImage();
     }
 
     gfx::Texture2DPtr& getTexture() {

src/mbgl/vulkan/texture2d.cpp

@@ -288,7 +288,7 @@ void Texture2D::createTexture() {
 
         case Texture2DUsage::Attachment:
             imageUsage = vk::ImageUsageFlags() | vk::ImageUsageFlagBits::eColorAttachment |
-                         vk::ImageUsageFlagBits::eSampled;
+                         vk::ImageUsageFlagBits::eSampled | vk::ImageUsageFlagBits::eTransferSrc;
             imageTiling = vk::ImageTiling::eOptimal;
             break;
 
@@ -524,30 +524,107 @@ std::shared_ptr<PremultipliedImage> Texture2D::readImage() {
 
     // check for offset/padding
     const auto& device = context.getBackend().getDevice();
-    const auto& layout = device->getImageSubresourceLayout(imageAllocation->image,
-                                                           vk::ImageSubresource(vk::ImageAspectFlagBits::eColor, 0, 0),
-                                                           context.getBackend().getDispatcher());
+    const auto& dispatcher = context.getBackend().getDispatcher();
 
     imageData->resize(size);
     const auto& imageSize = getDataSize();
 
-    void* mappedData_ = nullptr;
-    vmaMapMemory(context.getBackend().getAllocator(), imageAllocation->allocation, &mappedData_);
+    // Check if this is an attachment texture that needs staging buffer
+    if (textureUsage == Texture2DUsage::Attachment) {
+        // For optimal tiling, we need to copy to a staging buffer first
+        const auto& allocator = context.getBackend().getAllocator();
+
+        // Create staging buffer
+        const auto bufferInfo = vk::BufferCreateInfo()
+                                    .setSize(imageSize)
+                                    .setUsage(vk::BufferUsageFlagBits::eTransferDst)
+                                    .setSharingMode(vk::SharingMode::eExclusive);
+
+        VmaAllocationCreateInfo allocationInfo = {};
+        allocationInfo.usage = VMA_MEMORY_USAGE_AUTO_PREFER_HOST;
+        allocationInfo.requiredFlags = VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT | VK_MEMORY_PROPERTY_HOST_COHERENT_BIT;
+        allocationInfo.flags = VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT |
+                               VMA_ALLOCATION_CREATE_MAPPED_BIT;
+
+        SharedBufferAllocation bufferAllocation = std::make_shared<BufferAllocation>(allocator);
+        if (!bufferAllocation->create(allocationInfo, bufferInfo)) {
+            mbgl::Log::Error(mbgl::Event::Render, "Vulkan readImage staging buffer allocation failed");
+            return nullptr;
+        }
+
+        // Copy image to staging buffer
+        context.submitOneTimeCommand([&](const vk::UniqueCommandBuffer& commandBuffer) {
+            // Transition image layout for reading
+            const auto barrier = vk::ImageMemoryBarrier()
+                                     .setImage(imageAllocation->image)
+                                     .setOldLayout(imageLayout)
+                                     .setNewLayout(vk::ImageLayout::eTransferSrcOptimal)
+                                     .setSrcAccessMask(vk::AccessFlagBits::eColorAttachmentWrite)
+                                     .setDstAccessMask(vk::AccessFlagBits::eTransferRead)
+                                     .setSrcQueueFamilyIndex(VK_QUEUE_FAMILY_IGNORED)
+                                     .setDstQueueFamilyIndex(VK_QUEUE_FAMILY_IGNORED)
+                                     .setSubresourceRange({vk::ImageAspectFlagBits::eColor, 0, 1, 0, 1});
+
+            commandBuffer->pipelineBarrier(vk::PipelineStageFlagBits::eColorAttachmentOutput,
+                                           vk::PipelineStageFlagBits::eTransfer,
+                                           {},
+                                           nullptr,
+                                           nullptr,
+                                           barrier,
+                                           dispatcher);
+
+            imageLayout = barrier.newLayout;
+
+            // Copy image to buffer
+            const auto region = vk::BufferImageCopy()
+                                    .setBufferOffset(0)
+                                    .setBufferRowLength(0)
+                                    .setBufferImageHeight(0)
+                                    .setImageSubresource(
+                                        vk::ImageSubresourceLayers(vk::ImageAspectFlagBits::eColor, 0, 0, 1))
+                                    .setImageOffset({0, 0, 0})
+                                    .setImageExtent({size.width, size.height, 1});
+
+            commandBuffer->copyImageToBuffer(imageAllocation->image,
+                                             vk::ImageLayout::eTransferSrcOptimal,
+                                             bufferAllocation->buffer,
+                                             region,
+                                             dispatcher);
+        });
+
+        // Map staging buffer and copy to image data
+        vmaMapMemory(allocator, bufferAllocation->allocation, &bufferAllocation->mappedBuffer);
+        memcpy(imageData->data.get(), bufferAllocation->mappedBuffer, imageSize);
+        vmaUnmapMemory(allocator, bufferAllocation->allocation);
 
-    uint8_t* mappedData = reinterpret_cast<uint8_t*>(mappedData_) + layout.offset;
+        return imageData;
+    } else if (textureUsage == Texture2DUsage::Read) {
+        // For linear tiling (Read usage), use direct memory mapping
+        const auto& layout = device->getImageSubresourceLayout(
+            imageAllocation->image, vk::ImageSubresource(vk::ImageAspectFlagBits::eColor, 0, 0), dispatcher);
 
-    if (imageSize == layout.arrayPitch) {
-        memcpy(imageData->data.get(), mappedData, imageSize);
-    } else {
-        auto rowSize = static_cast<uint32_t>(size.width * getPixelStride());
-        for (uint32_t i = 0; i < size.height; ++i) {
-            memcpy(imageData->data.get() + rowSize * i, mappedData + layout.rowPitch * i, rowSize);
+        void* mappedData_ = nullptr;
+        vmaMapMemory(context.getBackend().getAllocator(), imageAllocation->allocation, &mappedData_);
+
+        uint8_t* mappedData = reinterpret_cast<uint8_t*>(mappedData_) + layout.offset;
+
+        if (imageSize == layout.arrayPitch) {
+            memcpy(imageData->data.get(), mappedData, imageSize);
+        } else {
+            auto rowSize = static_cast<uint32_t>(size.width * getPixelStride());
+            for (uint32_t i = 0; i < size.height; ++i) {
+                memcpy(imageData->data.get() + rowSize * i, mappedData + layout.rowPitch * i, rowSize);
+            }
         }
-    }
 
-    vmaUnmapMemory(context.getBackend().getAllocator(), imageAllocation->allocation);
+        vmaUnmapMemory(context.getBackend().getAllocator(), imageAllocation->allocation);
 
-    return imageData;
+        return imageData;
+    } else {
+        // not readable
+        assert(false);
+        return imageData;
+    }
 }
 
 uint32_t Texture2D::getMipLevels() const {