#include <render_pass.h>

Inheritance diagram for flutter::gpu::RenderPass:

Classes
struct	BufferAndUniformSlot

Public Types
using	BufferUniformMap = std::unordered_map< const flutter::gpu::Shader::UniformBinding *, BufferAndUniformSlot >

using	TextureUniformMap = std::unordered_map< const flutter::gpu::Shader::TextureBinding *, impeller::TextureAndSampler >

Public Types inherited from tonic::DartWrappable
enum	DartNativeFields { kPeerIndex , kNumberOfNativeFields }

Public Member Functions
	RenderPass ()

	~RenderPass () override

const std::shared_ptr< const impeller::Context > &	GetContext () const

impeller::RenderTarget &	GetRenderTarget ()

const impeller::RenderTarget &	GetRenderTarget () const

impeller::ColorAttachmentDescriptor &	GetColorAttachmentDescriptor (size_t color_attachment_index)

impeller::DepthAttachmentDescriptor &	GetDepthAttachmentDescriptor ()

impeller::StencilAttachmentDescriptor &	GetStencilFrontAttachmentDescriptor ()

impeller::StencilAttachmentDescriptor &	GetStencilBackAttachmentDescriptor ()

impeller::PipelineDescriptor &	GetPipelineDescriptor ()

bool	Begin (flutter::gpu::CommandBuffer &command_buffer)

void	SetPipeline (fml::RefPtr< RenderPipeline > pipeline)

void	ClearBindings ()

bool	Draw (size_t element_count, size_t instance_count, bool indexed)

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

Public Attributes
BufferUniformMap	vertex_uniform_bindings

TextureUniformMap	vertex_texture_bindings

BufferUniformMap	fragment_uniform_bindings

TextureUniformMap	fragment_texture_bindings

std::array< impeller::BufferView, kMaxVertexBufferSlots >	vertex_buffers

size_t	vertex_buffer_count = 0

impeller::BufferView	index_buffer

impeller::IndexType	index_buffer_type = impeller::IndexType::kNone

uint32_t	stencil_reference = 0

std::optional< impeller::IRect32 >	scissor

std::optional< impeller::Viewport >	viewport

Static Public Attributes
static constexpr size_t	kMaxVertexBufferSlots = 16

Additional Inherited Members
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 28 of file render_pass.h.

Member Typedef Documentation

◆ BufferUniformMap

using flutter::gpu::RenderPass::BufferUniformMap = std::unordered_map<const flutter::gpu::Shader::UniformBinding*, BufferAndUniformSlot>

Definition at line 69 of file render_pass.h.

◆ TextureUniformMap

using flutter::gpu::RenderPass::TextureUniformMap = std::unordered_map<const flutter::gpu::Shader::TextureBinding*, impeller::TextureAndSampler>

Definition at line 72 of file render_pass.h.

Constructor & Destructor Documentation

◆ RenderPass()

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

default

◆ ~RenderPass()

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

overridedefault

Member Function Documentation

◆ Begin()

bool flutter::gpu::RenderPass::Begin ( flutter::gpu::CommandBuffer & command_buffer )

Definition at line 76 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;
}

References command_buffer.

Referenced by InternalFlutterGpu_RenderPass_Begin().

◆ ClearBindings()

void flutter::gpu::RenderPass::ClearBindings ( )

Definition at line 92 of file render_pass.cc.

                               {
  vertex_uniform_bindings.clear();
  vertex_texture_bindings.clear();
  fragment_uniform_bindings.clear();
  fragment_texture_bindings.clear();
  for (auto& buffer : vertex_buffers) {
    buffer = {};
  }
  vertex_buffer_count = 0;
  index_buffer = {};
  index_buffer_type = impeller::IndexType::kNone;
}

References flutter::buffer, fragment_texture_bindings, fragment_uniform_bindings, index_buffer, index_buffer_type, impeller::kNone, vertex_buffer_count, vertex_buffers, vertex_texture_bindings, and vertex_uniform_bindings.

Referenced by InternalFlutterGpu_RenderPass_ClearBindings().

◆ Draw()

bool flutter::gpu::RenderPass::Draw	(	size_t	element_count,
		size_t	instance_count,
		bool	indexed
	)

Append a draw to the underlying render pass. [element_count] is the vertex count for a non-indexed draw, or the index count when [indexed] is true. [instance_count] is the number of instances to draw.

