#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

void	SetSpecializationConstants (std::vector< Scalar > values)

const std::vector< Scalar > &	GetSpecializationConstants () const

virtual std::size_t	GetHash () const=0

virtual bool	IsEqual (const PipelineDescriptor &other) const=0

Detailed Description

Definition at line 24 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 81 of file pipeline_descriptor.cc.

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

◆ ClearColorAttachment()

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

Definition at line 181 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 176 of file pipeline_descriptor.cc.

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

◆ ClearStencilAttachments()

void impeller::PipelineDescriptor::ClearStencilAttachments ( )

Definition at line 170 of file pipeline_descriptor.cc.

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

◆ GetBackStencilAttachmentDescriptor()

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

Definition at line 243 of file pipeline_descriptor.cc.

                                                             {
  return back_stencil_attachment_descriptor_;
}

◆ GetColorAttachmentDescriptor()

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

Definition at line 124 of file pipeline_descriptor.cc.

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

◆ GetColorAttachmentDescriptors()

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

Definition at line 212 of file pipeline_descriptor.cc.

                                                        {
  return color_attachment_descriptors_;
}

◆ GetCullMode()

CullMode impeller::PipelineDescriptor::GetCullMode ( ) const

Definition at line 256 of file pipeline_descriptor.cc.

                                               {
  return cull_mode_;
}

◆ GetDepthPixelFormat()

PixelFormat impeller::PipelineDescriptor::GetDepthPixelFormat ( ) const

Definition at line 238 of file pipeline_descriptor.cc.

                                                          {
  return depth_pixel_format_;
}

◆ GetDepthStencilAttachmentDescriptor()

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

Definition at line 207 of file pipeline_descriptor.cc.

                                                              {
  return depth_attachment_descriptor_;
}

◆ GetEntrypointForStage()

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

Definition at line 226 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 202 of file pipeline_descriptor.cc.

                                                              {
  return front_stencil_attachment_descriptor_;
}

◆ GetHash()

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

overridevirtual

Implements impeller::Comparable< PipelineDescriptor >.

Definition at line 22 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;
}

◆ GetLabel()

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

Definition at line 234 of file pipeline_descriptor.cc.

                                                    {
  return label_;
}

◆ GetLegacyCompatibleColorAttachment()

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

Definition at line 131 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);
}

◆ GetMaxColorAttacmentBindIndex()

size_t impeller::PipelineDescriptor::GetMaxColorAttacmentBindIndex ( ) const

Definition at line 102 of file pipeline_descriptor.cc.

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

◆ GetPolygonMode()

PolygonMode impeller::PipelineDescriptor::GetPolygonMode ( ) const

Definition at line 280 of file pipeline_descriptor.cc.

                                                     {
  return polygon_mode_;
}

◆ GetPrimitiveType()

PrimitiveType impeller::PipelineDescriptor::GetPrimitiveType ( ) const

Definition at line 272 of file pipeline_descriptor.cc.

                                                         {
  return primitive_type_;
}

◆ GetSampleCount()

SampleCount impeller::PipelineDescriptor::GetSampleCount ( ) const

inline

Definition at line 36 of file pipeline_descriptor.h.

36{ return sample_count_; }

◆ GetSpecializationConstants()

const std::vector< Scalar > & impeller::PipelineDescriptor::GetSpecializationConstants ( ) const

Definition at line 289 of file pipeline_descriptor.cc.

          {
  return specialization_constants_;
}

◆ GetStageEntrypoints()

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

Definition at line 222 of file pipeline_descriptor.cc.

                                              {
  return entrypoints_;
}

◆ GetStencilPixelFormat()

PixelFormat impeller::PipelineDescriptor::GetStencilPixelFormat ( ) const

Definition at line 197 of file pipeline_descriptor.cc.

                                                            {
  return stencil_pixel_format_;
}

◆ GetVertexDescriptor()

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

Definition at line 217 of file pipeline_descriptor.cc.

                                              {
  return vertex_descriptor_;
}

◆ GetWindingOrder()

WindingOrder impeller::PipelineDescriptor::GetWindingOrder ( ) const

Definition at line 264 of file pipeline_descriptor.cc.

                                                       {
  return winding_order_;
}

◆ HasStencilAttachmentDescriptors()

bool impeller::PipelineDescriptor::HasStencilAttachmentDescriptors ( ) const

Definition at line 247 of file pipeline_descriptor.cc.

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

◆ IsEqual()

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

overridevirtual

Implements impeller::Comparable< PipelineDescriptor >.

Definition at line 52 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_ &&
         specialization_constants_ == other.specialization_constants_;
}

◆ ResetAttachments()

void impeller::PipelineDescriptor::ResetAttachments ( )

Definition at line 190 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 110 of file pipeline_descriptor.cc.

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

◆ SetColorAttachmentDescriptors()

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

Definition at line 117 of file pipeline_descriptor.cc.

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

◆ SetCullMode()

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

Definition at line 252 of file pipeline_descriptor.cc.

                                                  {
  cull_mode_ = mode;
}

◆ SetDepthPixelFormat()

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

Definition at line 139 of file pipeline_descriptor.cc.

                        {
  depth_pixel_format_ = format;
  return *this;
}

◆ SetDepthStencilAttachmentDescriptor()

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

Definition at line 151 of file pipeline_descriptor.cc.

                                                 {
  depth_attachment_descriptor_ = desc;
  return *this;
}

◆ SetLabel()

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

Definition at line 71 of file pipeline_descriptor.cc.

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

◆ SetPolygonMode()

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

Definition at line 276 of file pipeline_descriptor.cc.

                                                        {
  polygon_mode_ = mode;
}

◆ SetPrimitiveType()

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

Definition at line 268 of file pipeline_descriptor.cc.

                                                            {
  primitive_type_ = type;
}

◆ SetSampleCount()

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

Definition at line 76 of file pipeline_descriptor.cc.

                                                                          {
  sample_count_ = samples;
  return *this;
}

◆ SetSpecializationConstants()

void impeller::PipelineDescriptor::SetSpecializationConstants ( std::vector< Scalar > values )

Definition at line 284 of file pipeline_descriptor.cc.

                              {
  specialization_constants_ = std::move(values);
}

◆ SetStencilAttachmentDescriptors() [1/2]

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

Definition at line 162 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 157 of file pipeline_descriptor.cc.

                                                             {
  return SetStencilAttachmentDescriptors(front_and_back, front_and_back);
}

◆ SetStencilPixelFormat()

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

Definition at line 145 of file pipeline_descriptor.cc.

                        {
  stencil_pixel_format_ = format;
  return *this;
}

◆ SetVertexDescriptor()

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

Definition at line 96 of file pipeline_descriptor.cc.

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

◆ SetWindingOrder()

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

Definition at line 260 of file pipeline_descriptor.cc.

                                                           {
  winding_order_ = order;
}

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

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

Public Member Functions