impeller::PipelineLibraryMTL Class Reference

#include <pipeline_library_mtl.h>

Inheritance diagram for impeller::PipelineLibraryMTL:

Public Member Functions
	PipelineLibraryMTL ()
	~PipelineLibraryMTL () override
Public Member Functions inherited from impeller::PipelineLibrary
virtual	~PipelineLibrary ()
PipelineFuture< PipelineDescriptor >	GetPipeline (std::optional< PipelineDescriptor > descriptor)
PipelineFuture< ComputePipelineDescriptor >	GetPipeline (std::optional< ComputePipelineDescriptor > descriptor)

Private Member Functions
bool	IsValid () const override
PipelineFuture< PipelineDescriptor >	GetPipeline (PipelineDescriptor descriptor) override
PipelineFuture< ComputePipelineDescriptor >	GetPipeline (ComputePipelineDescriptor descriptor) override
void	RemovePipelinesWithEntryPoint (std::shared_ptr< const ShaderFunction > function) override

Additional Inherited Members
Protected Member Functions inherited from impeller::PipelineLibrary
	PipelineLibrary ()

Detailed Description

Definition at line 17 of file pipeline_library_mtl.h.

Constructor & Destructor Documentation

PipelineLibraryMTL()

impeller::PipelineLibraryMTL::PipelineLibraryMTL

(

)

~PipelineLibraryMTL()

impeller::PipelineLibraryMTL::~PipelineLibraryMTL ( )

overridedefault

Member Function Documentation

GetPipeline() [1/2]

PipelineFuture< ComputePipelineDescriptor > impeller::PipelineLibraryMTL::GetPipeline ( ComputePipelineDescriptor  descriptor )

overrideprivatevirtual

Implements impeller::PipelineLibrary.

Definition at line 164 of file pipeline_library_mtl.mm.

                                          {
  if (auto found = compute_pipelines_.find(descriptor);
      found != compute_pipelines_.end()) {
    return found->second;
  }
 
  if (!IsValid()) {
    return {
        descriptor,
        RealizedFuture<std::shared_ptr<Pipeline<ComputePipelineDescriptor>>>(
            nullptr)};
  }
 
  auto promise = std::make_shared<
      std::promise<std::shared_ptr<Pipeline<ComputePipelineDescriptor>>>>();
  auto pipeline_future = PipelineFuture<ComputePipelineDescriptor>{
      descriptor, promise->get_future()};
  compute_pipelines_[descriptor] = pipeline_future;
  auto weak_this = weak_from_this();
 
  auto completion_handler =
      ^(id<MTLComputePipelineState> _Nullable compute_pipeline_state,
        MTLComputePipelineReflection* _Nullable reflection,
        NSError* _Nullable error) {
        if (error != nil) {
          VALIDATION_LOG << "Could not create compute pipeline: "
                         << error.localizedDescription.UTF8String;
          promise->set_value(nullptr);
          return;
        }
 
        auto strong_this = weak_this.lock();
        if (!strong_this) {
          VALIDATION_LOG << "Library was collected before a pending pipeline "
                            "creation could finish.";
          promise->set_value(nullptr);
          return;
        }
 
        auto new_pipeline = std::shared_ptr<ComputePipelineMTL>(
            new ComputePipelineMTL(weak_this,
                                   descriptor,             //
                                   compute_pipeline_state  //
                                   ));
        promise->set_value(new_pipeline);
      };
  [device_
      newComputePipelineStateWithDescriptor:GetMTLComputePipelineDescriptor(
                                                descriptor)
                                    options:MTLPipelineOptionNone
                          completionHandler:completion_handler];
  return pipeline_future;
}

GetPipeline() [2/2]

PipelineFuture< PipelineDescriptor > impeller::PipelineLibraryMTL::GetPipeline ( PipelineDescriptor  descriptor )

overrideprivatevirtual

Implements impeller::PipelineLibrary.

Definition at line 111 of file pipeline_library_mtl.mm.

                                   {
  if (auto found = pipelines_.find(descriptor); found != pipelines_.end()) {
    return found->second;
  }
 
  if (!IsValid()) {
    return {
        descriptor,
        RealizedFuture<std::shared_ptr<Pipeline<PipelineDescriptor>>>(nullptr)};
  }
 
  auto promise = std::make_shared<
      std::promise<std::shared_ptr<Pipeline<PipelineDescriptor>>>>();
  auto pipeline_future =
      PipelineFuture<PipelineDescriptor>{descriptor, promise->get_future()};
  pipelines_[descriptor] = pipeline_future;
  auto weak_this = weak_from_this();
 
  auto completion_handler =
      ^(id<MTLRenderPipelineState> _Nullable render_pipeline_state,
        NSError* _Nullable error) {
        if (error != nil) {
          VALIDATION_LOG << "Could not create render pipeline for "
                         << descriptor.GetLabel() << " :"
                         << error.localizedDescription.UTF8String;
          promise->set_value(nullptr);
          return;
        }
 
        auto strong_this = weak_this.lock();
        if (!strong_this) {
          promise->set_value(nullptr);
          return;
        }
 
        auto new_pipeline = std::shared_ptr<PipelineMTL>(new PipelineMTL(
            weak_this,
            descriptor,                                        //
            render_pipeline_state,                             //
            CreateDepthStencilDescriptor(descriptor, device_)  //
            ));
        promise->set_value(new_pipeline);
      };
  GetMTLRenderPipelineDescriptor(
      descriptor, [device = device_, completion_handler](
                      MTLRenderPipelineDescriptor* descriptor) {
        [device newRenderPipelineStateWithDescriptor:descriptor
                                   completionHandler:completion_handler];
      });
  return pipeline_future;
}

IsValid()

bool impeller::PipelineLibraryMTL::IsValid ( ) const

overrideprivatevirtual

Implements impeller::PipelineLibrary.

Definition at line 106 of file pipeline_library_mtl.mm.

                                       {
  return device_ != nullptr;
}

RemovePipelinesWithEntryPoint()

void impeller::PipelineLibraryMTL::RemovePipelinesWithEntryPoint ( std::shared_ptr< const ShaderFunction >  function )

overrideprivatevirtual

Implements impeller::PipelineLibrary.

Definition at line 220 of file pipeline_library_mtl.mm.

                                                  {
  fml::erase_if(pipelines_, [&](auto item) {
    return item->first.GetEntrypointForStage(function->GetStage())
        ->IsEqual(*function);
  });
}

---

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

• impeller/renderer/backend/metal/pipeline_library_mtl.h
• impeller/renderer/backend/metal/pipeline_library_mtl.mm