#include <pipeline_descriptor.h>

Inheritance diagram for impeller::PipelineDescriptor:

Public Member Functions
	PipelineDescriptor ()

	~PipelineDescriptor ()

PipelineDescriptor &	SetLabel (std::string label)

const std::string &	GetLabel () const

PipelineDescriptor &	SetSampleCount (SampleCount samples)

SampleCount	GetSampleCount () const

PipelineDescriptor &	AddStageEntrypoint (std::shared_ptr< const ShaderFunction > function)

const std::map< ShaderStage, std::shared_ptr< const ShaderFunction > > &	GetStageEntrypoints () const

std::shared_ptr< const ShaderFunction >	GetEntrypointForStage (ShaderStage stage) const

PipelineDescriptor &	SetVertexDescriptor (std::shared_ptr< VertexDescriptor > vertex_descriptor)

const std::shared_ptr< VertexDescriptor > &	GetVertexDescriptor () const

size_t	GetMaxColorAttacmentBindIndex () const

PipelineDescriptor &	SetColorAttachmentDescriptor (size_t index, ColorAttachmentDescriptor desc)

PipelineDescriptor &	SetColorAttachmentDescriptors (std::map< size_t, ColorAttachmentDescriptor > descriptors)

const ColorAttachmentDescriptor *	GetColorAttachmentDescriptor (size_t index) const

const std::map< size_t, ColorAttachmentDescriptor > &	GetColorAttachmentDescriptors () const

const ColorAttachmentDescriptor *	GetLegacyCompatibleColorAttachment () const

PipelineDescriptor &	SetDepthStencilAttachmentDescriptor (std::optional< DepthAttachmentDescriptor > desc)

std::optional< DepthAttachmentDescriptor >	GetDepthStencilAttachmentDescriptor () const

PipelineDescriptor &	SetStencilAttachmentDescriptors (std::optional< StencilAttachmentDescriptor > front_and_back)

PipelineDescriptor &	SetStencilAttachmentDescriptors (std::optional< StencilAttachmentDescriptor > front, std::optional< StencilAttachmentDescriptor > back)

void	ClearStencilAttachments ()

void	ClearDepthAttachment ()

void	ClearColorAttachment (size_t index)

std::optional< StencilAttachmentDescriptor >	GetFrontStencilAttachmentDescriptor () const

std::optional< StencilAttachmentDescriptor >	GetBackStencilAttachmentDescriptor () const

bool	HasStencilAttachmentDescriptors () const

PipelineDescriptor &	SetDepthPixelFormat (PixelFormat format)

PixelFormat	GetDepthPixelFormat () const

PipelineDescriptor &	SetStencilPixelFormat (PixelFormat format)

PixelFormat	GetStencilPixelFormat () const

std::size_t	GetHash () const override

bool	IsEqual (const PipelineDescriptor &other) const override

void	ResetAttachments ()

void	SetCullMode (CullMode mode)

CullMode	GetCullMode () const

void	SetWindingOrder (WindingOrder order)

WindingOrder	GetWindingOrder () const

void	SetPrimitiveType (PrimitiveType type)

PrimitiveType	GetPrimitiveType () const

void	SetPolygonMode (PolygonMode mode)

PolygonMode	GetPolygonMode () const

Public Member Functions inherited from impeller::Comparable< PipelineDescriptor >
virtual std::size_t	GetHash () const=0

Detailed Description

Definition at line 30 of file pipeline_descriptor.h.

Constructor & Destructor Documentation

◆ PipelineDescriptor()

impeller::PipelineDescriptor::PipelineDescriptor ( )

default

◆ ~PipelineDescriptor()

impeller::PipelineDescriptor::~PipelineDescriptor ( )

default

Member Function Documentation

◆ AddStageEntrypoint()

PipelineDescriptor & impeller::PipelineDescriptor::AddStageEntrypoint ( std::shared_ptr< const ShaderFunction > function )

Definition at line 77 of file pipeline_descriptor.cc.

                                                   {
   if (!function) {
     return *this;
   }
  
   if (function->GetStage() == ShaderStage::kUnknown) {
     return *this;
   }
  
   entrypoints_[function->GetStage()] = std::move(function);
  
   return *this;
 }

