impeller::RenderTarget Class Reference

#include <render_target.h>

Classes
struct	AttachmentConfig
struct	AttachmentConfigMSAA

Public Member Functions
	RenderTarget ()
	~RenderTarget ()
bool	IsValid () const
void	SetupDepthStencilAttachments (const Context &context, Allocator &allocator, ISize size, bool msaa, std::string_view label="Offscreen", RenderTarget::AttachmentConfig stencil_attachment_config=RenderTarget::kDefaultStencilAttachmentConfig, const std::shared_ptr< Texture > &depth_stencil_texture=nullptr)
SampleCount	GetSampleCount () const
bool	HasColorAttachment (size_t index) const
ISize	GetRenderTargetSize () const
std::shared_ptr< Texture >	GetRenderTargetTexture () const
PixelFormat	GetRenderTargetPixelFormat () const
std::optional< ISize >	GetColorAttachmentSize (size_t index) const
RenderTarget &	SetColorAttachment (const ColorAttachment &attachment, size_t index)
ColorAttachment	GetColorAttachment (size_t index) const
	Get the color attachment at [index]. More...
RenderTarget &	SetDepthAttachment (std::optional< DepthAttachment > attachment)
RenderTarget &	SetStencilAttachment (std::optional< StencilAttachment > attachment)
size_t	GetMaxColorAttachmentBindIndex () const
const std::optional< DepthAttachment > &	GetDepthAttachment () const
const std::optional< StencilAttachment > &	GetStencilAttachment () const
size_t	GetTotalAttachmentCount () const
bool	IterateAllColorAttachments (const std::function< bool(size_t index, const ColorAttachment &attachment)> &iterator) const
void	IterateAllAttachments (const std::function< bool(const Attachment &attachment)> &iterator) const
std::string	ToString () const
RenderTargetConfig	ToConfig () const

Static Public Attributes
static constexpr AttachmentConfig	kDefaultColorAttachmentConfig
static constexpr AttachmentConfigMSAA	kDefaultColorAttachmentConfigMSAA
static constexpr AttachmentConfig	kDefaultStencilAttachmentConfig

Detailed Description

Definition at line 38 of file render_target.h.

Constructor & Destructor Documentation

RenderTarget()

impeller::RenderTarget::RenderTarget ( )

default

~RenderTarget()

impeller::RenderTarget::~RenderTarget ( )

default

Member Function Documentation

GetColorAttachment()

ColorAttachment impeller::RenderTarget::GetColorAttachment

(

size_t

index

)

const

Get the color attachment at [index].

This function does not validate whether or not the attachment was previously defined and will return a default constructed attachment if none is set.

Definition at line 248 of file render_target.cc.

                                                                   {
  if (index == 0) {
    if (color0_.has_value()) {
      return color0_.value();
    }
    return ColorAttachment{};
  }
  std::map<size_t, ColorAttachment>::const_iterator it = colors_.find(index);
  if (it != colors_.end()) {
    return it->second;
  }
  return ColorAttachment{};
}

Referenced by impeller::EntityPassTarget::Flip(), impeller::InlinePassContext::GetRenderPass(), impeller::Playground::OpenPlaygroundHere(), and impeller::testing::TEST_P().

GetColorAttachmentSize()

std::optional< ISize > impeller::RenderTarget::GetColorAttachmentSize

(

size_t

index

)

const

Definition at line 169 of file render_target.cc.

                                                                          {
  if (index == 0u) {
    if (color0_.has_value()) {
      return SizeForMipLevel(color0_.value().texture,
                             color0_.value().mip_level);
    }
    return std::nullopt;
  }
  auto found = colors_.find(index);
 
  if (found == colors_.end()) {
    return std::nullopt;
  }
 
  return SizeForMipLevel(found->second.texture, found->second.mip_level);
}

References impeller::SizeForMipLevel().

Referenced by GetRenderTargetSize(), and impeller::Surface::Surface().

GetDepthAttachment()

const std::optional< DepthAttachment > & impeller::RenderTarget::GetDepthAttachment

(

)

const

Definition at line 262 of file render_target.cc.

                                                                           {
  return depth_;
}

Referenced by impeller::InlinePassContext::GetRenderPass(), impeller::GetVKClearValues(), impeller::ContextVK::InitializeCommonlyUsedShadersIfNeeded(), impeller::testing::TEST_P(), and impeller::ToMTLRenderPassDescriptor().

