render_pass.cc File Reference

#include "flutter/lib/gpu/render_pass.h"
#include "flutter/lib/gpu/formats.h"
#include "flutter/lib/gpu/render_pipeline.h"
#include "flutter/lib/gpu/shader.h"
#include "fml/memory/ref_ptr.h"
#include "impeller/core/buffer_view.h"
#include "impeller/core/formats.h"
#include "impeller/core/sampler_descriptor.h"
#include "impeller/core/shader_types.h"
#include "impeller/core/vertex_buffer.h"
#include "impeller/geometry/color.h"
#include "impeller/renderer/pipeline_library.h"
#include "tonic/converter/dart_converter.h"

Go to the source code of this file.

Namespaces
namespace	flutter
namespace	flutter::gpu

Functions
	flutter::gpu::IMPLEMENT_WRAPPERTYPEINFO (flutter_gpu, RenderPass)
static impeller::Color	ToImpellerColor (uint32_t argb)
void	InternalFlutterGpu_RenderPass_Initialize (Dart_Handle wrapper)
Dart_Handle	InternalFlutterGpu_RenderPass_SetColorAttachment (flutter::gpu::RenderPass *wrapper, int color_attachment_index, int load_action, int store_action, int clear_color, flutter::gpu::Texture *texture, Dart_Handle resolve_texture_wrapper)
Dart_Handle	InternalFlutterGpu_RenderPass_SetDepthStencilAttachment (flutter::gpu::RenderPass *wrapper, int depth_load_action, int depth_store_action, float depth_clear_value, int stencil_load_action, int stencil_store_action, int stencil_clear_value, flutter::gpu::Texture *texture)
Dart_Handle	InternalFlutterGpu_RenderPass_Begin (flutter::gpu::RenderPass *wrapper, flutter::gpu::CommandBuffer *command_buffer)
void	InternalFlutterGpu_RenderPass_BindPipeline (flutter::gpu::RenderPass *wrapper, flutter::gpu::RenderPipeline *pipeline)
template<typename TBuffer >
static void	BindVertexBuffer (flutter::gpu::RenderPass *wrapper, TBuffer buffer, int offset_in_bytes, int length_in_bytes, int vertex_count)
void	InternalFlutterGpu_RenderPass_BindVertexBufferDevice (flutter::gpu::RenderPass *wrapper, flutter::gpu::DeviceBuffer *device_buffer, int offset_in_bytes, int length_in_bytes, int vertex_count)
void	InternalFlutterGpu_RenderPass_BindVertexBufferHost (flutter::gpu::RenderPass *wrapper, flutter::gpu::HostBuffer *host_buffer, int offset_in_bytes, int length_in_bytes, int vertex_count)
template<typename TBuffer >
static void	BindIndexBuffer (flutter::gpu::RenderPass *wrapper, TBuffer buffer, int offset_in_bytes, int length_in_bytes, int index_type, int index_count)
void	InternalFlutterGpu_RenderPass_BindIndexBufferDevice (flutter::gpu::RenderPass *wrapper, flutter::gpu::DeviceBuffer *device_buffer, int offset_in_bytes, int length_in_bytes, int index_type, int index_count)
void	InternalFlutterGpu_RenderPass_BindIndexBufferHost (flutter::gpu::RenderPass *wrapper, flutter::gpu::HostBuffer *host_buffer, int offset_in_bytes, int length_in_bytes, int index_type, int index_count)
template<typename TBuffer >
static bool	BindUniform (flutter::gpu::RenderPass *wrapper, flutter::gpu::Shader *shader, Dart_Handle uniform_name_handle, TBuffer buffer, int offset_in_bytes, int length_in_bytes)
bool	InternalFlutterGpu_RenderPass_BindUniformDevice (flutter::gpu::RenderPass *wrapper, flutter::gpu::Shader *shader, Dart_Handle uniform_name_handle, flutter::gpu::DeviceBuffer *device_buffer, int offset_in_bytes, int length_in_bytes)
bool	InternalFlutterGpu_RenderPass_BindUniformHost (flutter::gpu::RenderPass *wrapper, flutter::gpu::Shader *shader, Dart_Handle uniform_name_handle, flutter::gpu::HostBuffer *host_buffer, int offset_in_bytes, int length_in_bytes)
bool	InternalFlutterGpu_RenderPass_BindTexture (flutter::gpu::RenderPass *wrapper, flutter::gpu::Shader *shader, Dart_Handle uniform_name_handle, flutter::gpu::Texture *texture, int min_filter, int mag_filter, int mip_filter, int width_address_mode, int height_address_mode)
void	InternalFlutterGpu_RenderPass_ClearBindings (flutter::gpu::RenderPass *wrapper)
void	InternalFlutterGpu_RenderPass_SetColorBlendEnable (flutter::gpu::RenderPass *wrapper, int color_attachment_index, bool enable)
void	InternalFlutterGpu_RenderPass_SetColorBlendEquation (flutter::gpu::RenderPass *wrapper, int color_attachment_index, int color_blend_operation, int source_color_blend_factor, int destination_color_blend_factor, int alpha_blend_operation, int source_alpha_blend_factor, int destination_alpha_blend_factor)
void	InternalFlutterGpu_RenderPass_SetDepthWriteEnable (flutter::gpu::RenderPass *wrapper, bool enable)
void	InternalFlutterGpu_RenderPass_SetDepthCompareOperation (flutter::gpu::RenderPass *wrapper, int compare_operation)
bool	InternalFlutterGpu_RenderPass_Draw (flutter::gpu::RenderPass *wrapper)