References impeller::kUnknown.

Referenced by impeller::PipelineBuilder< VertexShader_, FragmentShader_ >::InitializePipelineDescriptorDefaults(), impeller::RuntimeEffectContents::Render(), and impeller::testing::TEST_P().

◆ ClearColorAttachment()

void impeller::PipelineDescriptor::ClearColorAttachment ( size_t index )

Definition at line 177 of file pipeline_descriptor.cc.

                                                           {
   if (color_attachment_descriptors_.find(index) ==
       color_attachment_descriptors_.end()) {
     return;
   }
  
   color_attachment_descriptors_.erase(index);
 }

◆ ClearDepthAttachment()

void impeller::PipelineDescriptor::ClearDepthAttachment ( )

Definition at line 172 of file pipeline_descriptor.cc.

                                               {
   depth_attachment_descriptor_.reset();
   SetDepthPixelFormat(impeller::PixelFormat::kUnknown);
 }

References impeller::kUnknown, and SetDepthPixelFormat().

◆ ClearStencilAttachments()

void impeller::PipelineDescriptor::ClearStencilAttachments ( )

Definition at line 166 of file pipeline_descriptor.cc.

                                                  {
   back_stencil_attachment_descriptor_.reset();
   front_stencil_attachment_descriptor_.reset();
   SetStencilPixelFormat(impeller::PixelFormat::kUnknown);
 }

References impeller::kUnknown, and SetStencilPixelFormat().

Referenced by impeller::ContentContextOptions::ApplyToPipelineDescriptor().

◆ GetBackStencilAttachmentDescriptor()

std::optional< StencilAttachmentDescriptor > impeller::PipelineDescriptor::GetBackStencilAttachmentDescriptor ( ) const

Definition at line 239 of file pipeline_descriptor.cc.

                                                              {
   return back_stencil_attachment_descriptor_;
 }

Referenced by impeller::ConfigureStencil(), and impeller::CreateDepthStencilDescriptor().

◆ GetColorAttachmentDescriptor()

const ColorAttachmentDescriptor * impeller::PipelineDescriptor::GetColorAttachmentDescriptor ( size_t index ) const

Definition at line 120 of file pipeline_descriptor.cc.

                                                                    {
   auto found = color_attachment_descriptors_.find(index);
   return found == color_attachment_descriptors_.end() ? nullptr
                                                       : &found->second;
 }

Referenced by impeller::ContentContextOptions::ApplyToPipelineDescriptor(), and GetLegacyCompatibleColorAttachment().

◆ GetColorAttachmentDescriptors()

const std::map< size_t, ColorAttachmentDescriptor > & impeller::PipelineDescriptor::GetColorAttachmentDescriptors ( ) const

Definition at line 208 of file pipeline_descriptor.cc.

                                                         {
   return color_attachment_descriptors_;
 }

Referenced by impeller::CreateCompatRenderPassForPipeline(), and impeller::GetMTLRenderPipelineDescriptor().

◆ GetCullMode()

CullMode impeller::PipelineDescriptor::GetCullMode ( ) const

Definition at line 252 of file pipeline_descriptor.cc.

                                                {
   return cull_mode_;
 }

◆ GetDepthPixelFormat()

PixelFormat impeller::PipelineDescriptor::GetDepthPixelFormat ( ) const

Definition at line 234 of file pipeline_descriptor.cc.

                                                           {
   return depth_pixel_format_;
 }

Referenced by impeller::CreateCompatRenderPassForPipeline(), and impeller::GetMTLRenderPipelineDescriptor().

◆ GetDepthStencilAttachmentDescriptor()

std::optional< DepthAttachmentDescriptor > impeller::PipelineDescriptor::GetDepthStencilAttachmentDescriptor ( ) const

Definition at line 203 of file pipeline_descriptor.cc.

                                                               {
   return depth_attachment_descriptor_;
 }

Referenced by impeller::CreateCompatRenderPassForPipeline(), and impeller::CreateDepthStencilDescriptor().

◆ GetEntrypointForStage()

