Shorten names of the render target attachment descriptors.

chinmaygarde · dnfield · commit e95252f063a2 · 2022-04-27T15:57:33.000-07:00
diff --git a/impeller/playground/playground.mm b/impeller/playground/playground.mm
@@ -140,14 +140,14 @@ static void PlaygroundKeyCallback(GLFWwindow* window,
         static_cast<ISize::Type>(current_drawable.texture.width),
         static_cast<ISize::Type>(current_drawable.texture.height)};
 
-    RenderPassColorAttachment color0;
+    ColorAttachment color0;
     color0.texture =
         std::make_shared<TextureMTL>(color0_desc, current_drawable.texture);
     color0.clear_color = Color::SkyBlue();
     color0.load_action = LoadAction::kClear;
     color0.store_action = StoreAction::kStore;
 
-    RenderPassDescriptor desc;
+    RenderTarget desc;
     desc.SetColorAttachment(color0, 0u);
 
     Surface surface(desc);
diff --git a/impeller/renderer/backend/metal/command_buffer_mtl.h b/impeller/renderer/backend/metal/command_buffer_mtl.h
@@ -34,7 +34,7 @@ class CommandBufferMTL final : public CommandBuffer {
 
   // |CommandBuffer|
   std::shared_ptr<RenderPass> CreateRenderPass(
-      const RenderPassDescriptor& desc) const override;
+      const RenderTarget& desc) const override;
 
   FML_DISALLOW_COPY_AND_ASSIGN(CommandBufferMTL);
 };
