impeller::PipelineVK Class Reference

#include <pipeline_vk.h>

Inheritance diagram for impeller::PipelineVK:

Public Member Functions
	~PipelineVK () override
vk::Pipeline	GetPipeline () const
const vk::PipelineLayout &	GetPipelineLayout () const
const vk::DescriptorSetLayout &	GetDescriptorSetLayout () const
std::shared_ptr< PipelineVK >	CreateVariantForImmutableSamplers (const std::shared_ptr< SamplerVK > &immutable_sampler) const
PipelineKey	GetPipelineKey () const
Public Member Functions inherited from impeller::Pipeline< PipelineDescriptor >
virtual	~Pipeline ()
const PipelineDescriptor &	GetDescriptor () const
	Get the descriptor that was responsible for creating this pipeline. It may be copied and modified to create a pipeline variant. More...
PipelineFuture< PipelineDescriptor >	CreateVariant (bool async, std::function< void(PipelineDescriptor &desc)> descriptor_callback) const

Static Public Member Functions
static std::unique_ptr< PipelineVK >	Create (const PipelineDescriptor &desc, const std::shared_ptr< DeviceHolderVK > &device_holder, const std::weak_ptr< PipelineLibrary > &weak_library, PipelineKey pipeline_key, std::shared_ptr< SamplerVK > immutable_sampler={})
Static Public Member Functions inherited from impeller::BackendCast< PipelineVK, Pipeline< PipelineDescriptor > >
static PipelineVK &	Cast (Pipeline< PipelineDescriptor > &base)
static const PipelineVK &	Cast (const Pipeline< PipelineDescriptor > &base)
static PipelineVK *	Cast (Pipeline< PipelineDescriptor > *base)
static const PipelineVK *	Cast (const Pipeline< PipelineDescriptor > *base)

Friends
class	PipelineLibraryVK

Additional Inherited Members
Protected Member Functions inherited from impeller::Pipeline< PipelineDescriptor >
	Pipeline (std::weak_ptr< PipelineLibrary > library, PipelineDescriptor desc)
Protected Attributes inherited from impeller::Pipeline< PipelineDescriptor >
const std::weak_ptr< PipelineLibrary >	library_
const PipelineDescriptor	desc_

Detailed Description

Definition at line 25 of file pipeline_vk.h.

Constructor & Destructor Documentation

~PipelineVK()

impeller::PipelineVK::~PipelineVK ( )

override

Definition at line 545 of file pipeline_vk.cc.

                        {
  if (auto device = device_holder_.lock(); !device) {
    descriptor_set_layout_.release();
    layout_.release();
    render_pass_.release();
    pipeline_.release();
  }
}

Member Function Documentation

Create()

std::unique_ptr< PipelineVK > impeller::PipelineVK::Create ( const PipelineDescriptor &  desc, const std::shared_ptr< DeviceHolderVK > &  device_holder, const std::weak_ptr< PipelineLibrary > &  weak_library, PipelineKey  pipeline_key, std::shared_ptr< SamplerVK >  immutable_sampler = {}  )

static