std::shared_ptr< const ShaderFunction > impeller::PipelineDescriptor::GetEntrypointForStage ( ShaderStage stage ) const

Definition at line 222 of file pipeline_descriptor.cc.

                              {
   if (auto found = entrypoints_.find(stage); found != entrypoints_.end()) {
     return found->second;
   }
   return nullptr;
 }

◆ GetFrontStencilAttachmentDescriptor()

std::optional< StencilAttachmentDescriptor > impeller::PipelineDescriptor::GetFrontStencilAttachmentDescriptor ( ) const

Definition at line 198 of file pipeline_descriptor.cc.

                                                               {
   return front_stencil_attachment_descriptor_;
 }

Referenced by impeller::ContentContextOptions::ApplyToPipelineDescriptor(), impeller::ConfigureStencil(), and impeller::CreateDepthStencilDescriptor().

◆ GetHash()

std::size_t impeller::PipelineDescriptor::GetHash ( ) const

override

Definition at line 19 of file pipeline_descriptor.cc.

                                             {
   auto seed = fml::HashCombine();
   fml::HashCombineSeed(seed, label_);
   fml::HashCombineSeed(seed, sample_count_);
   for (const auto& entry : entrypoints_) {
     fml::HashCombineSeed(seed, entry.first);
     if (auto second = entry.second) {
       fml::HashCombineSeed(seed, second->GetHash());
     }
   }
   for (const auto& des : color_attachment_descriptors_) {
     fml::HashCombineSeed(seed, des.first);
     fml::HashCombineSeed(seed, des.second.Hash());
   }
   if (vertex_descriptor_) {
     fml::HashCombineSeed(seed, vertex_descriptor_->GetHash());
   }
   fml::HashCombineSeed(seed, depth_pixel_format_);
   fml::HashCombineSeed(seed, stencil_pixel_format_);
   fml::HashCombineSeed(seed, depth_attachment_descriptor_);
   fml::HashCombineSeed(seed, front_stencil_attachment_descriptor_);
   fml::HashCombineSeed(seed, back_stencil_attachment_descriptor_);
   fml::HashCombineSeed(seed, winding_order_);
   fml::HashCombineSeed(seed, cull_mode_);
   fml::HashCombineSeed(seed, primitive_type_);
   fml::HashCombineSeed(seed, polygon_mode_);
   return seed;
 }

Referenced by impeller::testing::TEST().

◆ GetLabel()

const std::string & impeller::PipelineDescriptor::GetLabel ( ) const

Definition at line 230 of file pipeline_descriptor.cc.

                                                     {
   return label_;
 }

Referenced by impeller::CreateCompatRenderPassForPipeline(), impeller::GetMTLRenderPipelineDescriptor(), and impeller::ReportPipelineCreationFeedbackToLog().

◆ GetLegacyCompatibleColorAttachment()

const ColorAttachmentDescriptor * impeller::PipelineDescriptor::GetLegacyCompatibleColorAttachment ( ) const

Definition at line 127 of file pipeline_descriptor.cc.

                                                              {
   // Legacy renderers may only render to a single color attachment at index 0u.
   if (color_attachment_descriptors_.size() != 1u) {
     return nullptr;
   }
   return GetColorAttachmentDescriptor(0u);
 }

References GetColorAttachmentDescriptor().

◆ GetMaxColorAttacmentBindIndex()

size_t impeller::PipelineDescriptor::GetMaxColorAttacmentBindIndex ( ) const

Definition at line 98 of file pipeline_descriptor.cc.

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

Referenced by impeller::CreateCompatRenderPassForPipeline().

◆ GetPolygonMode()

PolygonMode impeller::PipelineDescriptor::GetPolygonMode ( ) const

Definition at line 276 of file pipeline_descriptor.cc.

                                                      {
   return polygon_mode_;
 }

◆ GetPrimitiveType()

PrimitiveType impeller::PipelineDescriptor::GetPrimitiveType ( ) const

Definition at line 268 of file pipeline_descriptor.cc.

                                                          {
   return primitive_type_;
 }

◆ GetSampleCount()

SampleCount impeller::PipelineDescriptor::GetSampleCount ( ) const

