vk_copy_image_to_buffer_node.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2024 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "../vk_command_buffer_wrapper.hh"
#include "../vk_render_graph_links.hh"
#include "../vk_resource_state_tracker.hh"
#include "vk_common.hh"
#include "vk_node_info.hh"
 
namespace blender::gpu::render_graph {
struct VKCopyImageToBufferData {
  VkImage src_image;
  VkBuffer dst_buffer;
  VkBufferImageCopy region;
};
 
struct VKCopyImageToBufferCreateInfo {
  VKCopyImageToBufferData node_data;
  VkImageAspectFlags vk_image_aspects;
};
 
class VKCopyImageToBufferNode : public VKNodeInfo<VKNodeType::COPY_IMAGE_TO_BUFFER,
                                                  VKCopyImageToBufferCreateInfo,
                                                  VKCopyImageToBufferData,
                                                  VK_PIPELINE_STAGE_TRANSFER_BIT,
                                                  VKResourceType::IMAGE | VKResourceType::BUFFER> {
 public:
  template<typename Node, typename Storage>
  static void set_node_data(Node &node, Storage &storage, const CreateInfo &create_info)
  {
    node.storage_index = storage.copy_image_to_buffer.append_and_get_index(create_info.node_data);
  }

  void build_links(VKResourceStateTracker &resources,
                   VKRenderGraphNodeLinks &node_links,
                   const CreateInfo &create_info) override
  {
    ResourceWithStamp src_resource = resources.get_image(create_info.node_data.src_image);
    ResourceWithStamp dst_resource = resources.get_buffer_and_increase_stamp(
        create_info.node_data.dst_buffer);
    node_links.inputs.append({src_resource,
                              VK_ACCESS_TRANSFER_READ_BIT,
                              VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,
                              create_info.vk_image_aspects});
    node_links.outputs.append(
        {dst_resource, VK_ACCESS_TRANSFER_WRITE_BIT, VK_IMAGE_LAYOUT_UNDEFINED});
  }

  void build_commands(VKCommandBufferInterface &command_buffer,
                      Data &data,
                      VKBoundPipelines & /*r_bound_pipelines*/) override
  {
    command_buffer.copy_image_to_buffer(
        data.src_image, VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, data.dst_buffer, 1, &data.region);
  }
};
}  // namespace blender::gpu::render_graph