impeller::Pipeline< T > Class Template Reference

Describes the fixed function and programmable aspects of rendering and compute operations performed by commands submitted to the GPU via a command buffer. More...

#include <pipeline.h>

Public Member Functions
virtual	~Pipeline ()
virtual bool	IsValid () const =0
const T &	GetDescriptor () const
	Get the descriptor that was responsible for creating this pipeline. It may be copied and modified to create a pipeline variant.
PipelineFuture< T >	CreateVariant (std::function< void(T &desc)> descriptor_callback) const

Protected Member Functions
	Pipeline (std::weak_ptr< PipelineLibrary > library, T desc)

Protected Attributes
const std::weak_ptr< PipelineLibrary >	library_
const T	desc_

Detailed Description

template<typename T>
class impeller::Pipeline< T >

Describes the fixed function and programmable aspects of rendering and compute operations performed by commands submitted to the GPU via a command buffer.

A pipeline handle must be allocated upfront and kept alive for as long as possible. Do not create a pipeline object within a frame workload.

This pipeline object is almost never used directly as it is untyped. Use reflected shader information generated by the Impeller offline shader compiler to generate a typed pipeline object.

Definition at line 49 of file pipeline.h.

Constructor & Destructor Documentation

~Pipeline()

template<typename T >

impeller::Pipeline< T >::~Pipeline ( )

virtualdefault

Pipeline()

template<typename T >

impeller::Pipeline< T >::Pipeline ( std::weak_ptr< PipelineLibrary >  library, T  desc  )

protected

Definition at line 18 of file pipeline.cc.

    : library_(std::move(library)), desc_(std::move(desc)) {}

Member Function Documentation

CreateVariant()

template<typename T >

PipelineFuture< T > impeller::Pipeline< T >::CreateVariant

(

std::function< void(T &desc)>

descriptor_callback

)

const

Definition at line 54 of file pipeline.cc.

                                                          {
  if (!descriptor_callback) {
    return {std::nullopt,
            RealizedFuture<std::shared_ptr<Pipeline<T>>>(nullptr)};
  }
 
  auto copied_desc = desc_;
 
  descriptor_callback(copied_desc);
 
  auto library = library_.lock();
  if (!library) {
    VALIDATION_LOG << "The library from which this pipeline was created was "
                      "already collected.";
    return {desc_, RealizedFuture<std::shared_ptr<Pipeline<T>>>(nullptr)};
  }
 
  return library->GetPipeline(std::move(copied_desc));
}

GetDescriptor()

template<typename T >

const T & impeller::Pipeline< T >::GetDescriptor

(

)

const

Get the descriptor that was responsible for creating this pipeline. It may be copied and modified to create a pipeline variant.

Returns

The descriptor.

Definition at line 49 of file pipeline.cc.

                                          {
  return desc_;
}

IsValid()

template<typename T >

virtual bool impeller::Pipeline< T >::IsValid ( ) const

pure virtual

Implemented in impeller::PipelineGLES, impeller::ComputePipelineMTL, impeller::PipelineMTL, impeller::ComputePipelineVK, and impeller::PipelineVK.

Member Data Documentation

desc_

template<typename T >

const T impeller::Pipeline< T >::desc_

protected

Definition at line 70 of file pipeline.h.

library_

template<typename T >

const std::weak_ptr<PipelineLibrary> impeller::Pipeline< T >::library_

protected

Definition at line 68 of file pipeline.h.

---

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

• impeller/renderer/compute_pipeline_descriptor.h
• impeller/renderer/pipeline.h
• impeller/renderer/pipeline.cc