flutter::gpu::RenderPass Class Reference

#include <render_pass.h>

Inheritance diagram for flutter::gpu::RenderPass:

Public Member Functions
	RenderPass ()
	~RenderPass () override
const std::shared_ptr< const impeller::Context > &	GetContext () const
impeller::Command &	GetCommand ()
const impeller::Command &	GetCommand () const
impeller::RenderTarget &	GetRenderTarget ()
const impeller::RenderTarget &	GetRenderTarget () const
impeller::ColorAttachmentDescriptor &	GetColorAttachmentDescriptor (size_t color_attachment_index)
impeller::DepthAttachmentDescriptor &	GetDepthAttachmentDescriptor ()
impeller::VertexBuffer &	GetVertexBuffer ()
bool	Begin (flutter::gpu::CommandBuffer &command_buffer)
void	SetPipeline (fml::RefPtr< RenderPipeline > pipeline)
std::shared_ptr< impeller::Pipeline< impeller::PipelineDescriptor > >	GetOrCreatePipeline ()
impeller::Command	ProvisionRasterCommand ()
bool	Draw ()
Public Member Functions inherited from flutter::RefCountedDartWrappable< RenderPass >
virtual void	RetainDartWrappableReference () const override
virtual void	ReleaseDartWrappableReference () const override
Public Member Functions inherited from fml::RefCountedThreadSafe< T >
void	Release () const
Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void	AddRef () const
bool	HasOneRef () const
void	AssertHasOneRef () const
Public Member Functions inherited from tonic::DartWrappable
	DartWrappable ()
virtual const DartWrapperInfo &	GetDartWrapperInfo () const =0
Dart_Handle	CreateDartWrapper (DartState *dart_state)
void	AssociateWithDartWrapper (Dart_Handle wrappable)
void	ClearDartWrapper ()
Dart_WeakPersistentHandle	dart_wrapper () const

Additional Inherited Members
Public Types inherited from tonic::DartWrappable
enum	DartNativeFields { kPeerIndex , kNumberOfNativeFields }
Protected Member Functions inherited from fml::RefCountedThreadSafe< T >
	RefCountedThreadSafe ()
	~RefCountedThreadSafe ()
Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
	RefCountedThreadSafeBase ()
	~RefCountedThreadSafeBase ()
bool	Release () const
void	Adopt ()
Protected Member Functions inherited from tonic::DartWrappable
virtual	~DartWrappable ()
Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle	GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)

Detailed Description

Definition at line 27 of file render_pass.h.

Constructor & Destructor Documentation

RenderPass()

flutter::gpu::RenderPass::RenderPass

(

)

Definition at line 25 of file render_pass.cc.

    : vertex_buffer_(
          impeller::VertexBuffer{.index_type = impeller::IndexType::kNone}){};

~RenderPass()

flutter::gpu::RenderPass::~RenderPass ( )

overridedefault

Member Function Documentation

Begin()

bool flutter::gpu::RenderPass::Begin

(

flutter::gpu::CommandBuffer &

command_buffer

)

Definition at line 69 of file render_pass.cc.

                                                              {
  render_pass_ =
      command_buffer.GetCommandBuffer()->CreateRenderPass(render_target_);
  if (!render_pass_) {
    return false;
  }
  command_buffer.AddRenderPass(render_pass_);
  return true;
}

Draw()

bool flutter::gpu::RenderPass::Draw

(

)

Definition at line 138 of file render_pass.cc.

                      {
  impeller::Command result = ProvisionRasterCommand();
#ifdef IMPELLER_DEBUG
  render_pass_->SetCommandLabel(result.label);
#endif  // IMPELLER_DEBUG
  render_pass_->SetPipeline(result.pipeline);
  render_pass_->SetStencilReference(result.stencil_reference);
  render_pass_->SetBaseVertex(result.base_vertex);
  if (result.viewport.has_value()) {
    render_pass_->SetViewport(result.viewport.value());
  }
  if (result.scissor.has_value()) {
    render_pass_->SetScissor(result.scissor.value());
  }
  render_pass_->SetVertexBuffer(result.vertex_buffer);
  for (const auto& buffer : result.vertex_bindings.buffers) {
    render_pass_->BindResource(impeller::ShaderStage::kVertex,
                               impeller::DescriptorType::kUniformBuffer,
                               buffer.slot, *buffer.view.GetMetadata(),
                               buffer.view.resource);
  }
  for (const auto& texture : result.vertex_bindings.sampled_images) {
    render_pass_->BindResource(impeller::ShaderStage::kVertex,
                               impeller::DescriptorType::kSampledImage,
                               texture.slot, *texture.texture.GetMetadata(),
                               texture.texture.resource, texture.sampler);
  }
  for (const auto& buffer : result.fragment_bindings.buffers) {
    render_pass_->BindResource(impeller::ShaderStage::kFragment,
                               impeller::DescriptorType::kUniformBuffer,
                               buffer.slot, *buffer.view.GetMetadata(),
                               buffer.view.resource);
  }
  for (const auto& texture : result.fragment_bindings.sampled_images) {
    render_pass_->BindResource(impeller::ShaderStage::kFragment,
                               impeller::DescriptorType::kSampledImage,
                               texture.slot, *texture.texture.GetMetadata(),
                               texture.texture.resource, texture.sampler);
  }
  return render_pass_->Draw().ok();
}

