vk_begin_rendering_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 "render_graph/vk_resource_access_info.hh"
#include "vk_node_info.hh"
 
namespace blender::gpu::render_graph {
 
struct VKBeginRenderingData {
  VkRenderingAttachmentInfo color_attachments[8];
  VkRenderingAttachmentInfo depth_attachment;
  VkRenderingAttachmentInfo stencil_attachment;
  VkRenderingInfoKHR vk_rendering_info;
};
 
struct VKBeginRenderingCreateInfo {
  VKBeginRenderingData node_data = {};
  const VKResourceAccessInfo &resources;
  VKBeginRenderingCreateInfo(const VKResourceAccessInfo &resources) : resources(resources) {}
};
 
class VKBeginRenderingNode : public VKNodeInfo<VKNodeType::BEGIN_RENDERING,
                                               VKBeginRenderingCreateInfo,
                                               VKBeginRenderingData,
                                               VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT,
                                               VKResourceType::IMAGE> {
 public:
  template<typename Node> void set_node_data(Node &node, const CreateInfo &create_info)
  {
    BLI_assert_msg(ELEM(create_info.node_data.vk_rendering_info.pColorAttachments,
                        nullptr,
                        create_info.node_data.color_attachments),
                   "When create_info.node_data.vk_rendering_info.pColorAttachments points to "
                   "something, it should point to create_info.node_data.color_attachments.");
    BLI_assert_msg(ELEM(create_info.node_data.vk_rendering_info.pDepthAttachment,
                        nullptr,
                        &create_info.node_data.depth_attachment),
                   "When create_info.node_data.vk_rendering_info.pDepthAttachment points to "
                   "something, it should point to create_info.node_data.depth_attachment.");
    BLI_assert_msg(ELEM(create_info.node_data.vk_rendering_info.pStencilAttachment,
                        nullptr,
                        &create_info.node_data.stencil_attachment),
                   "When create_info.node_data.vk_rendering_info.pStencilAttachment points to "
                   "something, it should point to create_info.node_data.stencil_attachment.");
    node.begin_rendering = create_info.node_data;
    /* NOTE: pointers in vk_rendering_info will be set to the correct location just before sending
     * to the command buffer. In the meantime these pointers are invalid.
     * VKRenderingAttachmentInfo's should be used instead.*/
  }
 
  void build_links(VKResourceStateTracker &resources,
                   VKRenderGraphNodeLinks &node_links,
                   const CreateInfo &create_info) override
  {
    create_info.resources.build_links(resources, node_links);
  }
 
  void build_commands(VKCommandBufferInterface &command_buffer,
                      Data &data,
                      VKBoundPipelines & /*r_bound_pipelines*/) override
  {
    /* Localize pointers just before sending to the command buffer. Pointer can (and will) change
     * as they are stored in a union which is stored in a vector. When the vector reallocates, the
     * pointers will become invalid. */
    if (data.vk_rendering_info.pColorAttachments) {
      data.vk_rendering_info.pColorAttachments = data.color_attachments;
    }
    if (data.vk_rendering_info.pDepthAttachment) {
      data.vk_rendering_info.pDepthAttachment = &data.depth_attachment;
    }
    if (data.vk_rendering_info.pStencilAttachment) {
      data.vk_rendering_info.pStencilAttachment = &data.stencil_attachment;
    }
    command_buffer.begin_rendering(&data.vk_rendering_info);
  }
};
}  // namespace blender::gpu::render_graph