diff --git a/impeller/renderer/backend/metal/command_buffer_mtl.mm b/impeller/renderer/backend/metal/command_buffer_mtl.mm
@@ -53,7 +53,7 @@
 }
 
 std::shared_ptr<RenderPass> CommandBufferMTL::CreateRenderPass(
-    const RenderPassDescriptor& desc) const {
+    const RenderTarget& desc) const {
   if (!buffer_) {
     return nullptr;
   }
diff --git a/impeller/renderer/backend/metal/formats_mtl.h b/impeller/renderer/backend/metal/formats_mtl.h
@@ -15,7 +15,7 @@
 
 namespace impeller {
 
-class RenderPassDescriptor;
+class RenderTarget;
 
 constexpr MTLPixelFormat ToMTLPixelFormat(PixelFormat format) {
   switch (format) {
diff --git a/impeller/renderer/backend/metal/render_pass_mtl.h b/impeller/renderer/backend/metal/render_pass_mtl.h
@@ -27,7 +27,7 @@ class RenderPassMTL final : public RenderPass {
   std::string label_;
   bool is_valid_ = false;
 
-  RenderPassMTL(id<MTLCommandBuffer> buffer, const RenderPassDescriptor& desc);
+  RenderPassMTL(id<MTLCommandBuffer> buffer, const RenderTarget& desc);
 
   // |RenderPass|
   bool IsValid() const override;
diff --git a/impeller/renderer/backend/metal/render_pass_mtl.mm b/impeller/renderer/backend/metal/render_pass_mtl.mm
@@ -17,7 +17,7 @@
 
 namespace impeller {
 
-static bool ConfigureAttachment(const RenderPassAttachment& desc,
+static bool ConfigureAttachment(const Attachment& desc,
                                 MTLRenderPassAttachmentDescriptor* attachment) {
   if (!desc.texture) {
     return false;
@@ -30,7 +30,7 @@ static bool ConfigureAttachment(const RenderPassAttachment& desc,
 }
 
 static bool ConfigureColorAttachment(
-    const RenderPassColorAttachment& desc,
+    const ColorAttachment& desc,
     MTLRenderPassColorAttachmentDescriptor* attachment) {
   if (!ConfigureAttachment(desc, attachment)) {
     return false;
@@ -40,7 +40,7 @@ static bool ConfigureColorAttachment(
 }
 
 static bool ConfigureDepthAttachment(
-    const RenderPassDepthAttachment& desc,
+    const DepthAttachment& desc,
     MTLRenderPassDepthAttachmentDescriptor* attachment) {
   if (!ConfigureAttachment(desc, attachment)) {
     return false;
@@ -50,7 +50,7 @@ static bool ConfigureDepthAttachment(
 }
 
 static bool ConfigureStencilAttachment(
-    const RenderPassStencilAttachment& desc,
+    const StencilAttachment& desc,
     MTLRenderPassStencilAttachmentDescriptor* attachment) {
   if (!ConfigureAttachment(desc, attachment)) {
     return false;
@@ -61,7 +61,7 @@ static bool ConfigureStencilAttachment(
 
 // TODO(csg): Move this to formats_mtl.h
 static MTLRenderPassDescriptor* ToMTLRenderPassDescriptor(
-    const RenderPassDescriptor& desc) {
+    const RenderTarget& desc) {
   auto result = [MTLRenderPassDescriptor renderPassDescriptor];
 
   const auto& colors = desc.GetColorAttachments();
@@ -93,7 +93,7 @@ static bool ConfigureStencilAttachment(
 }
 
 RenderPassMTL::RenderPassMTL(id<MTLCommandBuffer> buffer,
-                             const RenderPassDescriptor& desc)
+                             const RenderTarget& desc)
     : buffer_(buffer),
       desc_(ToMTLRenderPassDescriptor(desc)),
       transients_buffer_(HostBuffer::Create()) {
diff --git a/impeller/renderer/command_buffer.h b/impeller/renderer/command_buffer.h
@@ -13,7 +13,7 @@ namespace impeller {
 
 class Context;
 class RenderPass;
-class RenderPassDescriptor;
+class RenderTarget;
 
 //------------------------------------------------------------------------------
 /// @brief      A collection of encoded commands to be submitted to the GPU for
@@ -59,7 +59,7 @@ class CommandBuffer {
   /// @return     A valid render pass or null.
   ///
   virtual std::shared_ptr<RenderPass> CreateRenderPass(
-      const RenderPassDescriptor& desc) const = 0;
+      const RenderTarget& desc) const = 0;
 
  protected:
   CommandBuffer();
diff --git a/impeller/renderer/formats.h b/impeller/renderer/formats.h
@@ -319,23 +319,23 @@ struct PipelineStencilAttachment {
   }
 };
 
-struct RenderPassAttachment {
+struct Attachment {
   std::shared_ptr<Texture> texture = nullptr;
   LoadAction load_action = LoadAction::kDontCare;
   StoreAction store_action = StoreAction::kStore;
 
   constexpr operator bool() const { return static_cast<bool>(texture); }
 };
 
-struct RenderPassColorAttachment : public RenderPassAttachment {
+struct ColorAttachment : public Attachment {
   Color clear_color = Color::BlackTransparent();
 };
 
-struct RenderPassDepthAttachment : public RenderPassAttachment {
+struct DepthAttachment : public Attachment {
   double clear_depth = 0.0;
 };
 
-struct RenderPassStencilAttachment : public RenderPassAttachment {
+struct StencilAttachment : public Attachment {
   uint32_t clear_stencil = 0;
 };
 
diff --git a/impeller/renderer/render_pass.h b/impeller/renderer/render_pass.h
@@ -13,6 +13,13 @@ namespace impeller {
 class HostBuffer;
 class Allocator;
 
+//------------------------------------------------------------------------------
+/// @brief      Render passes encode render commands directed as one specific
+///             render target into an underlying command buffer.
+///
+///             Render passes can be obtained from the command buffer in which
+///             the pass is meant to encode commands into.
+///
 class RenderPass {
  public:
   virtual ~RenderPass();
diff --git a/impeller/renderer/render_pass_descriptor.cc b/impeller/renderer/render_pass_descriptor.cc
@@ -8,19 +8,18 @@
 
 namespace impeller {
 
-RenderPassDescriptor::RenderPassDescriptor() = default;
+RenderTarget::RenderTarget() = default;
 
-RenderPassDescriptor::~RenderPassDescriptor() = default;
+RenderTarget::~RenderTarget() = default;
 
-bool RenderPassDescriptor::HasColorAttachment(size_t index) const {
+bool RenderTarget::HasColorAttachment(size_t index) const {
   if (auto found = colors_.find(index); found != colors_.end()) {
     return true;
   }
   return false;
 }
 
-std::optional<ISize> RenderPassDescriptor::GetColorAttachmentSize(
-    size_t index) const {
+std::optional<ISize> RenderTarget::GetColorAttachmentSize(size_t index) const {
   auto found = colors_.find(index);
 
   if (found == colors_.end()) {
@@ -30,43 +29,39 @@ std::optional<ISize> RenderPassDescriptor::GetColorAttachmentSize(
   return found->second.texture->GetSize();
 }
 
-RenderPassDescriptor& RenderPassDescriptor::SetColorAttachment(
-    RenderPassColorAttachment attachment,
-    size_t index) {
+RenderTarget& RenderTarget::SetColorAttachment(ColorAttachment attachment,
+                                               size_t index) {
   if (attachment) {
     colors_[index] = attachment;
   }
   return *this;
 }
 
-RenderPassDescriptor& RenderPassDescriptor::SetDepthAttachment(
-    RenderPassDepthAttachment attachment) {
+RenderTarget& RenderTarget::SetDepthAttachment(DepthAttachment attachment) {
   if (attachment) {
     depth_ = std::move(attachment);
   }
   return *this;
 }
 
-RenderPassDescriptor& RenderPassDescriptor::SetStencilAttachment(
-    RenderPassStencilAttachment attachment) {
+RenderTarget& RenderTarget::SetStencilAttachment(StencilAttachment attachment) {
   if (attachment) {
     stencil_ = std::move(attachment);
   }
   return *this;
 }
 
-const std::map<size_t, RenderPassColorAttachment>&
-RenderPassDescriptor::GetColorAttachments() const {
+const std::map<size_t, ColorAttachment>& RenderTarget::GetColorAttachments()
+    const {
   return colors_;
 }
 
-const std::optional<RenderPassDepthAttachment>&
-RenderPassDescriptor::GetDepthAttachment() const {
+const std::optional<DepthAttachment>& RenderTarget::GetDepthAttachment() const {
   return depth_;
 }
 
-const std::optional<RenderPassStencilAttachment>&
-RenderPassDescriptor::GetStencilAttachment() const {
+const std::optional<StencilAttachment>& RenderTarget::GetStencilAttachment()
+    const {
   return stencil_;
 }
 
diff --git a/impeller/renderer/render_pass_descriptor.h b/impeller/renderer/render_pass_descriptor.h
@@ -13,37 +13,32 @@
 
 namespace impeller {
 
-class RenderPassDescriptor {
+class RenderTarget {
  public:
-  RenderPassDescriptor();
+  RenderTarget();
 
-  ~RenderPassDescriptor();
+  ~RenderTarget();
 
   bool HasColorAttachment(size_t index) const;
 
   std::optional<ISize> GetColorAttachmentSize(size_t index) const;
 
-  RenderPassDescriptor& SetColorAttachment(RenderPassColorAttachment attachment,
-                                           size_t index);
+  RenderTarget& SetColorAttachment(ColorAttachment attachment, size_t index);
 
-  RenderPassDescriptor& SetDepthAttachment(
-      RenderPassDepthAttachment attachment);
+  RenderTarget& SetDepthAttachment(DepthAttachment attachment);
 
-  RenderPassDescriptor& SetStencilAttachment(
-      RenderPassStencilAttachment attachment);
+  RenderTarget& SetStencilAttachment(StencilAttachment attachment);
 
-  const std::map<size_t, RenderPassColorAttachment>& GetColorAttachments()
-      const;
+  const std::map<size_t, ColorAttachment>& GetColorAttachments() const;
 
-  const std::optional<RenderPassDepthAttachment>& GetDepthAttachment() const;
+  const std::optional<DepthAttachment>& GetDepthAttachment() const;
 
-  const std::optional<RenderPassStencilAttachment>& GetStencilAttachment()
-      const;
+  const std::optional<StencilAttachment>& GetStencilAttachment() const;
 
  private:
-  std::map<size_t, RenderPassColorAttachment> colors_;
-  std::optional<RenderPassDepthAttachment> depth_;
-  std::optional<RenderPassStencilAttachment> stencil_;
+  std::map<size_t, ColorAttachment> colors_;
+  std::optional<DepthAttachment> depth_;
+  std::optional<StencilAttachment> stencil_;
 };
 
 }  // namespace impeller
diff --git a/impeller/renderer/renderer_unittests.cc b/impeller/renderer/renderer_unittests.cc
@@ -198,7 +198,7 @@ TEST_F(RendererTest, CanRenderToTexture) {
   std::shared_ptr<RenderPass> r2t_pass;
 
   {
-    RenderPassColorAttachment color0;
+    ColorAttachment color0;
     color0.load_action = LoadAction::kClear;
     color0.store_action = StoreAction::kStore;
 
@@ -218,7 +218,7 @@ TEST_F(RendererTest, CanRenderToTexture) {
 
     color0.texture->SetLabel("r2t_target");
 
-    RenderPassDescriptor r2t_desc;
+    RenderTarget r2t_desc;
     r2t_desc.SetColorAttachment(color0, 0u);
     auto cmd_buffer = context->CreateRenderCommandBuffer();
     r2t_pass = cmd_buffer->CreateRenderPass(r2t_desc);
diff --git a/impeller/renderer/surface.cc b/impeller/renderer/surface.cc
@@ -8,8 +8,7 @@
 
 namespace impeller {
 
-Surface::Surface(RenderPassDescriptor target_desc)
-    : desc_(std::move(target_desc)) {
+Surface::Surface(RenderTarget target_desc) : desc_(std::move(target_desc)) {
   if (auto size = desc_.GetColorAttachmentSize(0u); size.has_value()) {
     size_ = size.value();
   } else {
@@ -29,7 +28,7 @@ bool Surface::IsValid() const {
   return is_valid_;
 }
 
-const RenderPassDescriptor& Surface::GetTargetRenderPassDescriptor() const {
+const RenderTarget& Surface::GetTargetRenderPassDescriptor() const {
   return desc_;
 }
 
diff --git a/impeller/renderer/surface.h b/impeller/renderer/surface.h
@@ -16,18 +16,18 @@ namespace impeller {
 
 class Surface {
  public:
-  Surface(RenderPassDescriptor target_desc);
+  Surface(RenderTarget target_desc);
 
   ~Surface();
 
   const ISize& GetSize() const;
 
   bool IsValid() const;
 
-  const RenderPassDescriptor& GetTargetRenderPassDescriptor() const;
+  const RenderTarget& GetTargetRenderPassDescriptor() const;
 
  private:
-  RenderPassDescriptor desc_;
+  RenderTarget desc_;
   ISize size_;
 
   bool is_valid_ = false;

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`std::shared_ptr<RenderPass> CommandBufferMTL::CreateRenderPass(`
`56`		`- const RenderPassDescriptor& desc) const {`
	`56`	`+ const RenderTarget& desc) const {`
`57`	`57`	`if (!buffer_) {`
`58`	`58`	`return nullptr;`
`59`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,19 +8,18 @@`
`8`	`8`
`9`	`9`	`namespace impeller {`
`10`	`10`
`11`		`-RenderPassDescriptor::RenderPassDescriptor() = default;`
	`11`	`+RenderTarget::RenderTarget() = default;`
`12`	`12`
`13`		`-RenderPassDescriptor::~RenderPassDescriptor() = default;`
	`13`	`+RenderTarget::~RenderTarget() = default;`
`14`	`14`
`15`		`-bool RenderPassDescriptor::HasColorAttachment(size_t index) const {`
	`15`	`+bool RenderTarget::HasColorAttachment(size_t index) const {`
`16`	`16`	`if (auto found = colors_.find(index); found != colors_.end()) {`
`17`	`17`	`return true;`
`18`	`18`	`}`
`19`	`19`	`return false;`
`20`	`20`	`}`
`21`	`21`
`22`		`-std::optional<ISize> RenderPassDescriptor::GetColorAttachmentSize(`
`23`		`- size_t index) const {`
	`22`	`+std::optional<ISize> RenderTarget::GetColorAttachmentSize(size_t index) const {`
`24`	`23`	`auto found = colors_.find(index);`
`25`	`24`
`26`	`25`	`if (found == colors_.end()) {`
`@@ -30,43 +29,39 @@ std::optional<ISize> RenderPassDescriptor::GetColorAttachmentSize(`
`30`	`29`	`return found->second.texture->GetSize();`
`31`	`30`	`}`
`32`	`31`
`33`		`-RenderPassDescriptor& RenderPassDescriptor::SetColorAttachment(`
`34`		`- RenderPassColorAttachment attachment,`
`35`		`- size_t index) {`
	`32`	`+RenderTarget& RenderTarget::SetColorAttachment(ColorAttachment attachment,`
	`33`	`+ size_t index) {`
`36`	`34`	`if (attachment) {`
`37`	`35`	`colors_[index] = attachment;`
`38`	`36`	`}`
`39`	`37`	`return *this;`
`40`	`38`	`}`
`41`	`39`
`42`		`-RenderPassDescriptor& RenderPassDescriptor::SetDepthAttachment(`
`43`		`- RenderPassDepthAttachment attachment) {`
	`40`	`+RenderTarget& RenderTarget::SetDepthAttachment(DepthAttachment attachment) {`
`44`	`41`	`if (attachment) {`
`45`	`42`	`depth_ = std::move(attachment);`
`46`	`43`	`}`
`47`	`44`	`return *this;`
`48`	`45`	`}`
`49`	`46`
`50`		`-RenderPassDescriptor& RenderPassDescriptor::SetStencilAttachment(`
`51`		`- RenderPassStencilAttachment attachment) {`
	`47`	`+RenderTarget& RenderTarget::SetStencilAttachment(StencilAttachment attachment) {`
`52`	`48`	`if (attachment) {`
`53`	`49`	`stencil_ = std::move(attachment);`
`54`	`50`	`}`
`55`	`51`	`return *this;`
`56`	`52`	`}`
`57`	`53`
`58`		`-const std::map<size_t, RenderPassColorAttachment>&`
`59`		`-RenderPassDescriptor::GetColorAttachments() const {`
	`54`	`+const std::map<size_t, ColorAttachment>& RenderTarget::GetColorAttachments()`
	`55`	`+ const {`
`60`	`56`	`return colors_;`
`61`	`57`	`}`
`62`	`58`
`63`		`-const std::optional<RenderPassDepthAttachment>&`
`64`		`-RenderPassDescriptor::GetDepthAttachment() const {`
	`59`	`+const std::optional<DepthAttachment>& RenderTarget::GetDepthAttachment() const {`
`65`	`60`	`return depth_;`
`66`	`61`	`}`
`67`	`62`
`68`		`-const std::optional<RenderPassStencilAttachment>&`
`69`		`-RenderPassDescriptor::GetStencilAttachment() const {`
	`63`	`+const std::optional<StencilAttachment>& RenderTarget::GetStencilAttachment()`
	`64`	`+ const {`
`70`	`65`	`return stencil_;`
`71`	`66`	`}`
`72`	`67`