Function Documentation

BindIndexBuffer()

template<typename TBuffer >

static void BindIndexBuffer ( flutter::gpu::RenderPass *  wrapper, TBuffer  buffer, int  offset_in_bytes, int  length_in_bytes, int  index_type, int  index_count  )

static

Definition at line 321 of file render_pass.cc.

                                             {
  auto& vertex_buffer = wrapper->GetVertexBuffer();
  vertex_buffer.index_buffer = impeller::BufferView{
      .buffer = buffer,
      .range = impeller::Range(offset_in_bytes, length_in_bytes),
  };
  vertex_buffer.index_type = flutter::gpu::ToImpellerIndexType(index_type);
  vertex_buffer.vertex_count = index_count;
}

BindUniform()

template<typename TBuffer >

static bool BindUniform ( flutter::gpu::RenderPass *  wrapper, flutter::gpu::Shader *  shader, Dart_Handle  uniform_name_handle, TBuffer  buffer, int  offset_in_bytes, int  length_in_bytes  )

static

Definition at line 366 of file render_pass.cc.

                                             {
  auto& command = wrapper->GetCommand();
 
  auto uniform_name = tonic::StdStringFromDart(uniform_name_handle);
  const flutter::gpu::Shader::UniformBinding* uniform_struct =
      shader->GetUniformStruct(uniform_name);
  // TODO(bdero): Return an error string stating that no uniform struct with
  //              this name exists and throw an exception.
  if (!uniform_struct) {
    return false;
  }
 
  return command.BindResource(
      shader->GetShaderStage(), impeller::DescriptorType::kUniformBuffer,
      uniform_struct->slot, uniform_struct->metadata,
      impeller::BufferView{
          .buffer = buffer,
          .range = impeller::Range(offset_in_bytes, length_in_bytes),
      });
}

BindVertexBuffer()

template<typename TBuffer >

static void BindVertexBuffer ( flutter::gpu::RenderPass *  wrapper, TBuffer  buffer, int  offset_in_bytes, int  length_in_bytes, int  vertex_count  )

static

Definition at line 269 of file render_pass.cc.

                                               {
  auto& vertex_buffer = wrapper->GetVertexBuffer();
  vertex_buffer.vertex_buffer = impeller::BufferView{
      .buffer = buffer,
      .range = impeller::Range(offset_in_bytes, length_in_bytes),
  };
  // If the index type is set, then the `vertex_count` becomes the index
  // count... So don't overwrite the count if it's already been set when binding
  // the index buffer.
  // TODO(bdero): Consider just doing a more traditional API with
  //              draw(vertexCount) and drawIndexed(indexCount). This is fine,
  //              but overall it would be a bit more explicit and we wouldn't
  //              have to document this behavior where the presence of the index
  //              buffer always takes precedent.
  if (vertex_buffer.index_type == impeller::IndexType::kNone) {
    vertex_buffer.vertex_count = vertex_count;
  }
}

InternalFlutterGpu_RenderPass_Begin()

Dart_Handle InternalFlutterGpu_RenderPass_Begin	(	flutter::gpu::RenderPass *	wrapper,
		flutter::gpu::CommandBuffer *	command_buffer
	)

Definition at line 252 of file render_pass.cc.

                                             {
  if (!wrapper->Begin(*command_buffer)) {
    return tonic::ToDart("Failed to begin RenderPass");
  }
  return Dart_Null();
}

