impeller::RenderPassBuilderVK Class Reference

#include <render_pass_builder_vk.h>

Public Member Functions
	RenderPassBuilderVK ()
	~RenderPassBuilderVK ()
	RenderPassBuilderVK (const RenderPassBuilderVK &)=delete
RenderPassBuilderVK &	operator= (const RenderPassBuilderVK &)=delete
RenderPassBuilderVK &	SetColorAttachment (size_t index, PixelFormat format, SampleCount sample_count, LoadAction load_action, StoreAction store_action)
RenderPassBuilderVK &	SetDepthStencilAttachment (PixelFormat format, SampleCount sample_count, LoadAction load_action, StoreAction store_action)
RenderPassBuilderVK &	SetStencilAttachment (PixelFormat format, SampleCount sample_count, LoadAction load_action, StoreAction store_action)
vk::UniqueRenderPass	Build (const vk::Device &device) const
const std::map< size_t, vk::AttachmentDescription > &	GetColorAttachments () const
const std::map< size_t, vk::AttachmentDescription > &	GetResolves () const
const std::optional< vk::AttachmentDescription > &	GetDepthStencil () const

Detailed Description

Definition at line 17 of file render_pass_builder_vk.h.

Constructor & Destructor Documentation

RenderPassBuilderVK() [1/2]

impeller::RenderPassBuilderVK::RenderPassBuilderVK ( )

default

~RenderPassBuilderVK()

impeller::RenderPassBuilderVK::~RenderPassBuilderVK ( )

default

RenderPassBuilderVK() [2/2]

impeller::RenderPassBuilderVK::RenderPassBuilderVK ( const RenderPassBuilderVK &  )

delete

Member Function Documentation

Build()

vk::UniqueRenderPass impeller::RenderPassBuilderVK::Build

(

const vk::Device &

device

)

const

Definition at line 92 of file render_pass_builder_vk.cc.

                                  {
  // This must be less than `VkPhysicalDeviceLimits::maxColorAttachments` but we
  // are not checking.
  const auto color_attachments_count =
      colors_.empty() ? 0u : colors_.rbegin()->first + 1u;
 
  std::vector<vk::AttachmentDescription> attachments;
 
  std::vector<vk::AttachmentReference> color_refs(color_attachments_count,
                                                  kUnusedAttachmentReference);
  std::vector<vk::AttachmentReference> resolve_refs(color_attachments_count,
                                                    kUnusedAttachmentReference);
  vk::AttachmentReference depth_stencil_ref = kUnusedAttachmentReference;
 
  for (const auto& color : colors_) {
    vk::AttachmentReference color_ref;
    color_ref.attachment = attachments.size();
    color_ref.layout = vk::ImageLayout::eGeneral;
    color_refs[color.first] = color_ref;
    attachments.push_back(color.second);
 
    if (auto found = resolves_.find(color.first); found != resolves_.end()) {
      vk::AttachmentReference resolve_ref;
      resolve_ref.attachment = attachments.size();
      resolve_ref.layout = vk::ImageLayout::eGeneral;
      resolve_refs[color.first] = resolve_ref;
      attachments.push_back(found->second);
    }
  }
 
  if (depth_stencil_.has_value()) {
    depth_stencil_ref.attachment = attachments.size();
    depth_stencil_ref.layout = vk::ImageLayout::eGeneral;
    attachments.push_back(depth_stencil_.value());
  }
 
  vk::SubpassDescription subpass0;
  subpass0.pipelineBindPoint = vk::PipelineBindPoint::eGraphics;
  subpass0.setInputAttachments(color_refs);
  subpass0.setColorAttachments(color_refs);
  subpass0.setResolveAttachments(resolve_refs);
  subpass0.setPDepthStencilAttachment(&depth_stencil_ref);
 
  vk::SubpassDependency self_dep;
  self_dep.srcSubpass = 0u;  // first subpass
  self_dep.dstSubpass = 0u;  // to itself
  self_dep.srcStageMask = kSelfDependencySrcStageMask;
  self_dep.srcAccessMask = kSelfDependencySrcAccessMask;
  self_dep.dstStageMask = kSelfDependencyDstStageMask;
  self_dep.dstAccessMask = kSelfDependencyDstAccessMask;
  self_dep.dependencyFlags = kSelfDependencyFlags;
 
  vk::RenderPassCreateInfo render_pass_desc;
  render_pass_desc.setAttachments(attachments);
  render_pass_desc.setSubpasses(subpass0);
  render_pass_desc.setDependencies(self_dep);
 
  auto [result, pass] = device.createRenderPassUnique(render_pass_desc);
  if (result != vk::Result::eSuccess) {
    VALIDATION_LOG << "Failed to create render pass: " << vk::to_string(result);
    return {};
  }
  return std::move(pass);
}