GetMaxColorAttachmentBindIndex()

size_t impeller::RenderTarget::GetMaxColorAttachmentBindIndex

(

)

const

Definition at line 206 of file render_target.cc.

                                                          {
  size_t max = 0;
  for (const auto& color : colors_) {
    max = std::max(color.first, max);
  }
  return max;
}

GetRenderTargetPixelFormat()

PixelFormat impeller::RenderTarget::GetRenderTargetPixelFormat

(

)

const

Definition at line 198 of file render_target.cc.

                                                           {
  if (auto texture = GetRenderTargetTexture(); texture != nullptr) {
    return texture->GetTextureDescriptor().format;
  }
 
  return PixelFormat::kUnknown;
}

References GetRenderTargetTexture(), and impeller::kUnknown.

GetRenderTargetSize()

ISize impeller::RenderTarget::GetRenderTargetSize

(

)

const

Definition at line 186 of file render_target.cc.

                                              {
  auto size = GetColorAttachmentSize(0u);
  return size.has_value() ? size.value() : ISize{};
}

References GetColorAttachmentSize().

Referenced by impeller::Canvas::GetLocalCoverageLimit(), impeller::AiksPlayground::OpenPlaygroundHere(), impeller::DlPlayground::OpenPlaygroundHere(), and impeller::testing::TEST_P().

GetRenderTargetTexture()

std::shared_ptr< Texture > impeller::RenderTarget::GetRenderTargetTexture

(

)

const

Definition at line 191 of file render_target.cc.

                                                                  {
  if (!color0_.has_value()) {
    return nullptr;
  }
  return color0_->resolve_texture ? color0_->resolve_texture : color0_->texture;
}

Referenced by impeller::DisplayListToTexture(), impeller::InlinePassContext::EndPass(), impeller::EntityPassTarget::Flip(), GetRenderTargetPixelFormat(), impeller::InlinePassContext::GetTexture(), impeller::ContentContext::MakeSubpass(), and impeller::GoldenPlaygroundTest::OpenPlaygroundHere().

GetSampleCount()

SampleCount impeller::RenderTarget::GetSampleCount

(

)

const

Definition at line 152 of file render_target.cc.

                                               {
  if (color0_.has_value()) {
    return color0_.value().texture->GetTextureDescriptor().sample_count;
  }
  return SampleCount::kCount1;
}

References impeller::kCount1.

GetStencilAttachment()

const std::optional< StencilAttachment > & impeller::RenderTarget::GetStencilAttachment

(

)

const

Definition at line 266 of file render_target.cc.

          {
  return stencil_;
}

Referenced by impeller::InlinePassContext::GetRenderPass(), impeller::GetVKClearValues(), impeller::ContextVK::InitializeCommonlyUsedShadersIfNeeded(), and impeller::ToMTLRenderPassDescriptor().

GetTotalAttachmentCount()

size_t impeller::RenderTarget::GetTotalAttachmentCount

(

)

const

Definition at line 271 of file render_target.cc.

                                                   {
  size_t count = 0u;
  for (const auto& [_, color] : colors_) {
    if (color.texture) {
      count++;
    }
    if (color.resolve_texture) {
      count++;
    }
  }
  if (color0_.has_value()) {
    count++;
  }
  if (depth_.has_value()) {
    count++;
  }
  if (stencil_.has_value()) {
    count++;
  }
  return count;
}

HasColorAttachment()

bool impeller::RenderTarget::HasColorAttachment

(

size_t

index

)

const

Definition at line 159 of file render_target.cc.

                                                        {
  if (index == 0u) {
    return color0_.has_value();
  }
  if (auto found = colors_.find(index); found != colors_.end()) {
    return true;
  }
  return false;
}

Referenced by IsValid().

IsValid()

bool impeller::RenderTarget::IsValid

(

)

const