inline

Definition at line 42 of file pipeline_descriptor.h.

42 { return sample_count_; }

Referenced by impeller::CreateCompatRenderPassForPipeline(), and impeller::GetMTLRenderPipelineDescriptor().

◆ GetStageEntrypoints()

const std::map< ShaderStage, std::shared_ptr< const ShaderFunction > > & impeller::PipelineDescriptor::GetStageEntrypoints ( ) const

Definition at line 218 of file pipeline_descriptor.cc.

                                               {
   return entrypoints_;
 }

Referenced by impeller::GetMTLRenderPipelineDescriptor().

◆ GetStencilPixelFormat()

PixelFormat impeller::PipelineDescriptor::GetStencilPixelFormat ( ) const

Definition at line 193 of file pipeline_descriptor.cc.

                                                             {
   return stencil_pixel_format_;
 }

Referenced by impeller::CreateCompatRenderPassForPipeline(), and impeller::GetMTLRenderPipelineDescriptor().

◆ GetVertexDescriptor()

const std::shared_ptr< VertexDescriptor > & impeller::PipelineDescriptor::GetVertexDescriptor ( ) const

Definition at line 213 of file pipeline_descriptor.cc.

                                               {
   return vertex_descriptor_;
 }

Referenced by impeller::AllocateAndBindDescriptorSets(), and impeller::GetMTLRenderPipelineDescriptor().

◆ GetWindingOrder()

WindingOrder impeller::PipelineDescriptor::GetWindingOrder ( ) const

Definition at line 260 of file pipeline_descriptor.cc.

                                                        {
   return winding_order_;
 }

◆ HasStencilAttachmentDescriptors()

bool impeller::PipelineDescriptor::HasStencilAttachmentDescriptors ( ) const

Definition at line 243 of file pipeline_descriptor.cc.

                                                                {
   return front_stencil_attachment_descriptor_.has_value() ||
          back_stencil_attachment_descriptor_.has_value();
 }

Referenced by impeller::ConfigureStencil(), and impeller::CreateCompatRenderPassForPipeline().

◆ IsEqual()

bool impeller::PipelineDescriptor::IsEqual ( const PipelineDescriptor & other ) const

overridevirtual

Implements impeller::Comparable< PipelineDescriptor >.

Definition at line 49 of file pipeline_descriptor.cc.

                                                                       {
   return label_ == other.label_ && sample_count_ == other.sample_count_ &&
          DeepCompareMap(entrypoints_, other.entrypoints_) &&
          color_attachment_descriptors_ == other.color_attachment_descriptors_ &&
          DeepComparePointer(vertex_descriptor_, other.vertex_descriptor_) &&
          stencil_pixel_format_ == other.stencil_pixel_format_ &&
          depth_pixel_format_ == other.depth_pixel_format_ &&
          depth_attachment_descriptor_ == other.depth_attachment_descriptor_ &&
          front_stencil_attachment_descriptor_ ==
              other.front_stencil_attachment_descriptor_ &&
          back_stencil_attachment_descriptor_ ==
              other.back_stencil_attachment_descriptor_ &&
          winding_order_ == other.winding_order_ &&
          cull_mode_ == other.cull_mode_ &&
          primitive_type_ == other.primitive_type_ &&
          polygon_mode_ == other.polygon_mode_;
 }

References impeller::DeepCompareMap(), and impeller::DeepComparePointer().

Referenced by impeller::testing::TEST().

◆ ResetAttachments()

void impeller::PipelineDescriptor::ResetAttachments ( )

Definition at line 186 of file pipeline_descriptor.cc.

                                           {
   color_attachment_descriptors_.clear();
   depth_attachment_descriptor_.reset();
   front_stencil_attachment_descriptor_.reset();
   back_stencil_attachment_descriptor_.reset();
 }

◆ SetColorAttachmentDescriptor()

PipelineDescriptor & impeller::PipelineDescriptor::SetColorAttachmentDescriptor	(	size_t	index,
		ColorAttachmentDescriptor	desc
	)