GetColorAttachments()

const std::map< size_t, vk::AttachmentDescription > & impeller::RenderPassBuilderVK::GetColorAttachments

(

)

const

Definition at line 189 of file render_pass_builder_vk.cc.

                                               {
  return colors_;
}

GetDepthStencil()

const std::optional< vk::AttachmentDescription > & impeller::RenderPassBuilderVK::GetDepthStencil

(

)

const

Definition at line 199 of file render_pass_builder_vk.cc.

                                           {
  return depth_stencil_;
}

GetResolves()

const std::map< size_t, vk::AttachmentDescription > & impeller::RenderPassBuilderVK::GetResolves

(

)

const

Definition at line 194 of file render_pass_builder_vk.cc.

                                       {
  return resolves_;
}

operator=()

RenderPassBuilderVK & impeller::RenderPassBuilderVK::operator= ( const RenderPassBuilderVK &  )

delete

SetColorAttachment()

RenderPassBuilderVK & impeller::RenderPassBuilderVK::SetColorAttachment	(	size_t	index,
		PixelFormat	format,
		SampleCount	sample_count,
		LoadAction	load_action,
		StoreAction	store_action
	)

Definition at line 29 of file render_pass_builder_vk.cc.

                              {
  vk::AttachmentDescription desc;
  desc.format = ToVKImageFormat(format);
  desc.samples = ToVKSampleCount(sample_count);
  desc.loadOp = ToVKAttachmentLoadOp(load_action);
  desc.storeOp = ToVKAttachmentStoreOp(store_action, false);
  desc.stencilLoadOp = vk::AttachmentLoadOp::eDontCare;
  desc.stencilStoreOp = vk::AttachmentStoreOp::eDontCare;
  desc.initialLayout = vk::ImageLayout::eGeneral;
  desc.finalLayout = vk::ImageLayout::eGeneral;
  colors_[index] = desc;
 
  if (StoreActionPerformsResolve(store_action)) {
    desc.storeOp = ToVKAttachmentStoreOp(store_action, true);
    desc.samples = vk::SampleCountFlagBits::e1;
    resolves_[index] = desc;
  } else {
    resolves_.erase(index);
  }
  return *this;
}

SetDepthStencilAttachment()

RenderPassBuilderVK & impeller::RenderPassBuilderVK::SetDepthStencilAttachment	(	PixelFormat	format,
		SampleCount	sample_count,
		LoadAction	load_action,
		StoreAction	store_action
	)

Definition at line 56 of file render_pass_builder_vk.cc.

                              {
  vk::AttachmentDescription desc;
  desc.format = ToVKImageFormat(format);
  desc.samples = ToVKSampleCount(sample_count);
  desc.loadOp = ToVKAttachmentLoadOp(load_action);
  desc.storeOp = ToVKAttachmentStoreOp(store_action, false);
  desc.stencilLoadOp = desc.loadOp;    // Not separable in Impeller.
  desc.stencilStoreOp = desc.storeOp;  // Not separable in Impeller.
  desc.initialLayout = vk::ImageLayout::eUndefined;
  desc.finalLayout = vk::ImageLayout::eDepthStencilAttachmentOptimal;
  depth_stencil_ = desc;
  return *this;
}

SetStencilAttachment()

RenderPassBuilderVK & impeller::RenderPassBuilderVK::SetStencilAttachment	(	PixelFormat	format,
		SampleCount	sample_count,
		LoadAction	load_action,
		StoreAction	store_action
	)

Definition at line 74 of file render_pass_builder_vk.cc.

                              {
  vk::AttachmentDescription desc;
  desc.format = ToVKImageFormat(format);
  desc.samples = ToVKSampleCount(sample_count);
  desc.loadOp = vk::AttachmentLoadOp::eDontCare;
  desc.storeOp = vk::AttachmentStoreOp::eDontCare;
  desc.stencilLoadOp = ToVKAttachmentLoadOp(load_action);
  desc.stencilStoreOp = ToVKAttachmentStoreOp(store_action, false);
  desc.initialLayout = vk::ImageLayout::eUndefined;
  desc.finalLayout = vk::ImageLayout::eDepthStencilAttachmentOptimal;
  depth_stencil_ = desc;
  return *this;
}

---

The documentation for this class was generated from the following files:

• impeller/renderer/backend/vulkan/render_pass_builder_vk.h
• impeller/renderer/backend/vulkan/render_pass_builder_vk.cc