Definition at line 464 of file pipeline_vk.cc.

                                                {
  TRACE_EVENT1("flutter", "PipelineVK::Create", "Name", desc.GetLabel().data());
 
  auto library = weak_library.lock();
 
  if (!device_holder || !library) {
    return nullptr;
  }
 
  const auto& pso_cache = PipelineLibraryVK::Cast(*library).GetPSOCache();
 
  fml::StatusOr<vk::UniqueDescriptorSetLayout> descs_layout =
      MakeDescriptorSetLayout(desc, device_holder, immutable_sampler);
  if (!descs_layout.ok()) {
    return nullptr;
  }
 
  fml::StatusOr<vk::UniquePipelineLayout> pipeline_layout =
      MakePipelineLayout(desc, device_holder, descs_layout.value().get());
  if (!pipeline_layout.ok()) {
    return nullptr;
  }
 
  vk::UniqueRenderPass render_pass =
      CreateCompatRenderPassForPipeline(device_holder->GetDevice(), desc);
  if (!render_pass) {
    VALIDATION_LOG << "Could not create render pass for pipeline.";
    return nullptr;
  }
 
  fml::StatusOr<vk::UniquePipeline> pipeline =
      MakePipeline(desc, device_holder, pso_cache,
                   pipeline_layout.value().get(), render_pass.get());
  if (!pipeline.ok()) {
    return nullptr;
  }
 
  // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks)
  auto pipeline_vk = std::unique_ptr<PipelineVK>(new PipelineVK(
      device_holder,                       //
      library,                             //
      desc,                                //
      std::move(pipeline.value()),         //
      std::move(render_pass),              //
      std::move(pipeline_layout.value()),  //
      std::move(descs_layout.value()),     //
      pipeline_key,                        //
      std::move(immutable_sampler)         //
      ));
  if (!pipeline_vk->IsValid()) {
    VALIDATION_LOG << "Could not create a valid pipeline.";
    return nullptr;
  }
  return pipeline_vk;
}

References impeller::BackendCast< PipelineLibraryVK, PipelineLibrary >::Cast(), impeller::CreateCompatRenderPassForPipeline(), impeller::PipelineDescriptor::GetLabel(), impeller::PipelineLibraryVK::GetPSOCache(), and VALIDATION_LOG.

Referenced by CreateVariantForImmutableSamplers().

CreateVariantForImmutableSamplers()

std::shared_ptr< PipelineVK > impeller::PipelineVK::CreateVariantForImmutableSamplers

(

const std::shared_ptr< SamplerVK > &

immutable_sampler

)

const

Definition at line 570 of file pipeline_vk.cc.

                                                             {
  if (!immutable_sampler) {
    return nullptr;
  }
  auto cache_key = ImmutableSamplerKeyVK{*immutable_sampler};
  Lock lock(immutable_sampler_variants_mutex_);
  auto found = immutable_sampler_variants_.find(cache_key);
  if (found != immutable_sampler_variants_.end()) {
    return found->second;
  }
  auto device_holder = device_holder_.lock();
  if (!device_holder) {
    return nullptr;
  }
  // Note: immutable sampler variant of a pipeline is the negation of the
  // existing pipeline key. This keeps the descriptors separate.
  return (immutable_sampler_variants_[cache_key] =
              Create(desc_, device_holder, library_, -1 * pipeline_key_,
                     immutable_sampler));
}

References Create(), impeller::Pipeline< PipelineDescriptor >::desc_, and impeller::Pipeline< PipelineDescriptor >::library_.

GetDescriptorSetLayout()

const vk::DescriptorSetLayout & impeller::PipelineVK::GetDescriptorSetLayout

(

)

const

Definition at line 566 of file pipeline_vk.cc.

                                                                      {
  return *descriptor_set_layout_;
}

GetPipeline()

vk::Pipeline impeller::PipelineVK::GetPipeline

(

)

const

Definition at line 558 of file pipeline_vk.cc.

                                         {
  return *pipeline_;
}

GetPipelineKey()

PipelineKey impeller::PipelineVK::GetPipelineKey ( ) const

inline

Definition at line 48 of file pipeline_vk.h.

{ return pipeline_key_; }

GetPipelineLayout()

const vk::PipelineLayout & impeller::PipelineVK::GetPipelineLayout

(

)

const

Definition at line 562 of file pipeline_vk.cc.

                                                            {
  return *layout_;
}

Friends And Related Function Documentation

PipelineLibraryVK

friend class PipelineLibraryVK

friend

Definition at line 51 of file pipeline_vk.h.

---

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

• impeller/renderer/backend/vulkan/pipeline_vk.h
• impeller/renderer/backend/vulkan/pipeline_vk.cc