Definition at line 106 of file pipeline_descriptor.cc.

                                     {
   color_attachment_descriptors_[index] = desc;
   return *this;
 }

Referenced by impeller::ContentContextOptions::ApplyToPipelineDescriptor(), impeller::PipelineBuilder< VertexShader_, FragmentShader_ >::InitializePipelineDescriptorDefaults(), impeller::RuntimeEffectContents::Render(), and impeller::testing::TEST_P().

◆ SetColorAttachmentDescriptors()

PipelineDescriptor & impeller::PipelineDescriptor::SetColorAttachmentDescriptors ( std::map< size_t, ColorAttachmentDescriptor > descriptors )

Definition at line 113 of file pipeline_descriptor.cc.

                                                              {
   color_attachment_descriptors_ = std::move(descriptors);
   return *this;
 }

◆ SetCullMode()

void impeller::PipelineDescriptor::SetCullMode ( CullMode mode )

Definition at line 248 of file pipeline_descriptor.cc.

                                                   {
   cull_mode_ = mode;
 }

Referenced by impeller::scene::SceneContextOptions::ApplyToPipelineDescriptor().

◆ SetDepthPixelFormat()

PipelineDescriptor & impeller::PipelineDescriptor::SetDepthPixelFormat ( PixelFormat format )

Definition at line 135 of file pipeline_descriptor.cc.

                         {
   depth_pixel_format_ = format;
   return *this;
 }

Referenced by impeller::scene::SceneContextOptions::ApplyToPipelineDescriptor(), and ClearDepthAttachment().

◆ SetDepthStencilAttachmentDescriptor()

PipelineDescriptor & impeller::PipelineDescriptor::SetDepthStencilAttachmentDescriptor ( std::optional< DepthAttachmentDescriptor > desc )

Definition at line 147 of file pipeline_descriptor.cc.

                                                  {
   depth_attachment_descriptor_ = desc;
   return *this;
 }

Referenced by impeller::scene::SceneContextOptions::ApplyToPipelineDescriptor().

◆ SetLabel()

PipelineDescriptor & impeller::PipelineDescriptor::SetLabel ( std::string label )

Definition at line 67 of file pipeline_descriptor.cc.

                                                                 {
   label_ = std::move(label);
   return *this;
 }

Referenced by impeller::PipelineBuilder< VertexShader_, FragmentShader_ >::InitializePipelineDescriptorDefaults(), impeller::RuntimeEffectContents::Render(), and impeller::testing::TEST_P().

◆ SetPolygonMode()

void impeller::PipelineDescriptor::SetPolygonMode ( PolygonMode mode )

Definition at line 272 of file pipeline_descriptor.cc.

                                                         {
   polygon_mode_ = mode;
 }

Referenced by impeller::ContentContextOptions::ApplyToPipelineDescriptor().

◆ SetPrimitiveType()

void impeller::PipelineDescriptor::SetPrimitiveType ( PrimitiveType type )

Definition at line 264 of file pipeline_descriptor.cc.

                                                             {
   primitive_type_ = type;
 }

Referenced by impeller::scene::SceneContextOptions::ApplyToPipelineDescriptor(), impeller::ContentContextOptions::ApplyToPipelineDescriptor(), and impeller::testing::TEST().

◆ SetSampleCount()

PipelineDescriptor & impeller::PipelineDescriptor::SetSampleCount ( SampleCount samples )

Definition at line 72 of file pipeline_descriptor.cc.

                                                                           {
   sample_count_ = samples;
   return *this;
 }

Referenced by impeller::scene::SceneContextOptions::ApplyToPipelineDescriptor(), and impeller::ContentContextOptions::ApplyToPipelineDescriptor().

◆ SetStencilAttachmentDescriptors() [1/2]

PipelineDescriptor & impeller::PipelineDescriptor::SetStencilAttachmentDescriptors	(	std::optional< StencilAttachmentDescriptor >	front,
		std::optional< StencilAttachmentDescriptor >	back
	)

Definition at line 158 of file pipeline_descriptor.cc.

                                                    {
   front_stencil_attachment_descriptor_ = front;
   back_stencil_attachment_descriptor_ = back;
   return *this;
 }

