impeller::RenderPipelineHandle< VertexShader_, FragmentShader_ > Class Template Reference

#include <pipeline.h>

Public Types
using	VertexShader = VertexShader_
using	FragmentShader = FragmentShader_
using	Builder = PipelineBuilder< VertexShader, FragmentShader >

Public Member Functions
	RenderPipelineHandle (const Context &context, bool async=true)
	RenderPipelineHandle (const Context &context, std::optional< PipelineDescriptor > desc, bool async=true)
	RenderPipelineHandle (PipelineFuture< PipelineDescriptor > future)
std::shared_ptr< Pipeline< PipelineDescriptor > >	WaitAndGet ()
std::optional< PipelineDescriptor >	GetDescriptor () const

Detailed Description

template<class VertexShader_, class FragmentShader_>
class impeller::RenderPipelineHandle< VertexShader_, FragmentShader_ >

Holds a reference to a Pipeline used for rendering while also maintaining the vertex shader and fragment shader types at compile-time.

See also:

• impeller::ContentContext::Variants - the typical container for RenderPipelineHandles.

Definition at line 117 of file pipeline.h.

Member Typedef Documentation

Builder

template<class VertexShader_ , class FragmentShader_ >

using impeller::RenderPipelineHandle< VertexShader_, FragmentShader_ >::Builder = PipelineBuilder<VertexShader, FragmentShader>

Definition at line 121 of file pipeline.h.

FragmentShader

template<class VertexShader_ , class FragmentShader_ >

using impeller::RenderPipelineHandle< VertexShader_, FragmentShader_ >::FragmentShader = FragmentShader_

Definition at line 120 of file pipeline.h.

VertexShader

template<class VertexShader_ , class FragmentShader_ >

using impeller::RenderPipelineHandle< VertexShader_, FragmentShader_ >::VertexShader = VertexShader_

Definition at line 119 of file pipeline.h.

Constructor & Destructor Documentation

RenderPipelineHandle() [1/3]

template<class VertexShader_ , class FragmentShader_ >

impeller::RenderPipelineHandle< VertexShader_, FragmentShader_ >::RenderPipelineHandle ( const Context &  context, bool  async = true  )

inlineexplicit

Definition at line 123 of file pipeline.h.

      : RenderPipelineHandle(CreatePipelineFuture(
            context,
            Builder::MakeDefaultPipelineDescriptor(context),
            async)) {}

RenderPipelineHandle() [2/3]

template<class VertexShader_ , class FragmentShader_ >

impeller::RenderPipelineHandle< VertexShader_, FragmentShader_ >::RenderPipelineHandle ( const Context &  context, std::optional< PipelineDescriptor >  desc, bool  async = true  )

inlineexplicit

Definition at line 129 of file pipeline.h.

      : RenderPipelineHandle(
            CreatePipelineFuture(context, desc, /*async=*/async)) {}

RenderPipelineHandle() [3/3]

template<class VertexShader_ , class FragmentShader_ >

impeller::RenderPipelineHandle< VertexShader_, FragmentShader_ >::RenderPipelineHandle ( PipelineFuture< PipelineDescriptor >  future )

inlineexplicit

Definition at line 135 of file pipeline.h.

      : pipeline_future_(std::move(future)) {}

Member Function Documentation

GetDescriptor()

template<class VertexShader_ , class FragmentShader_ >

std::optional<PipelineDescriptor> impeller::RenderPipelineHandle< VertexShader_, FragmentShader_ >::GetDescriptor ( ) const

inline

Definition at line 149 of file pipeline.h.

                                                        {
    return pipeline_future_.descriptor;
  }

WaitAndGet()

template<class VertexShader_ , class FragmentShader_ >

std::shared_ptr<Pipeline<PipelineDescriptor> > impeller::RenderPipelineHandle< VertexShader_, FragmentShader_ >::WaitAndGet ( )

inline

Definition at line 138 of file pipeline.h.

                                                           {
    if (did_wait_) {
      return pipeline_;
    }
    did_wait_ = true;
    if (pipeline_future_.IsValid()) {
      pipeline_ = pipeline_future_.Get();
    }
    return pipeline_;
  }

---

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

• impeller/renderer/pipeline.h