Describes the format and layout of vertices expected by the pipeline. While it is possible to construct these descriptors manually, it would be tedious to do so. These are usually constructed using shader information reflected using impellerc. The usage of this class is indirectly via PipelineBuilder<VS, FS>. More...

#include <vertex_descriptor.h>

Inheritance diagram for impeller::VertexDescriptor:

Public Member Functions
	VertexDescriptor ()

virtual	~VertexDescriptor ()

template<size_t Size, size_t LayoutSize>
void	SetStageInputs (const std::array< const ShaderStageIOSlot , Size > &inputs, const std::array< const ShaderStageBufferLayout , LayoutSize > &layout)

void	SetStageInputs (const std::vector< ShaderStageIOSlot > &inputs, const std::vector< ShaderStageBufferLayout > &layout)

template<size_t Size>
void	RegisterDescriptorSetLayouts (const std::array< DescriptorSetLayout, Size > &inputs)

void	SetStageInputs (const ShaderStageIOSlot const stage_inputs[], size_t count, const ShaderStageBufferLayout const stage_layout[], size_t layout_count)

void	RegisterDescriptorSetLayouts (const DescriptorSetLayout desc_set_layout[], size_t count)

const std::vector< ShaderStageIOSlot > &	GetStageInputs () const

const std::vector< ShaderStageBufferLayout > &	GetStageLayouts () const

const std::vector< DescriptorSetLayout > &	GetDescriptorSetLayouts () const

std::size_t	GetHash () const override

bool	IsEqual (const VertexDescriptor &other) const override

bool	UsesInputAttacments () const

Static Public Attributes
static constexpr size_t	kReservedVertexBufferIndex

Detailed Description

Describes the format and layout of vertices expected by the pipeline. While it is possible to construct these descriptors manually, it would be tedious to do so. These are usually constructed using shader information reflected using impellerc. The usage of this class is indirectly via PipelineBuilder<VS, FS>.

Definition at line 23 of file vertex_descriptor.h.

Constructor & Destructor Documentation

◆ VertexDescriptor()

impeller::VertexDescriptor::VertexDescriptor ( )

default

◆ ~VertexDescriptor()

impeller::VertexDescriptor::~VertexDescriptor ( )

virtualdefault

Member Function Documentation

◆ GetDescriptorSetLayouts()

const std::vector< DescriptorSetLayout > & impeller::VertexDescriptor::GetDescriptorSetLayouts ( ) const

Definition at line 73 of file vertex_descriptor.cc.

                                                {
  return desc_set_layouts_;
}

◆ GetHash()

size_t impeller::VertexDescriptor::GetHash ( ) const

overridevirtual

Implements impeller::Comparable< VertexDescriptor >.

Definition at line 47 of file vertex_descriptor.cc.

                                       {
  auto seed = fml::HashCombine();
  for (const auto& input : inputs_) {
    fml::HashCombineSeed(seed, input.GetHash());
  }
  for (const auto& layout : layouts_) {
    fml::HashCombineSeed(seed, layout.GetHash());
  }
  return seed;
}

◆ GetStageInputs()

const std::vector< ShaderStageIOSlot > & impeller::VertexDescriptor::GetStageInputs ( ) const

Definition at line 63 of file vertex_descriptor.cc.

                                                                           {
  return inputs_;
}

◆ GetStageLayouts()

const std::vector< ShaderStageBufferLayout > & impeller::VertexDescriptor::GetStageLayouts ( ) const

Definition at line 67 of file vertex_descriptor.cc.

          {
  return layouts_;
}

◆ IsEqual()

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

overridevirtual

Implements impeller::Comparable< VertexDescriptor >.

Definition at line 59 of file vertex_descriptor.cc.

                                                                  {
  return inputs_ == other.inputs_ && layouts_ == other.layouts_;
}

◆ RegisterDescriptorSetLayouts() [1/2]

void impeller::VertexDescriptor::RegisterDescriptorSetLayouts	(	const DescriptorSetLayout	desc_set_layout[],
		size_t	count
	)

Definition at line 35 of file vertex_descriptor.cc.

                  {
  desc_set_layouts_.reserve(desc_set_layouts_.size() + count);
  for (size_t i = 0; i < count; i++) {
    uses_input_attachments_ |=
        desc_set_layout[i].descriptor_type == DescriptorType::kInputAttachment;
    desc_set_layouts_.emplace_back(desc_set_layout[i]);
  }
}

◆ RegisterDescriptorSetLayouts() [2/2]

template<size_t Size>

void impeller::VertexDescriptor::RegisterDescriptorSetLayouts ( const std::array< DescriptorSetLayout, Size > & inputs )

inline

Definition at line 45 of file vertex_descriptor.h.

                                                         {
    return RegisterDescriptorSetLayouts(inputs.data(), inputs.size());
  }

◆ SetStageInputs() [1/3]

void impeller::VertexDescriptor::SetStageInputs	(	const ShaderStageIOSlot *const	stage_inputs[],
		size_t	count,
		const ShaderStageBufferLayout *const	stage_layout[],
		size_t	layout_count
	)

Definition at line 13 of file vertex_descriptor.cc.

                         {
  inputs_.reserve(inputs_.size() + count);
  layouts_.reserve(layouts_.size() + layout_count);
  for (size_t i = 0; i < count; i++) {
    inputs_.emplace_back(*stage_inputs[i]);
  }
  for (size_t i = 0; i < layout_count; i++) {
    layouts_.emplace_back(*stage_layout[i]);
  }
}

◆ SetStageInputs() [2/3]

template<size_t Size, size_t LayoutSize>

void impeller::VertexDescriptor::SetStageInputs	(	const std::array< const ShaderStageIOSlot *, Size > &	inputs,
		const std::array< const ShaderStageBufferLayout *, LayoutSize > &	layout
	)

inline

Definition at line 34 of file vertex_descriptor.h.

                                                                          {
    return SetStageInputs(inputs.data(), inputs.size(), layout.data(),
                          layout.size());
  }

◆ SetStageInputs() [3/3]

void impeller::VertexDescriptor::SetStageInputs	(	const std::vector< ShaderStageIOSlot > &	inputs,
		const std::vector< ShaderStageBufferLayout > &	layout
	)

Definition at line 28 of file vertex_descriptor.cc.

                                                      {
  inputs_.insert(inputs_.end(), inputs.begin(), inputs.end());
  layouts_.insert(layouts_.end(), layout.begin(), layout.end());
}

◆ UsesInputAttacments()

bool impeller::VertexDescriptor::UsesInputAttacments ( ) const

Definition at line 77 of file vertex_descriptor.cc.

                                                 {
  return uses_input_attachments_;
}

Member Data Documentation

◆ kReservedVertexBufferIndex

constexpr size_t impeller::VertexDescriptor::kReservedVertexBufferIndex

staticconstexpr

Initial value:

=

30u

Definition at line 25 of file vertex_descriptor.h.

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

impeller/renderer/vertex_descriptor.h
impeller/renderer/vertex_descriptor.cc

Public Member Functions

Static Public Attributes