InternalFlutterGpu_RenderPass_BindIndexBufferDevice()

void InternalFlutterGpu_RenderPass_BindIndexBufferDevice	(	flutter::gpu::RenderPass *	wrapper,
		flutter::gpu::DeviceBuffer *	device_buffer,
		int	offset_in_bytes,
		int	length_in_bytes,
		int	index_type,
		int	index_count
	)

Definition at line 336 of file render_pass.cc.

                     {
  BindIndexBuffer(wrapper, device_buffer->GetBuffer(), offset_in_bytes,
                  length_in_bytes, index_type, index_count);
}

InternalFlutterGpu_RenderPass_BindIndexBufferHost()

void InternalFlutterGpu_RenderPass_BindIndexBufferHost	(	flutter::gpu::RenderPass *	wrapper,
		flutter::gpu::HostBuffer *	host_buffer,
		int	offset_in_bytes,
		int	length_in_bytes,
		int	index_type,
		int	index_count
	)

Definition at line 347 of file render_pass.cc.

                     {
  auto view = host_buffer->GetBufferViewForOffset(offset_in_bytes);
  if (!view.has_value()) {
    FML_LOG(ERROR)
        << "Failed to bind index buffer due to invalid HostBuffer offset: "
        << offset_in_bytes;
    return;
  }
  BindIndexBuffer(wrapper, view->buffer, view->range.offset, view->range.length,
                  index_type, index_count);
}

InternalFlutterGpu_RenderPass_BindPipeline()

void InternalFlutterGpu_RenderPass_BindPipeline	(	flutter::gpu::RenderPass *	wrapper,
		flutter::gpu::RenderPipeline *	pipeline
	)

Definition at line 261 of file render_pass.cc.

                                        {
  auto ref = fml::RefPtr<flutter::gpu::RenderPipeline>(pipeline);
  wrapper->SetPipeline(std::move(ref));
}

InternalFlutterGpu_RenderPass_BindTexture()

bool InternalFlutterGpu_RenderPass_BindTexture	(	flutter::gpu::RenderPass *	wrapper,
		flutter::gpu::Shader *	shader,
		Dart_Handle	uniform_name_handle,
		flutter::gpu::Texture *	texture,
		int	min_filter,
		int	mag_filter,
		int	mip_filter,
		int	width_address_mode,
		int	height_address_mode
	)

Definition at line 422 of file render_pass.cc.

                             {
  auto& command = wrapper->GetCommand();
 
  auto uniform_name = tonic::StdStringFromDart(uniform_name_handle);
  const impeller::SampledImageSlot* image_slot =
      shader->GetUniformTexture(uniform_name);
  // TODO(bdero): Return an error string stating that no uniform texture with
  //              this name exists and throw an exception.
  if (!image_slot) {
    return false;
  }
 
  impeller::SamplerDescriptor sampler_desc;
  sampler_desc.min_filter = flutter::gpu::ToImpellerMinMagFilter(min_filter);
  sampler_desc.mag_filter = flutter::gpu::ToImpellerMinMagFilter(mag_filter);
  sampler_desc.mip_filter = flutter::gpu::ToImpellerMipFilter(mip_filter);
  sampler_desc.width_address_mode =
      flutter::gpu::ToImpellerSamplerAddressMode(width_address_mode);
  sampler_desc.height_address_mode =
      flutter::gpu::ToImpellerSamplerAddressMode(height_address_mode);
  const std::unique_ptr<const impeller::Sampler>& sampler =
      wrapper->GetContext()->GetSamplerLibrary()->GetSampler(sampler_desc);
 
  return command.BindResource(
      shader->GetShaderStage(), impeller::DescriptorType::kSampledImage,
      *image_slot, impeller::ShaderMetadata{}, texture->GetTexture(), sampler);
}

InternalFlutterGpu_RenderPass_BindUniformDevice()

bool InternalFlutterGpu_RenderPass_BindUniformDevice	(	flutter::gpu::RenderPass *	wrapper,
		flutter::gpu::Shader *	shader,
		Dart_Handle	uniform_name_handle,
		flutter::gpu::DeviceBuffer *	device_buffer,
		int	offset_in_bytes,
		int	length_in_bytes
	)

Definition at line 392 of file render_pass.cc.

                         {
  return BindUniform(wrapper, shader, uniform_name_handle,
                     device_buffer->GetBuffer(), offset_in_bytes,
                     length_in_bytes);
}

InternalFlutterGpu_RenderPass_BindUniformHost()