Definition at line 35 of file render_target.cc.

                                 {
  // Validate that there is a color attachment at zero index.
  if (!HasColorAttachment(0u)) {
    VALIDATION_LOG
        << "Render target does not have color attachment at index 0.";
    return false;
  }
 
#ifndef NDEBUG
  // Validate that all attachments are of the same size.
  {
    std::optional<ISize> size;
    bool sizes_are_same = true;
    auto iterator = [&](const Attachment& attachment) -> bool {
      ISize attachment_size =
          SizeForMipLevel(attachment.texture, attachment.mip_level);
      if (!size.has_value()) {
        size = attachment_size;
      }
      if (size != attachment_size) {
        sizes_are_same = false;
        return false;
      }
      return true;
    };
    IterateAllAttachments(iterator);
    if (!sizes_are_same) {
      VALIDATION_LOG
          << "Sizes of all render target attachments are not the same.";
      return false;
    }
  }
 
  // Validate that all attachments are of the same type and sample counts.
  {
    std::optional<TextureType> texture_type;
    std::optional<SampleCount> sample_count;
    bool passes_type_validation = true;
    auto iterator = [&](const Attachment& attachment) -> bool {
      if (!texture_type.has_value() || !sample_count.has_value()) {
        texture_type = attachment.texture->GetTextureDescriptor().type;
        sample_count = attachment.texture->GetTextureDescriptor().sample_count;
      }
 
      if (texture_type != attachment.texture->GetTextureDescriptor().type) {
        passes_type_validation = false;
        VALIDATION_LOG << "Render target has incompatible texture types: "
                       << TextureTypeToString(texture_type.value()) << " != "
                       << TextureTypeToString(
                              attachment.texture->GetTextureDescriptor().type)
                       << " on target " << ToString();
        return false;
      }
 
      if (sample_count !=
          attachment.texture->GetTextureDescriptor().sample_count) {
        passes_type_validation = false;
        VALIDATION_LOG << "Render target (" << ToString()
                       << ") has incompatible sample counts.";
 
        return false;
      }
 
      return true;
    };
    IterateAllAttachments(iterator);
    if (!passes_type_validation) {
      return false;
    }
  }
#endif  // NDEBUG
 
  return true;
}

References HasColorAttachment(), IterateAllAttachments(), impeller::SizeForMipLevel(), impeller::TextureTypeToString(), ToString(), and VALIDATION_LOG.

Referenced by impeller::RenderTargetCache::CreateOffscreen(), impeller::RenderTargetCache::CreateOffscreenMSAA(), impeller::DisplayListToTexture(), impeller::EntityPassTarget::IsValid(), impeller::GoldenPlaygroundTest::OpenPlaygroundHere(), and impeller::testing::TEST_P().

IterateAllAttachments()

void impeller::RenderTarget::IterateAllAttachments

(

const std::function< bool(const Attachment &attachment)> &

iterator

)

const

Definition at line 126 of file render_target.cc.

                                                                           {
  if (color0_.has_value()) {
    if (!iterator(color0_.value())) {
      return;
    }
  }
  for (const auto& color : colors_) {
    if (!iterator(color.second)) {
      return;
    }
  }
 
  if (depth_.has_value()) {
    if (!iterator(depth_.value())) {
      return;
    }
  }
 
  if (stencil_.has_value()) {
    if (!iterator(stencil_.value())) {
      return;
    }
  }
}

Referenced by IsValid().

IterateAllColorAttachments()

bool impeller::RenderTarget::IterateAllColorAttachments

(

const std::function< bool(size_t index, const ColorAttachment &attachment)> &

iterator

)

const

Definition at line 110 of file render_target.cc.

                        {
  if (color0_.has_value()) {
    if (!iterator(0, color0_.value())) {
      return false;
    }
  }
  for (const auto& [index, attachment] : colors_) {
    if (!iterator(index, attachment)) {
      return false;
    }
  }
  return true;
}

Referenced by impeller::GetVKClearValues(), impeller::ContextVK::InitializeCommonlyUsedShadersIfNeeded(), and impeller::ToMTLRenderPassDescriptor().

SetColorAttachment()

RenderTarget & impeller::RenderTarget::SetColorAttachment	(	const ColorAttachment &	attachment,
		size_t	index
	)

Definition at line 214 of file render_target.cc.

                  {
  if (!attachment.IsValid()) {
    return *this;
  }
  if (index == 0u) {
    color0_ = attachment;
  } else {
    colors_[index] = attachment;
  }
  return *this;
}

References impeller::Attachment::IsValid().