Definition at line 185 of file render_pass.cc.

                                    {
  if (element_count == 0u || instance_count == 0u) {
    return true;
  }
 
  if (indexed && index_buffer_type == impeller::IndexType::kNone) {
    // drawIndexed was called without an index buffer bound.
    return false;
  }
 
  render_pass_->SetPipeline(impeller::PipelineRef(GetOrCreatePipeline()));
 
  for (const auto& [_, buffer] : vertex_uniform_bindings) {
    render_pass_->BindDynamicResource(
        impeller::ShaderStage::kVertex,
        impeller::DescriptorType::kUniformBuffer, buffer.slot,
        std::make_unique<impeller::ShaderMetadata>(*buffer.view.GetMetadata()),
        buffer.view.resource);
  }
  for (const auto& [_, texture] : vertex_texture_bindings) {
    render_pass_->BindDynamicResource(
        impeller::ShaderStage::kVertex, impeller::DescriptorType::kSampledImage,
        texture.slot,
        std::make_unique<impeller::ShaderMetadata>(
            *texture.texture.GetMetadata()),
        texture.texture.resource, texture.sampler);
  }
  for (const auto& [_, buffer] : fragment_uniform_bindings) {
    render_pass_->BindDynamicResource(
        impeller::ShaderStage::kFragment,
        impeller::DescriptorType::kUniformBuffer, buffer.slot,
        std::make_unique<impeller::ShaderMetadata>(*buffer.view.GetMetadata()),
        buffer.view.resource);
  }
  for (const auto& [_, texture] : fragment_texture_bindings) {
    render_pass_->BindDynamicResource(
        impeller::ShaderStage::kFragment,
        impeller::DescriptorType::kSampledImage, texture.slot,
        std::make_unique<impeller::ShaderMetadata>(
            *texture.texture.GetMetadata()),
        texture.texture.resource, texture.sampler);
  }
 
  render_pass_->SetVertexBuffer(vertex_buffers.data(), vertex_buffer_count);
  if (indexed) {
    render_pass_->SetIndexBuffer(index_buffer, index_buffer_type);
  } else {
    render_pass_->SetIndexBuffer(impeller::BufferView{},
                                 impeller::IndexType::kNone);
  }
  render_pass_->SetElementCount(element_count);
  render_pass_->SetInstanceCount(instance_count);
 
  render_pass_->SetStencilReference(stencil_reference);
 
  if (viewport.has_value()) {
    render_pass_->SetViewport(viewport.value());
  }
 
  if (scissor.has_value()) {
    render_pass_->SetScissor(scissor.value());
  }
 
  bool result = render_pass_->Draw().ok();
 
  return result;
}

References flutter::buffer, fragment_texture_bindings, fragment_uniform_bindings, index_buffer, index_buffer_type, impeller::kFragment, impeller::kNone, impeller::kSampledImage, impeller::kUniformBuffer, impeller::kVertex, scissor, stencil_reference, texture, vertex_buffer_count, vertex_buffers, vertex_texture_bindings, vertex_uniform_bindings, and viewport.

Referenced by InternalFlutterGpu_RenderPass_Draw(), and InternalFlutterGpu_RenderPass_DrawIndexed().

◆ GetColorAttachmentDescriptor()

impeller::ColorAttachmentDescriptor & flutter::gpu::RenderPass::GetColorAttachmentDescriptor ( size_t color_attachment_index )

Definition at line 48 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;
}

Referenced by InternalFlutterGpu_RenderPass_SetColorBlendEnable(), and InternalFlutterGpu_RenderPass_SetColorBlendEquation().

◆ GetContext()

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

Definition at line 36 of file render_pass.cc.

                                                                         {
  return render_pass_->GetContext();
}

Referenced by InternalFlutterGpu_RenderPass_BindTexture().

◆ GetDepthAttachmentDescriptor()

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

Definition at line 58 of file render_pass.cc.

                                         {
  return depth_desc_;
}

Referenced by InternalFlutterGpu_RenderPass_SetDepthCompareOperation(), and InternalFlutterGpu_RenderPass_SetDepthWriteEnable().

◆ GetPipelineDescriptor()

impeller::PipelineDescriptor & flutter::gpu::RenderPass::GetPipelineDescriptor ( )

Definition at line 72 of file render_pass.cc.

                                                              {
  return pipeline_descriptor_;
}

Referenced by InternalFlutterGpu_RenderPass_SetCullMode(), InternalFlutterGpu_RenderPass_SetPolygonMode(), InternalFlutterGpu_RenderPass_SetPrimitiveType(), and InternalFlutterGpu_RenderPass_SetWindingOrder().

◆ GetRenderTarget() [1/2]

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

Definition at line 40 of file render_pass.cc.

                                                  {
  return render_target_;
}

Referenced by InternalFlutterGpu_RenderPass_SetColorAttachment(), and InternalFlutterGpu_RenderPass_SetDepthStencilAttachment().

◆ GetRenderTarget() [2/2]

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

Definition at line 44 of file render_pass.cc.

                                                              {
  return render_target_;
}

◆ GetStencilBackAttachmentDescriptor()

impeller::StencilAttachmentDescriptor & flutter::gpu::RenderPass::GetStencilBackAttachmentDescriptor ( )

Definition at line 68 of file render_pass.cc.

                                               {
  return stencil_back_desc_;
}

Referenced by InternalFlutterGpu_RenderPass_SetStencilConfig().

◆ GetStencilFrontAttachmentDescriptor()

impeller::StencilAttachmentDescriptor & flutter::gpu::RenderPass::GetStencilFrontAttachmentDescriptor ( )

Definition at line 63 of file render_pass.cc.

                                                {
  return stencil_front_desc_;
}

Referenced by InternalFlutterGpu_RenderPass_SetStencilConfig().

◆ SetPipeline()

void flutter::gpu::RenderPass::SetPipeline ( fml::RefPtr< RenderPipeline > pipeline )

Definition at line 86 of file render_pass.cc.

                                                               {
  // On debug this makes a difference, but not on release builds.
  // NOLINTNEXTLINE(performance-move-const-arg)
  render_pipeline_ = std::move(pipeline);
}