◆ SetStencilAttachmentDescriptors() [2/2]

PipelineDescriptor & impeller::PipelineDescriptor::SetStencilAttachmentDescriptors ( std::optional< StencilAttachmentDescriptor > front_and_back )

Definition at line 153 of file pipeline_descriptor.cc.

                                                              {
   return SetStencilAttachmentDescriptors(front_and_back, front_and_back);
 }

Referenced by impeller::scene::SceneContextOptions::ApplyToPipelineDescriptor(), impeller::ContentContextOptions::ApplyToPipelineDescriptor(), impeller::PipelineBuilder< VertexShader_, FragmentShader_ >::InitializePipelineDescriptorDefaults(), impeller::RuntimeEffectContents::Render(), and impeller::testing::TEST_P().

◆ SetStencilPixelFormat()

PipelineDescriptor & impeller::PipelineDescriptor::SetStencilPixelFormat ( PixelFormat format )

Definition at line 141 of file pipeline_descriptor.cc.

                         {
   stencil_pixel_format_ = format;
   return *this;
 }

Referenced by impeller::scene::SceneContextOptions::ApplyToPipelineDescriptor(), ClearStencilAttachments(), impeller::PipelineBuilder< VertexShader_, FragmentShader_ >::InitializePipelineDescriptorDefaults(), impeller::RuntimeEffectContents::Render(), and impeller::testing::TEST_P().

◆ SetVertexDescriptor()

PipelineDescriptor & impeller::PipelineDescriptor::SetVertexDescriptor ( std::shared_ptr< VertexDescriptor > vertex_descriptor )

Definition at line 92 of file pipeline_descriptor.cc.

                                                        {
   vertex_descriptor_ = std::move(vertex_descriptor);
   return *this;
 }

Referenced by impeller::PipelineBuilder< VertexShader_, FragmentShader_ >::InitializePipelineDescriptorDefaults(), impeller::RuntimeEffectContents::Render(), impeller::testing::TEST(), and impeller::testing::TEST_P().

◆ SetWindingOrder()

void impeller::PipelineDescriptor::SetWindingOrder ( WindingOrder order )

Definition at line 256 of file pipeline_descriptor.cc.

                                                            {
   winding_order_ = order;
 }

Referenced by impeller::scene::SceneContextOptions::ApplyToPipelineDescriptor().

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

impeller/renderer/pipeline_descriptor.h
impeller/renderer/pipeline_descriptor.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PipelineDescriptor()

◆ ~PipelineDescriptor()

Member Function Documentation

◆ AddStageEntrypoint()

◆ ClearColorAttachment()

◆ ClearDepthAttachment()

◆ ClearStencilAttachments()

◆ GetBackStencilAttachmentDescriptor()

◆ GetColorAttachmentDescriptor()

◆ GetColorAttachmentDescriptors()

◆ GetCullMode()

◆ GetDepthPixelFormat()

◆ GetDepthStencilAttachmentDescriptor()

◆ GetEntrypointForStage()

◆ GetFrontStencilAttachmentDescriptor()

◆ GetHash()

◆ GetLabel()

◆ GetLegacyCompatibleColorAttachment()

◆ GetMaxColorAttacmentBindIndex()

◆ GetPolygonMode()

◆ GetPrimitiveType()

◆ GetSampleCount()

◆ GetStageEntrypoints()

◆ GetStencilPixelFormat()

◆ GetVertexDescriptor()

◆ GetWindingOrder()

◆ HasStencilAttachmentDescriptors()

◆ IsEqual()

◆ ResetAttachments()

◆ SetColorAttachmentDescriptor()

◆ SetColorAttachmentDescriptors()

◆ SetCullMode()

◆ SetDepthPixelFormat()

◆ SetDepthStencilAttachmentDescriptor()

◆ SetLabel()

◆ SetPolygonMode()

◆ SetPrimitiveType()

◆ SetSampleCount()

◆ SetStencilAttachmentDescriptors() [1/2]

◆ SetStencilAttachmentDescriptors() [2/2]

◆ SetStencilPixelFormat()

◆ SetVertexDescriptor()

◆ SetWindingOrder()