bool InternalFlutterGpu_RenderPass_BindUniformHost	(	flutter::gpu::RenderPass *	wrapper,
		flutter::gpu::Shader *	shader,
		Dart_Handle	uniform_name_handle,
		flutter::gpu::HostBuffer *	host_buffer,
		int	offset_in_bytes,
		int	length_in_bytes
	)

Definition at line 404 of file render_pass.cc.

                         {
  auto view = host_buffer->GetBufferViewForOffset(offset_in_bytes);
  if (!view.has_value()) {
    FML_LOG(ERROR)
        << "Failed to bind index buffer due to invalid HostBuffer offset: "
        << offset_in_bytes;
    return false;
  }
  return BindUniform(wrapper, shader, uniform_name_handle, view->buffer,
                     view->range.offset, view->range.length);
}

InternalFlutterGpu_RenderPass_BindVertexBufferDevice()

void InternalFlutterGpu_RenderPass_BindVertexBufferDevice	(	flutter::gpu::RenderPass *	wrapper,
		flutter::gpu::DeviceBuffer *	device_buffer,
		int	offset_in_bytes,
		int	length_in_bytes,
		int	vertex_count
	)

Definition at line 292 of file render_pass.cc.

                      {
  BindVertexBuffer(wrapper, device_buffer->GetBuffer(), offset_in_bytes,
                   length_in_bytes, vertex_count);
}

InternalFlutterGpu_RenderPass_BindVertexBufferHost()

void InternalFlutterGpu_RenderPass_BindVertexBufferHost	(	flutter::gpu::RenderPass *	wrapper,
		flutter::gpu::HostBuffer *	host_buffer,
		int	offset_in_bytes,
		int	length_in_bytes,
		int	vertex_count
	)

Definition at line 302 of file render_pass.cc.

                      {
  std::optional<impeller::BufferView> view =
      host_buffer->GetBufferViewForOffset(offset_in_bytes);
  if (!view.has_value()) {
    FML_LOG(ERROR)
        << "Failed to bind vertex buffer due to invalid HostBuffer offset: "
        << offset_in_bytes;
    return;
  }
  BindVertexBuffer(wrapper, view->buffer, view->range.offset,
                   view->range.length, vertex_count);
}

InternalFlutterGpu_RenderPass_ClearBindings()

void InternalFlutterGpu_RenderPass_ClearBindings

(

flutter::gpu::RenderPass *

wrapper

)

Definition at line 459 of file render_pass.cc.

                                   {
  auto& command = wrapper->GetCommand();
  command.vertex_buffer = {};
  command.vertex_bindings = {};
  command.fragment_bindings = {};
}

InternalFlutterGpu_RenderPass_Draw()

bool InternalFlutterGpu_RenderPass_Draw

(

flutter::gpu::RenderPass *

wrapper

)

Definition at line 514 of file render_pass.cc.

                                                                       {
  return wrapper->Draw();
}

InternalFlutterGpu_RenderPass_Initialize()

void InternalFlutterGpu_RenderPass_Initialize

(

Dart_Handle

wrapper

)

Exports

Definition at line 194 of file render_pass.cc.

                                                                   {
  auto res = fml::MakeRefCounted<flutter::gpu::RenderPass>();
  res->AssociateWithDartWrapper(wrapper);
}

InternalFlutterGpu_RenderPass_SetColorAttachment()

Dart_Handle InternalFlutterGpu_RenderPass_SetColorAttachment	(	flutter::gpu::RenderPass *	wrapper,
		int	color_attachment_index,
		int	load_action,
		int	store_action,
		int	clear_color,
		flutter::gpu::Texture *	texture,
		Dart_Handle	resolve_texture_wrapper
	)

Definition at line 199 of file render_pass.cc.

                                         {
  impeller::ColorAttachment desc;
  desc.load_action = flutter::gpu::ToImpellerLoadAction(load_action);
  desc.store_action = flutter::gpu::ToImpellerStoreAction(store_action);
  desc.clear_color = ToImpellerColor(static_cast<uint32_t>(clear_color));
  desc.texture = texture->GetTexture();
  if (!Dart_IsNull(resolve_texture_wrapper)) {
    flutter::gpu::Texture* resolve_texture =
        tonic::DartConverter<flutter::gpu::Texture*>::FromDart(
            resolve_texture_wrapper);
    desc.resolve_texture = resolve_texture->GetTexture();
  }
  wrapper->GetRenderTarget().SetColorAttachment(desc, color_attachment_index);
  return Dart_Null();
}