Referenced by impeller::RenderTargetAllocator::CreateOffscreen(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::testing::RenderPassGLESCommandTest::CreateRenderPassGLESContext(), impeller::testing::CreateTestCanvas(), impeller::EntityPassTarget::Flip(), impeller::InlinePassContext::GetRenderPass(), impeller::Playground::OpenPlaygroundHere(), impeller::testing::TEST_P(), impeller::SurfaceGLES::WrapFBO(), impeller::SurfaceVK::WrapSwapchainImage(), and impeller::WrapTextureWithRenderTarget().

SetDepthAttachment()

RenderTarget & impeller::RenderTarget::SetDepthAttachment

(

std::optional< DepthAttachment >

attachment

)

Definition at line 228 of file render_target.cc.

                                             {
  if (!attachment.has_value()) {
    depth_ = std::nullopt;
  } else if (attachment->IsValid()) {
    depth_ = std::move(attachment);
  }
  return *this;
}

Referenced by impeller::RenderTargetAllocator::CreateOffscreen(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::InlinePassContext::GetRenderPass(), impeller::Playground::OpenPlaygroundHere(), SetupDepthStencilAttachments(), impeller::testing::TEST_P(), impeller::SurfaceGLES::WrapFBO(), and impeller::WrapTextureWithRenderTarget().

SetStencilAttachment()

RenderTarget & impeller::RenderTarget::SetStencilAttachment

(

std::optional< StencilAttachment >

attachment

)

Definition at line 238 of file render_target.cc.

                                               {
  if (!attachment.has_value()) {
    stencil_ = std::nullopt;
  } else if (attachment->IsValid()) {
    stencil_ = std::move(attachment);
  }
  return *this;
}

Referenced by impeller::RenderTargetAllocator::CreateOffscreen(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), impeller::InlinePassContext::GetRenderPass(), impeller::Playground::OpenPlaygroundHere(), SetupDepthStencilAttachments(), impeller::testing::TEST_P(), impeller::SurfaceGLES::WrapFBO(), and impeller::WrapTextureWithRenderTarget().

SetupDepthStencilAttachments()

void impeller::RenderTarget::SetupDepthStencilAttachments	(	const Context &	context,
		Allocator &	allocator,
		ISize	size,
		bool	msaa,
		std::string_view	label = "Offscreen",
		RenderTarget::AttachmentConfig	stencil_attachment_config = RenderTarget::kDefaultStencilAttachmentConfig,
		const std::shared_ptr< Texture > &	depth_stencil_texture = nullptr
	)

Definition at line 496 of file render_target.cc.

                                                                  {
  std::shared_ptr<Texture> depth_stencil_texture;
  if (existing_depth_stencil_texture) {
    depth_stencil_texture = existing_depth_stencil_texture;
  } else {
    TextureDescriptor depth_stencil_texture_desc;
    depth_stencil_texture_desc.storage_mode =
        stencil_attachment_config.storage_mode;
    if (msaa) {
      depth_stencil_texture_desc.type = TextureType::kTexture2DMultisample;
      depth_stencil_texture_desc.sample_count = SampleCount::kCount4;
    }
    depth_stencil_texture_desc.format =
        context.GetCapabilities()->GetDefaultDepthStencilFormat();
    depth_stencil_texture_desc.size = size;
    depth_stencil_texture_desc.usage = TextureUsage::kRenderTarget;
    depth_stencil_texture = allocator.CreateTexture(depth_stencil_texture_desc);
    if (!depth_stencil_texture) {
      return;  // Error messages are handled by `Allocator::CreateTexture`.
    }
  }
 
  DepthAttachment depth0;
  depth0.load_action = stencil_attachment_config.load_action;
  depth0.store_action = stencil_attachment_config.store_action;
  depth0.clear_depth = 0u;
  depth0.texture = depth_stencil_texture;
 
  StencilAttachment stencil0;
  stencil0.load_action = stencil_attachment_config.load_action;
  stencil0.store_action = stencil_attachment_config.store_action;
  stencil0.clear_stencil = 0u;
  stencil0.texture = std::move(depth_stencil_texture);
  stencil0.texture->SetLabel(label, "Depth+Stencil Texture");
 
  SetDepthAttachment(std::move(depth0));
  SetStencilAttachment(std::move(stencil0));
}

References impeller::DepthAttachment::clear_depth, impeller::StencilAttachment::clear_stencil, context, impeller::Allocator::CreateTexture(), impeller::TextureDescriptor::format, impeller::kCount4, impeller::kRenderTarget, impeller::kTexture2DMultisample, impeller::Attachment::load_action, impeller::RenderTarget::AttachmentConfig::load_action, impeller::TextureDescriptor::sample_count, SetDepthAttachment(), SetStencilAttachment(), impeller::TextureDescriptor::size, impeller::TextureDescriptor::storage_mode, impeller::RenderTarget::AttachmentConfig::storage_mode, impeller::Attachment::store_action, impeller::RenderTarget::AttachmentConfig::store_action, impeller::Attachment::texture, impeller::TextureDescriptor::type, and impeller::TextureDescriptor::usage.

Referenced by impeller::RenderTargetAllocator::CreateOffscreen(), impeller::RenderTargetAllocator::CreateOffscreenMSAA(), and impeller::SurfaceVK::WrapSwapchainImage().

ToConfig()

RenderTargetConfig impeller::RenderTarget::ToConfig

(

)

const

Definition at line 317 of file render_target.cc.

                                                {
  if (!color0_.has_value()) {
    return RenderTargetConfig{};
  }
  const auto& color_attachment = color0_.value();
  return RenderTargetConfig{
      .size = color_attachment.texture->GetSize(),
      .mip_count = color_attachment.texture->GetMipCount(),
      .has_msaa = color_attachment.resolve_texture != nullptr,
      .has_depth_stencil = depth_.has_value() && stencil_.has_value()};
}

References impeller::RenderTargetConfig::size.

ToString()

std::string impeller::RenderTarget::ToString

(

)

const

Definition at line 293 of file render_target.cc.

                                       {
  std::stringstream stream;
 
  if (color0_.has_value()) {
    stream << std::format("Color[{}]=({})", 0,
                          ColorAttachmentToString(color0_.value()));
  }
  for (const auto& [index, color] : colors_) {
    stream << std::format("Color[{}]=({})", index,
                          ColorAttachmentToString(color));
  }
  if (depth_) {
    stream << ",";
    stream << std::format("Depth=({})",
                          DepthAttachmentToString(depth_.value()));
  }
  if (stencil_) {
    stream << ",";
    stream << std::format("Stencil=({})",
                          StencilAttachmentToString(stencil_.value()));
  }
  return stream.str();
}

References impeller::ColorAttachmentToString(), impeller::DepthAttachmentToString(), and impeller::StencilAttachmentToString().

Referenced by IsValid().

Member Data Documentation

kDefaultColorAttachmentConfig

constexpr AttachmentConfig impeller::RenderTarget::kDefaultColorAttachmentConfig

staticconstexpr

Initial value:

= {
      .storage_mode = StorageMode::kDevicePrivate,
      .load_action = LoadAction::kClear,
      .store_action = StoreAction::kStore,
      .clear_color = Color::BlackTransparent()}

Definition at line 55 of file render_target.h.

Referenced by impeller::ContentContext::MakeSubpass(), impeller::GoldenPlaygroundTest::OpenPlaygroundHere(), and impeller::testing::TEST_P().

kDefaultColorAttachmentConfigMSAA

constexpr AttachmentConfigMSAA impeller::RenderTarget::kDefaultColorAttachmentConfigMSAA

staticconstexpr

Initial value:

= {
      .storage_mode = StorageMode::kDeviceTransient,
      .resolve_storage_mode = StorageMode::kDevicePrivate,
      .load_action = LoadAction::kClear,
      .store_action = StoreAction::kMultisampleResolve,
      .clear_color = Color::BlackTransparent()}

Definition at line 61 of file render_target.h.

Referenced by impeller::ContentContext::MakeSubpass().

kDefaultStencilAttachmentConfig

constexpr AttachmentConfig impeller::RenderTarget::kDefaultStencilAttachmentConfig

staticconstexpr

Initial value:

= {
      .storage_mode = StorageMode::kDeviceTransient,
      .load_action = LoadAction::kClear,
      .store_action = StoreAction::kDontCare,
      .clear_color = Color::BlackTransparent()}

Definition at line 68 of file render_target.h.

Referenced by impeller::ContentContext::MakeSubpass(), impeller::SurfaceVK::WrapSwapchainImage(), and impeller::WrapTextureWithRenderTarget().

---

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

• impeller/renderer/render_target.h
• impeller/renderer/render_target.cc