GetColorAttachmentDescriptor()

impeller::ColorAttachmentDescriptor & flutter::gpu::RenderPass::GetColorAttachmentDescriptor

(

size_t

color_attachment_index

)

Definition at line 51 of file render_pass.cc.

                                   {
  auto color = color_descriptors_.find(color_attachment_index);
  if (color == color_descriptors_.end()) {
    return color_descriptors_[color_attachment_index] = {};
  }
  return color->second;
}

GetCommand() [1/2]

impeller::Command & flutter::gpu::RenderPass::GetCommand

(

)

Definition at line 35 of file render_pass.cc.

                                        {
  return command_;
}

GetCommand() [2/2]

const impeller::Command & flutter::gpu::RenderPass::GetCommand

(

)

const

Definition at line 39 of file render_pass.cc.

                                                    {
  return command_;
}

GetContext()

const std::shared_ptr< const impeller::Context > & flutter::gpu::RenderPass::GetContext

(

)

const

Definition at line 31 of file render_pass.cc.

                                                                         {
  return render_pass_->GetContext();
}

GetDepthAttachmentDescriptor()

impeller::DepthAttachmentDescriptor & flutter::gpu::RenderPass::GetDepthAttachmentDescriptor

(

)

Definition at line 61 of file render_pass.cc.

                                         {
  return depth_desc_;
}

GetOrCreatePipeline()

std::shared_ptr< impeller::Pipeline< impeller::PipelineDescriptor > > flutter::gpu::RenderPass::GetOrCreatePipeline

(

)

Lookup an Impeller pipeline by building a descriptor based on the current command state.

Definition at line 84 of file render_pass.cc.

                                {
  // Infer the pipeline layout based on the shape of the RenderTarget.
  auto pipeline_desc = pipeline_descriptor_;
  for (const auto& it : render_target_.GetColorAttachments()) {
    auto& color = GetColorAttachmentDescriptor(it.first);
    color.format = render_target_.GetRenderTargetPixelFormat();
  }
  pipeline_desc.SetColorAttachmentDescriptors(color_descriptors_);
 
  {
    auto stencil = render_target_.GetStencilAttachment();
    if (stencil && impeller::IsStencilWritable(
                       stencil->texture->GetTextureDescriptor().format)) {
      pipeline_desc.SetStencilPixelFormat(
          stencil->texture->GetTextureDescriptor().format);
      pipeline_desc.SetStencilAttachmentDescriptors(stencil_front_desc_,
                                                    stencil_back_desc_);
    } else {
      pipeline_desc.ClearStencilAttachments();
    }
  }
 
  {
    auto depth = render_target_.GetDepthAttachment();
    if (depth && impeller::IsDepthWritable(
                     depth->texture->GetTextureDescriptor().format)) {
      pipeline_desc.SetDepthPixelFormat(
          depth->texture->GetTextureDescriptor().format);
      pipeline_desc.SetDepthStencilAttachmentDescriptor(depth_desc_);
    } else {
      pipeline_desc.ClearDepthAttachment();
    }
  }
 
  auto& context = *GetContext();
 
  render_pipeline_->BindToPipelineDescriptor(*context.GetShaderLibrary(),
                                             pipeline_desc);
 
  auto pipeline =
      context.GetPipelineLibrary()->GetPipeline(pipeline_desc).Get();
  FML_DCHECK(pipeline) << "Couldn't resolve render pipeline";
  return pipeline;
}

GetRenderTarget() [1/2]

impeller::RenderTarget & flutter::gpu::RenderPass::GetRenderTarget

(

)

Definition at line 43 of file render_pass.cc.

                                                  {
  return render_target_;
}

GetRenderTarget() [2/2]

const impeller::RenderTarget & flutter::gpu::RenderPass::GetRenderTarget

(

)

const

Definition at line 47 of file render_pass.cc.

                                                              {
  return render_target_;
}

GetVertexBuffer()

impeller::VertexBuffer & flutter::gpu::RenderPass::GetVertexBuffer

(

)

Definition at line 65 of file render_pass.cc.

                                                  {
  return vertex_buffer_;
}

ProvisionRasterCommand()

impeller::Command flutter::gpu::RenderPass::ProvisionRasterCommand

(

)

Definition at line 129 of file render_pass.cc.

                                                   {
  impeller::Command result = command_;
 
  result.pipeline = GetOrCreatePipeline();
  result.BindVertices(vertex_buffer_);
 
  return result;
}

SetPipeline()

void flutter::gpu::RenderPass::SetPipeline

(

fml::RefPtr< RenderPipeline >

pipeline

)

Definition at line 79 of file render_pass.cc.

                                                               {
  render_pipeline_ = std::move(pipeline);
}

---

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

• lib/gpu/render_pass.h
• lib/gpu/render_pass.cc