InternalFlutterGpu_RenderPass_SetColorBlendEnable()

void InternalFlutterGpu_RenderPass_SetColorBlendEnable	(	flutter::gpu::RenderPass *	wrapper,
		int	color_attachment_index,
		bool	enable
	)

Definition at line 467 of file render_pass.cc.

                 {
  auto& color = wrapper->GetColorAttachmentDescriptor(color_attachment_index);
  color.blending_enabled = enable;
}

InternalFlutterGpu_RenderPass_SetColorBlendEquation()

void InternalFlutterGpu_RenderPass_SetColorBlendEquation	(	flutter::gpu::RenderPass *	wrapper,
		int	color_attachment_index,
		int	color_blend_operation,
		int	source_color_blend_factor,
		int	destination_color_blend_factor,
		int	alpha_blend_operation,
		int	source_alpha_blend_factor,
		int	destination_alpha_blend_factor
	)

Definition at line 475 of file render_pass.cc.

                                        {
  auto& color = wrapper->GetColorAttachmentDescriptor(color_attachment_index);
  color.color_blend_op =
      flutter::gpu::ToImpellerBlendOperation(color_blend_operation);
  color.src_color_blend_factor =
      flutter::gpu::ToImpellerBlendFactor(source_color_blend_factor);
  color.dst_color_blend_factor =
      flutter::gpu::ToImpellerBlendFactor(destination_color_blend_factor);
  color.alpha_blend_op =
      flutter::gpu::ToImpellerBlendOperation(alpha_blend_operation);
  color.src_alpha_blend_factor =
      flutter::gpu::ToImpellerBlendFactor(source_alpha_blend_factor);
  color.dst_alpha_blend_factor =
      flutter::gpu::ToImpellerBlendFactor(destination_alpha_blend_factor);
}

InternalFlutterGpu_RenderPass_SetDepthCompareOperation()

void InternalFlutterGpu_RenderPass_SetDepthCompareOperation	(	flutter::gpu::RenderPass *	wrapper,
		int	compare_operation
	)

Definition at line 506 of file render_pass.cc.

                           {
  auto& depth = wrapper->GetDepthAttachmentDescriptor();
  depth.depth_compare =
      flutter::gpu::ToImpellerCompareFunction(compare_operation);
}

InternalFlutterGpu_RenderPass_SetDepthStencilAttachment()

Dart_Handle InternalFlutterGpu_RenderPass_SetDepthStencilAttachment	(	flutter::gpu::RenderPass *	wrapper,
		int	depth_load_action,
		int	depth_store_action,
		float	depth_clear_value,
		int	stencil_load_action,
		int	stencil_store_action,
		int	stencil_clear_value,
		flutter::gpu::Texture *	texture
	)

Definition at line 222 of file render_pass.cc.

                                {
  {
    impeller::DepthAttachment desc;
    desc.load_action = flutter::gpu::ToImpellerLoadAction(depth_load_action);
    desc.store_action = flutter::gpu::ToImpellerStoreAction(depth_store_action);
    desc.clear_depth = depth_clear_value;
    desc.texture = texture->GetTexture();
    wrapper->GetRenderTarget().SetDepthAttachment(desc);
  }
  {
    impeller::StencilAttachment desc;
    desc.load_action = flutter::gpu::ToImpellerLoadAction(stencil_load_action);
    desc.store_action =
        flutter::gpu::ToImpellerStoreAction(stencil_store_action);
    desc.clear_stencil = stencil_clear_value;
    desc.texture = texture->GetTexture();
    wrapper->GetRenderTarget().SetStencilAttachment(desc);
  }
 
  return Dart_Null();
}

InternalFlutterGpu_RenderPass_SetDepthWriteEnable()

void InternalFlutterGpu_RenderPass_SetDepthWriteEnable	(	flutter::gpu::RenderPass *	wrapper,
		bool	enable
	)

Definition at line 499 of file render_pass.cc.

                 {
  auto& depth = wrapper->GetDepthAttachmentDescriptor();
  depth.depth_write_enabled = true;
}

ToImpellerColor()

static impeller::Color ToImpellerColor ( uint32_t  argb )

static

Definition at line 183 of file render_pass.cc.

                                                    {
  return impeller::Color::MakeRGBA8((argb >> 16) & 0xFF,  // R
                                    (argb >> 8) & 0xFF,   // G
                                    argb & 0xFF,          // B
                                    argb >> 24);          // A
}