canvas.cc

Go to the documentation of this file.

// Copyright 2013 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
 
#include "impeller/display_list/canvas.h"
 
#include <memory>
#include <optional>
#include <unordered_map>
#include <utility>
 
#include "display_list/dl_vertices.h"
#include "display_list/effects/color_filters/dl_blend_color_filter.h"
#include "display_list/effects/color_filters/dl_matrix_color_filter.h"
#include "display_list/effects/dl_color_filter.h"
#include "display_list/effects/dl_color_source.h"
#include "display_list/effects/dl_image_filter.h"
#include "display_list/image/dl_image.h"
#include "flutter/fml/logging.h"
#include "flutter/fml/trace_event.h"
#include "flutter/impeller/geometry/round_superellipse_param.h"
#include "impeller/base/validation.h"
#include "impeller/core/formats.h"
#include "impeller/display_list/color_filter.h"
#include "impeller/display_list/dl_image_impeller.h"
#include "impeller/display_list/dl_vertices_geometry.h"
#include "impeller/display_list/image_filter.h"
#include "impeller/display_list/skia_conversions.h"
#include "impeller/entity/contents/atlas_contents.h"
#include "impeller/entity/contents/circle_contents.h"
#include "impeller/entity/contents/clip_contents.h"
#include "impeller/entity/contents/color_source_contents.h"
#include "impeller/entity/contents/content_context.h"
#include "impeller/entity/contents/filters/filter_contents.h"
#include "impeller/entity/contents/framebuffer_blend_contents.h"
#include "impeller/entity/contents/line_contents.h"
#include "impeller/entity/contents/shadow_vertices_contents.h"
#include "impeller/entity/contents/solid_color_contents.h"
#include "impeller/entity/contents/solid_rrect_blur_contents.h"
#include "impeller/entity/contents/solid_rsuperellipse_blur_contents.h"
#include "impeller/entity/contents/text_contents.h"
#include "impeller/entity/contents/text_shadow_cache.h"
#include "impeller/entity/contents/texture_contents.h"
#include "impeller/entity/contents/uber_sdf_contents.h"
#include "impeller/entity/contents/uber_sdf_parameters.h"
#include "impeller/entity/contents/vertices_contents.h"
#include "impeller/entity/geometry/arc_geometry.h"
#include "impeller/entity/geometry/circle_geometry.h"
#include "impeller/entity/geometry/cover_geometry.h"
#include "impeller/entity/geometry/ellipse_geometry.h"
#include "impeller/entity/geometry/fill_path_geometry.h"
#include "impeller/entity/geometry/geometry.h"
#include "impeller/entity/geometry/line_geometry.h"
#include "impeller/entity/geometry/point_field_geometry.h"
#include "impeller/entity/geometry/rect_geometry.h"
#include "impeller/entity/geometry/shadow_path_geometry.h"
#include "impeller/entity/geometry/stroke_path_geometry.h"
#include "impeller/entity/geometry/uber_sdf_geometry.h"
#include "impeller/entity/save_layer_utils.h"
#include "impeller/geometry/color.h"
#include "impeller/geometry/constants.h"
#include "impeller/geometry/round_superellipse_param.h"
#include "impeller/geometry/rounding_radii.h"
#include "impeller/geometry/rstransform.h"
#include "impeller/geometry/scalar.h"
#include "impeller/geometry/vector.h"
#include "impeller/renderer/command_buffer.h"
 
namespace impeller {
 
namespace {
 
constexpr Scalar kAntialiasPadding = 1.0f;
 
bool IsPipelineBlendOrMatrixFilter(const flutter::DlColorFilter* filter) {
  return filter->type() == flutter::DlColorFilterType::kMatrix ||
         (filter->type() == flutter::DlColorFilterType::kBlend &&
          filter->asBlend()->mode() <= Entity::kLastPipelineBlendMode);
}
 
static bool UseColorSourceContents(
    const std::shared_ptr<VerticesGeometry>& vertices,
    const Paint& paint) {
  // If there are no vertex color or texture coordinates. Or if there
  // are vertex coordinates but its just a color.
  if (vertices->HasVertexColors()) {
    return false;
  }
  if (vertices->HasTextureCoordinates() && !paint.color_source) {
    return true;
  }
  return !vertices->HasTextureCoordinates();
}
 
static void SetClipScissor(std::optional<Rect> clip_coverage,
                           RenderPass& pass,
                           Point global_pass_position) {
  // Set the scissor to the clip coverage area. We do this prior to rendering
  // the clip itself and all its contents.
  IRect32 scissor;
  if (clip_coverage.has_value()) {
    clip_coverage = clip_coverage->Shift(-global_pass_position);
    scissor = IRect32::RoundOut(clip_coverage.value());
    // The scissor rect must not exceed the size of the render target.
    scissor =
        scissor.Intersection(IRect32::MakeSize(pass.GetRenderTargetSize()))
            .value_or(IRect32());
  }
  pass.SetScissor(scissor);
}
 
static void ApplyFramebufferBlend(Entity& entity) {
  auto src_contents = entity.GetContents();
  auto contents = std::make_shared<FramebufferBlendContents>();
  contents->SetChildContents(src_contents);
  contents->SetBlendMode(entity.GetBlendMode());
  entity.SetContents(std::move(contents));
  entity.SetBlendMode(BlendMode::kSrc);
}
 
/// @brief Create the subpass restore contents, appling any filters or opacity
///        from the provided paint object.
static std::shared_ptr<Contents> CreateContentsForSubpassTarget(
    const ContentContext& renderer,
    const Paint& paint,
    const std::shared_ptr<Texture>& target,
    const Matrix& effect_transform) {
  auto contents = TextureContents::MakeRect(Rect::MakeSize(target->GetSize()));
  contents->SetTexture(target);
  contents->SetLabel("Subpass");
  contents->SetSourceRect(Rect::MakeSize(target->GetSize()));
  contents->SetOpacity(paint.color.alpha);
  contents->SetDeferApplyingOpacity(true);
 
  return paint.WithFiltersForSubpassTarget(renderer, std::move(contents),
                                           effect_transform);
}
 
static const constexpr RenderTarget::AttachmentConfig kDefaultStencilConfig =
    RenderTarget::AttachmentConfig{
        .storage_mode = StorageMode::kDeviceTransient,
        .load_action = LoadAction::kDontCare,
        .store_action = StoreAction::kDontCare,
    };
 
static std::unique_ptr<EntityPassTarget> CreateRenderTarget(
    ContentContext& renderer,
    ISize size,
    const Color& clear_color) {
  const std::shared_ptr<Context>& context = renderer.GetContext();
 
  /// All of the load/store actions are managed by `InlinePassContext` when
  /// `RenderPasses` are created, so we just set them to `kDontCare` here.
  /// What's important is the `StorageMode` of the textures, which cannot be
  /// changed for the lifetime of the textures.
 
  RenderTarget target;
  if (context->GetCapabilities()->SupportsOffscreenMSAA()) {
    target = renderer.GetRenderTargetCache()->CreateOffscreenMSAA(
        /*context=*/*context,
        /*size=*/size,
        /*mip_count=*/1,
        /*label=*/"EntityPass",
        /*color_attachment_config=*/
        RenderTarget::AttachmentConfigMSAA{
            .storage_mode = StorageMode::kDeviceTransient,
            .resolve_storage_mode = StorageMode::kDevicePrivate,
            .load_action = LoadAction::kDontCare,
            .store_action = StoreAction::kMultisampleResolve,
            .clear_color = clear_color},
        /*stencil_attachment_config=*/kDefaultStencilConfig);
  } else {
    target = renderer.GetRenderTargetCache()->CreateOffscreen(
        *context,  // context
        size,      // size
        /*mip_count=*/1,
        "EntityPass",  // label
        RenderTarget::AttachmentConfig{
            .storage_mode = StorageMode::kDevicePrivate,
            .load_action = LoadAction::kDontCare,
            .store_action = StoreAction::kDontCare,
            .clear_color = clear_color,
        },                     // color_attachment_config
        kDefaultStencilConfig  //
    );
  }
 
  return std::make_unique<EntityPassTarget>(
      target,                                                           //
      renderer.GetDeviceCapabilities().SupportsReadFromResolve(),       //
      renderer.GetDeviceCapabilities().SupportsImplicitResolvingMSAA()  //
  );
}
 
}  // namespace
 
class Canvas::RRectBlurShape : public BlurShape {
 public:
  RRectBlurShape(const Rect& rect, Scalar corner_radius)
      : rect_(rect), corner_radius_(corner_radius) {}
 
  Rect GetBounds() const override { return rect_; }
 
  std::shared_ptr<SolidBlurContents> BuildBlurContent(Sigma sigma) override {
    auto contents = std::make_shared<SolidRRectBlurContents>();
    contents->SetSigma(sigma);
    contents->SetShape(rect_, corner_radius_);
    return contents;
  }
 
  const Geometry& BuildDrawGeometry() override {
    return geom_.emplace(rect_, Size(corner_radius_));
  }
 
 private:
  const Rect rect_;
  const Scalar corner_radius_;
 
  std::optional<RoundRectGeometry> geom_;  // optional stack allocation
};
 
class Canvas::RSuperellipseBlurShape : public BlurShape {
 public:
  RSuperellipseBlurShape(const Rect& rect, Scalar corner_radius)
      : rect_(rect), corner_radius_(corner_radius) {}
 
  Rect GetBounds() const override { return rect_; }
 
  std::shared_ptr<SolidBlurContents> BuildBlurContent(Sigma sigma) override {
    auto contents = std::make_shared<SolidRSuperellipseBlurContents>();
    contents->SetSigma(sigma);
    contents->SetShape(rect_, corner_radius_);
    return contents;
  }
 
  const Geometry& BuildDrawGeometry() override {
    return geom_.emplace(rect_, corner_radius_);
  }
 
 private:
  const Rect rect_;
  const Scalar corner_radius_;
 
  std::optional<RoundSuperellipseGeometry> geom_;  // optional stack allocation
};
 
class Canvas::PathBlurShape : public BlurShape {
 public:
  /// Construct a PathBlurShape from a path source, a set of shadow vertices
  /// (typically produced by ShadowPathGeometry) and the sigma that was used
  /// to generate the vertex mesh.
  ///
  /// The sigma was already used to generate the shadow vertices, so it is
  /// provided here only to make sure it matches the sigma we will see in
  /// our BuildBlurContent method.
  ///
  /// The source was used to generate the mesh and it might be used again
  /// for the SOLID mask operation so we save it here in case the mask
  /// rendering code calls our BuildDrawGeometry method. Its lifetime
  /// must survive the lifetime of this object, typically because the
  /// source object was stack allocated not long before this object is
  /// also being stack allocated.
  PathBlurShape(const PathSource& source [[clang::lifetimebound]],
                std::shared_ptr<ShadowVertices> shadow_vertices,
                Sigma sigma)
      : sigma_(sigma),
        source_(source),
        shadow_vertices_(std::move(shadow_vertices)) {}
 
  Rect GetBounds() const override {
    return shadow_vertices_->GetBounds().value_or(Rect());
  }
 
  std::shared_ptr<SolidBlurContents> BuildBlurContent(Sigma sigma) override {
    // We have to use the sigma to generate the mesh up front in order to
    // even know if we can perform the operation, but then the method that
    // actually uses our contents informs us of the sigma, but it's too
    // late to make use of it. Instead we remember what sigma we used and
    // make sure they match.
    FML_DCHECK(sigma_.sigma == sigma.sigma);
    return ShadowVerticesContents::Make(shadow_vertices_);
  }
 
  const Geometry& BuildDrawGeometry() override {
    return source_geometry_.emplace(source_);
  }
 
 private:
  const Sigma sigma_;
  const PathSource& source_;
  const std::shared_ptr<ShadowVertices> shadow_vertices_;
 
  // optional stack allocation - for BuildGeometry
  std::optional<FillPathFromSourceGeometry> source_geometry_;
};
 
Canvas::Canvas(ContentContext& renderer,
               const RenderTarget& render_target,
               bool is_onscreen,
               bool requires_readback)
    : renderer_(renderer),
      render_target_(render_target),
      is_onscreen_(is_onscreen),
      requires_readback_(requires_readback),
      clip_coverage_stack_(EntityPassClipStack(
          Rect::MakeSize(render_target.GetRenderTargetSize()))) {
  Initialize(std::nullopt);
  SetupRenderPass();
}
 
Canvas::Canvas(ContentContext& renderer,
               const RenderTarget& render_target,
               bool is_onscreen,
               bool requires_readback,
               Rect cull_rect)
    : renderer_(renderer),
      render_target_(render_target),
      is_onscreen_(is_onscreen),
      requires_readback_(requires_readback),
      clip_coverage_stack_(EntityPassClipStack(
          Rect::MakeSize(render_target.GetRenderTargetSize()))) {
  Initialize(cull_rect);
  SetupRenderPass();
}
 
Canvas::Canvas(ContentContext& renderer,
               const RenderTarget& render_target,
               bool is_onscreen,
               bool requires_readback,
               IRect32 cull_rect)
    : renderer_(renderer),
      render_target_(render_target),
      is_onscreen_(is_onscreen),
      requires_readback_(requires_readback),
      clip_coverage_stack_(EntityPassClipStack(
          Rect::MakeSize(render_target.GetRenderTargetSize()))) {
  Initialize(Rect::MakeLTRB(cull_rect.GetLeft(), cull_rect.GetTop(),
                            cull_rect.GetRight(), cull_rect.GetBottom()));
  SetupRenderPass();
}
 
void Canvas::Initialize(std::optional<Rect> cull_rect) {
  initial_cull_rect_ = cull_rect;
  transform_stack_.emplace_back(CanvasStackEntry{
      .clip_depth = kMaxDepth,
  });
  FML_DCHECK(GetSaveCount() == 1u);
}
 
void Canvas::Reset() {
  current_depth_ = 0u;
  transform_stack_ = {};
}
 
void Canvas::Concat(const Matrix& transform) {
  transform_stack_.back().transform = GetCurrentTransform() * transform;
}
 
void Canvas::PreConcat(const Matrix& transform) {
  transform_stack_.back().transform = transform * GetCurrentTransform();
}
 
void Canvas::ResetTransform() {
  transform_stack_.back().transform = {};
}
 
void Canvas::Transform(const Matrix& transform) {
  Concat(transform);
}
 
const Matrix& Canvas::GetCurrentTransform() const {
  return transform_stack_.back().transform;
}
 
void Canvas::Translate(const Vector3& offset) {
  Concat(Matrix::MakeTranslation(offset));
}
 
void Canvas::Scale(const Vector2& scale) {
  Concat(Matrix::MakeScale(scale));
}
 
void Canvas::Scale(const Vector3& scale) {
  Concat(Matrix::MakeScale(scale));
}
 
void Canvas::Skew(Scalar sx, Scalar sy) {
  Concat(Matrix::MakeSkew(sx, sy));
}
 
void Canvas::Rotate(Radians radians) {
  Concat(Matrix::MakeRotationZ(radians));
}
 
Point Canvas::GetGlobalPassPosition() const {
  if (save_layer_state_.empty()) {
    return Point(0, 0);
  }
  return save_layer_state_.back().coverage.GetOrigin();
}
 
// clip depth of the previous save or 0.
size_t Canvas::GetClipHeightFloor() const {
  if (transform_stack_.size() > 1) {
    return transform_stack_[transform_stack_.size() - 2].clip_height;
  }
  return 0;
}
 
size_t Canvas::GetSaveCount() const {
  return transform_stack_.size();
}
 
bool Canvas::IsSkipping() const {
  return transform_stack_.back().skipping;
}
 
void Canvas::RestoreToCount(size_t count) {
  while (GetSaveCount() > count) {
    if (!Restore()) {
      return;
    }
  }
}
 
void Canvas::DrawPath(const flutter::DlPath& path, const Paint& paint) {
  if (IsShadowBlurDrawOperation(paint)) {
    if (AttemptDrawBlurredPathSource(path, paint)) {
      return;
    }
  }
 
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  if (paint.style == Paint::Style::kFill) {
    FillPathGeometry geom(path);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  } else {
    StrokePathGeometry geom(path, paint.stroke);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  }
}
 
void Canvas::DrawPaint(const Paint& paint) {
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  CoverGeometry geom;
  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
}
 
// Optimization: if the texture has a color filter that is a simple
// porter-duff blend or matrix filter, then instead of performing a save layer
// we should swap out the shader for the porter duff blend shader and avoid a
// saveLayer. This optimization is important for Flame.
bool Canvas::AttemptColorFilterOptimization(
    const std::shared_ptr<Texture>& image,
    Rect source,
    Rect dest,
    const Paint& paint,
    const SamplerDescriptor& sampler,
    SourceRectConstraint src_rect_constraint) {
  if (!paint.color_filter ||                     //
      paint.image_filter != nullptr ||           //
      paint.invert_colors ||                     //
      paint.mask_blur_descriptor.has_value() ||  //
      !IsPipelineBlendOrMatrixFilter(paint.color_filter)) {
    return false;
  }
 
  if (paint.color_filter->type() == flutter::DlColorFilterType::kBlend) {
    const flutter::DlBlendColorFilter* blend_filter =
        paint.color_filter->asBlend();
    DrawImageRectAtlasGeometry geometry = DrawImageRectAtlasGeometry(
        /*texture=*/image,
        /*source=*/source,
        /*destination=*/dest,
        /*color=*/skia_conversions::ToColor(blend_filter->color()),
        /*blend_mode=*/blend_filter->mode(),
        /*desc=*/sampler,
        /*use_strict_src_rect=*/src_rect_constraint ==
            SourceRectConstraint::kStrict);
 
    auto atlas_contents = std::make_shared<AtlasContents>();
    atlas_contents->SetGeometry(&geometry);
    atlas_contents->SetAlpha(paint.color.alpha);
 
    Entity entity;
    entity.SetTransform(GetCurrentTransform());
    entity.SetBlendMode(paint.blend_mode);
    entity.SetContents(atlas_contents);
 
    AddRenderEntityToCurrentPass(entity);
  } else {
    // src_rect_constraint is only supported in the porter-duff mode
    // for now.
    if (src_rect_constraint == SourceRectConstraint::kStrict) {
      return false;
    }
 
    const flutter::DlMatrixColorFilter* matrix_filter =
        paint.color_filter->asMatrix();
 
    DrawImageRectAtlasGeometry geometry = DrawImageRectAtlasGeometry(
        /*texture=*/image,
        /*source=*/source,
        /*destination=*/dest,
        /*color=*/Color::Khaki(),            // ignored
        /*blend_mode=*/BlendMode::kSrcOver,  // ignored
        /*desc=*/sampler,
        /*use_strict_src_rect=*/src_rect_constraint ==
            SourceRectConstraint::kStrict);
 
    auto atlas_contents = std::make_shared<ColorFilterAtlasContents>();
    atlas_contents->SetGeometry(&geometry);
    atlas_contents->SetAlpha(paint.color.alpha);
    impeller::ColorMatrix color_matrix;
    matrix_filter->get_matrix(color_matrix.array);
    atlas_contents->SetMatrix(color_matrix);
 
    Entity entity;
    entity.SetTransform(GetCurrentTransform());
    entity.SetBlendMode(paint.blend_mode);
    entity.SetContents(atlas_contents);
 
    AddRenderEntityToCurrentPass(entity);
  }
  return true;
}
 
bool Canvas::AttemptDrawAntialiasedCircle(const Point& center,
                                          Scalar radius,
                                          const Paint& paint) {
  if (paint.HasColorFilter() || paint.image_filter || paint.invert_colors ||
      paint.color_source || paint.mask_blur_descriptor.has_value()) {
    return false;
  }
 
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  const bool is_stroked = paint.style == Paint::Style::kStroke;
  std::unique_ptr<CircleGeometry> geom;
  if (is_stroked) {
    geom = std::make_unique<CircleGeometry>(center, radius, paint.stroke.width);
  } else {
    geom = std::make_unique<CircleGeometry>(center, radius);
  }
  geom->SetAntialiasPadding(kAntialiasPadding);
 
  auto contents =
      CircleContents::Make(std::move(geom), paint.color, is_stroked);
  entity.SetContents(std::move(contents));
  AddRenderEntityToCurrentPass(entity);
 
  return true;
}
 
bool Canvas::IsShadowBlurDrawOperation(const Paint& paint) {
  if (paint.style != Paint::Style::kFill) {
    return false;
  }
 
  if (paint.color_source) {
    return false;
  }
 
  if (!paint.mask_blur_descriptor.has_value()) {
    return false;
  }
 
  // A blur sigma that is not positive enough should not result in a blur.
  // We test both the sigma value and the converted radius value as the
  // algorithms might use either and either indicates the blur is too small
  // to be noticeable.
  if (paint.mask_blur_descriptor->sigma.sigma <= kEhCloseEnough) {
    return false;
  }
  Radius radius = paint.mask_blur_descriptor->sigma;
  if (radius.radius <= kEhCloseEnough) {
    return false;
  }
 
  return true;
}
 
bool Canvas::AttemptDrawBlurredPathSource(const PathSource& source,
                                          const Paint& paint) {
  FML_DCHECK(IsShadowBlurDrawOperation);
 
  // This has_value() test should always succeed as it is checked by the
  // IsShadowBlurDrawOperation method which should have been called before
  // this method, but we check again here to avoid warnings from the
  // following code.
  if (paint.mask_blur_descriptor.has_value()) {
    // This value was determined by empirical eyesight tests so that the
    // shadow mesh results will match the results of the shape-specific
    // optimized shadow shaders.
    static constexpr Scalar kSigmaScale = 2.8f;
 
    Sigma sigma = paint.mask_blur_descriptor->sigma;
    const Matrix& matrix = GetCurrentTransform();
    Scalar basis_scale = matrix.GetMaxBasisLengthXY();
    Scalar device_radius = sigma.sigma * kSigmaScale * basis_scale;
    std::shared_ptr<ShadowVertices> shadow_vertices =
        ShadowPathGeometry::MakeAmbientShadowVertices(
            renderer_.GetTessellator(), source, device_radius, matrix);
    if (shadow_vertices) {
      PathBlurShape shape(source, std::move(shadow_vertices), sigma);
      return AttemptDrawBlur(shape, paint);
    }
  }
  return false;
}
 
Scalar Canvas::GetCommonRRectLikeRadius(const RoundingRadii& radii) {
  if (!radii.AreAllCornersSame()) {
    return -1;
  }
  const Size& corner_radii = radii.top_left;
  if (ScalarNearlyEqual(corner_radii.width, corner_radii.height)) {
    return corner_radii.width;
  }
  return -1;
}
 
bool Canvas::AttemptDrawBlurredRRect(const RoundRect& round_rect,
                                     const Paint& paint) {
  Scalar radius = GetCommonRRectLikeRadius(round_rect.GetRadii());
  if (radius < 0) {
    RoundRectPathSource source(round_rect);
    return AttemptDrawBlurredPathSource(source, paint);
  }
  RRectBlurShape shape(round_rect.GetBounds(), radius);
  return AttemptDrawBlur(shape, paint);
}
 
bool Canvas::AttemptDrawBlurredRSuperellipse(const RoundSuperellipse& rse,
                                             const Paint& paint) {
  Scalar radius = GetCommonRRectLikeRadius(rse.GetRadii());
  if (radius < 0) {
    RoundSuperellipsePathSource source(rse);
    return AttemptDrawBlurredPathSource(source, paint);
  }
  RSuperellipseBlurShape shape(rse.GetBounds(), radius);
  return AttemptDrawBlur(shape, paint);
}
 
bool Canvas::AttemptDrawBlur(BlurShape& shape, const Paint& paint) {
  FML_DCHECK(IsShadowBlurDrawOperation(paint));
 
  // For symmetrically mask blurred solid RRects, absorb the mask blur and use
  // a faster SDF approximation.
  Color rrect_color = paint.color;
  if (paint.invert_colors) {
    rrect_color = rrect_color.ApplyColorMatrix(kColorInversion);
  }
  if (paint.color_filter) {
    rrect_color = GetCPUColorFilterProc(paint.color_filter)(rrect_color);
  }
 
  Paint rrect_paint = {.mask_blur_descriptor = paint.mask_blur_descriptor};
 
  if (!rrect_paint.mask_blur_descriptor.has_value()) {
    // This should never happen in practice because the caller would have
    // first called |IsShadowBlurDrawOperation| on the paint object, but
    // we test anyway to make the compiler happy about the dereferences
    // below.
    return false;
  }
 
  // In some cases, we need to render the mask blur to a separate layer.
  //
  //   1. If the blur style is normal, we'll be drawing using one draw call and
  //      no clips. And so we can just wrap the RRect contents with the
  //      ImageFilter, which will get applied to the result as per usual.
  //
  //   2. If the blur style is solid, we combine the non-blurred RRect with the
  //      blurred RRect via two separate draw calls, and so we need to defer any
  //      fancy blending, translucency, or image filtering until after these two
  //      draws have been combined in a separate layer.
  //
  //   3. If the blur style is outer or inner, we apply the blur style via a
  //      clip. The ImageFilter needs to be applied to the mask blurred result.
  //      And so if there's an ImageFilter, we need to defer applying it until
  //      after the clipped RRect blur has been drawn to a separate texture.
  //      However, since there's only one draw call that produces color, we
  //      don't need to worry about the blend mode or translucency (unlike with
  //      BlurStyle::kSolid).
  //
  if ((paint.mask_blur_descriptor->style !=
           FilterContents::BlurStyle::kNormal &&
       paint.image_filter) ||
      (paint.mask_blur_descriptor->style == FilterContents::BlurStyle::kSolid &&
       (!rrect_color.IsOpaque() || paint.blend_mode != BlendMode::kSrcOver))) {
    Rect render_bounds = shape.GetBounds();
    if (paint.mask_blur_descriptor->style !=
        FilterContents::BlurStyle::kInner) {
      render_bounds =
          render_bounds.Expand(paint.mask_blur_descriptor->sigma.sigma * 4.0);
    }
    // Defer the alpha, blend mode, and image filter to a separate layer.
    SaveLayer(
        Paint{
            .color = Color::White().WithAlpha(rrect_color.alpha),
            .image_filter = paint.image_filter,
            .blend_mode = paint.blend_mode,
        },
        render_bounds, nullptr, ContentBoundsPromise::kContainsContents, 1u);
    rrect_paint.color = rrect_color.WithAlpha(1);
  } else {
    rrect_paint.color = rrect_color;
    rrect_paint.blend_mode = paint.blend_mode;
    rrect_paint.image_filter = paint.image_filter;
    Save(1u);
  }
 
  auto draw_blurred_rrect = [this, &rrect_paint, &shape]() {
    std::shared_ptr<SolidBlurContents> contents =
        shape.BuildBlurContent(rrect_paint.mask_blur_descriptor->sigma);
    FML_DCHECK(contents);
 
    contents->SetColor(rrect_paint.color);
 
    Entity blurred_rrect_entity;
    blurred_rrect_entity.SetTransform(GetCurrentTransform());
    blurred_rrect_entity.SetBlendMode(rrect_paint.blend_mode);
 
    rrect_paint.mask_blur_descriptor = std::nullopt;
    blurred_rrect_entity.SetContents(
        rrect_paint.WithFilters(renderer_, std::move(contents)));
    AddRenderEntityToCurrentPass(blurred_rrect_entity);
  };
 
  switch (rrect_paint.mask_blur_descriptor->style) {
    case FilterContents::BlurStyle::kNormal: {
      draw_blurred_rrect();
      break;
    }
    case FilterContents::BlurStyle::kSolid: {
      // First, draw the blurred RRect.
      draw_blurred_rrect();
      // Then, draw the non-blurred RRect on top.
      Entity entity;
      entity.SetTransform(GetCurrentTransform());
      entity.SetBlendMode(rrect_paint.blend_mode);
 
      const Geometry& geom = shape.BuildDrawGeometry();
      AddRenderEntityWithFiltersToCurrentPass(entity, &geom, rrect_paint,
                                              /*reuse_depth=*/true);
      break;
    }
    case FilterContents::BlurStyle::kOuter: {
      const Geometry& geom = shape.BuildDrawGeometry();
      ClipGeometry(geom, Entity::ClipOperation::kDifference);
      draw_blurred_rrect();
      break;
    }
    case FilterContents::BlurStyle::kInner: {
      const Geometry& geom = shape.BuildDrawGeometry();
      ClipGeometry(geom, Entity::ClipOperation::kIntersect);
      draw_blurred_rrect();
      break;
    }
  }
 
  Restore();
 
  return true;
}
 
void Canvas::DrawLine(const Point& p0,
                      const Point& p1,
                      const Paint& paint,
                      bool reuse_depth) {
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  auto geometry = std::make_unique<LineGeometry>(p0, p1, paint.stroke);
 
  if ((renderer_.GetContext()->GetFlags().antialiased_lines ||
       renderer_.GetContext()->GetFlags().use_sdfs) &&
      !paint.color_filter && !paint.invert_colors && !paint.image_filter &&
      !paint.mask_blur_descriptor.has_value() && !paint.color_source) {
    auto contents = LineContents::Make(std::move(geometry), paint.color);
    entity.SetContents(std::move(contents));
    AddRenderEntityToCurrentPass(entity, reuse_depth);
  } else {
    AddRenderEntityWithFiltersToCurrentPass(entity, geometry.get(), paint,
                                            /*reuse_depth=*/reuse_depth);
  }
}
 
void Canvas::DrawDashedLine(const Point& p0,
                            const Point& p1,
                            Scalar on_length,
                            Scalar off_length,
                            const Paint& paint) {
  // Reasons to defer to regular DrawLine:
  // - performance for degenerate and "regular line" cases
  // - length is non-positive - DrawLine will draw appropriate "dot"
  // - off_length is non-positive - no gaps, DrawLine will draw it solid
  // - on_length is negative - invalid dashing
  //
  // Note that a 0 length "on" dash will draw "dot"s every "off" distance
  // apart so we proceed with the dashing process in that case.
  Scalar length = p0.GetDistance(p1);
  if (length > 0.0f && on_length >= 0.0f && off_length > 0.0f) {
    Entity entity;
    entity.SetTransform(GetCurrentTransform());
    entity.SetBlendMode(paint.blend_mode);
 
    StrokeDashedLineGeometry geom(p0, p1, on_length, off_length, paint.stroke);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  } else {
    DrawLine(p0, p1, paint);
  }
}
 
void Canvas::DrawRect(const Rect& rect, const Paint& paint) {
  if (IsShadowBlurDrawOperation(paint)) {
    RRectBlurShape shape(rect, 0.0f);
    if (AttemptDrawBlur(shape, paint)) {
      return;
    }
  }
 
  if (renderer_.GetContext()->GetFlags().use_sdfs &&
      IsCompatibleWithSDFRendering(paint)) {
    auto params = UberSDFParameters::MakeRect(
        /*color=*/paint.color,
        /*rect=*/rect,
        /*stroke=*/paint.GetStroke());
    AddRenderSDFEntityToCurrentPass(paint, params);
    return;
  }
 
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  if (paint.style == Paint::Style::kStroke) {
    StrokeRectGeometry geom(rect, paint.stroke);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  } else {
    FillRectGeometry geom(rect);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  }
}
 
void Canvas::DrawOval(const Rect& rect, const Paint& paint) {
  // TODO(jonahwilliams): This additional condition avoids an assert in the
  // stroke circle geometry generator. I need to verify the condition that this
  // assert prevents.
  if (rect.IsSquare() && (paint.style == Paint::Style::kFill ||
                          (paint.style == Paint::Style::kStroke &&
                           paint.stroke.width < rect.GetWidth()))) {
    // Circles have slightly less overhead and can do stroking
    DrawCircle(rect.GetCenter(), rect.GetWidth() * 0.5f, paint);
    return;
  }
 
  if (IsShadowBlurDrawOperation(paint)) {
    if (rect.IsSquare()) {
      // RRectBlurShape takes the corner radii which are half of the
      // overall width and height of the DrawOval bounds rect.
      RRectBlurShape shape(rect, rect.GetWidth() * 0.5f);
      if (AttemptDrawBlur(shape, paint)) {
        return;
      }
    } else {
      EllipsePathSource source(rect);
      if (AttemptDrawBlurredPathSource(source, paint)) {
        return;
      }
    }
  }
 
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  if (renderer_.GetContext()->GetFlags().use_sdfs &&
      IsCompatibleWithSDFRendering(paint)) {
    UberSDFParameters params;
 
    if (paint.style == Paint::Style::kStroke) {
      params = UberSDFParameters::MakeOval(paint.color, rect, paint.stroke);
    } else {
      params = UberSDFParameters::MakeOval(paint.color, rect, std::nullopt);
    }
 
    AddRenderSDFEntityToCurrentPass(paint, params);
    return;
  }
 
  if (paint.style == Paint::Style::kStroke) {
    StrokeEllipseGeometry geom(rect, paint.stroke);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  } else {
    EllipseGeometry geom(rect);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  }
}
 
void Canvas::DrawArc(const Arc& arc, const Paint& paint) {
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  if (paint.style == Paint::Style::kFill) {
    ArcGeometry geom(arc);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
    return;
  }
 
  const Rect& oval_bounds = arc.GetOvalBounds();
  if (paint.stroke.width > oval_bounds.GetSize().MaxDimension()) {
    // This is a special case for rendering arcs whose stroke width is so large
    // you are effectively drawing a sector of a circle.
    // https://github.com/flutter/flutter/issues/158567
    Arc expanded_arc(oval_bounds.Expand(Size(paint.stroke.width * 0.5f)),
                     arc.GetStart(), arc.GetSweep(), true);
 
    ArcGeometry geom(expanded_arc);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
    return;
  }
 
  // IncludeCenter incurs lots of extra work for stroking an arc, including:
  // - It introduces segments to/from the center point (not too hard).
  // - It introduces joins on those segments (a bit more complicated).
  // - Even if the sweep is >=360 degrees, we still draw the segment to
  //   the center and it basically looks like a pie cut into the complete
  //   boundary circle, as if the slice were cut, but not extracted
  //   (hard to express as a continuous kTriangleStrip).
  if (!arc.IncludeCenter()) {
    if (arc.IsFullCircle()) {
      return DrawOval(oval_bounds, paint);
    }
 
    // Our fast stroking code only works for circular bounds as it assumes
    // that the inner and outer radii can be scaled along each angular step
    // of the arc - which is not true for elliptical arcs where the inner
    // and outer samples are perpendicular to the traveling direction of the
    // elliptical curve which may not line up with the center of the bounds.
    if (oval_bounds.IsSquare()) {
      ArcGeometry geom(arc, paint.stroke);
      AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
      return;
    }
  }
 
  ArcStrokeGeometry geom(arc, paint.stroke);
  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
}
 
void Canvas::DrawRoundRect(const RoundRect& round_rect, const Paint& paint) {
  if (IsShadowBlurDrawOperation(paint)) {
    if (AttemptDrawBlurredRRect(round_rect, paint)) {
      return;
    }
  }
 
  const RoundingRadii& radii = round_rect.GetRadii();
 
  if (renderer_.GetContext()->GetFlags().use_sdfs &&
      IsCompatibleWithSDFRendering(paint) && radii.AreAllCornersCircular()) {
    auto params = UberSDFParameters::MakeRoundedRect(
        /*color=*/paint.color,
        /*rect=*/round_rect.GetBounds(),
        /*radii=*/radii,
        /*stroke=*/paint.style == Paint::Style::kStroke
            ? std::make_optional(paint.stroke)
            : std::nullopt);
    AddRenderSDFEntityToCurrentPass(paint, params);
    return;
  }
 
  if (round_rect.GetRadii().AreAllCornersSame() &&
      paint.style == Paint::Style::kFill) {
    Entity entity;
    entity.SetTransform(GetCurrentTransform());
    entity.SetBlendMode(paint.blend_mode);
 
    RoundRectGeometry geom(round_rect.GetBounds(),
                           round_rect.GetRadii().top_left);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
    return;
  }
 
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  if (paint.style == Paint::Style::kFill) {
    FillRoundRectGeometry geom(round_rect);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  } else {
    StrokeRoundRectGeometry geom(round_rect, paint.stroke);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  }
}
 
void Canvas::DrawDiffRoundRect(const RoundRect& outer,
                               const RoundRect& inner,
                               const Paint& paint) {
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  if (paint.style == Paint::Style::kFill) {
    FillDiffRoundRectGeometry geom(outer, inner);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  } else {
    StrokeDiffRoundRectGeometry geom(outer, inner, paint.stroke);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  }
}
 
void Canvas::DrawRoundSuperellipse(const RoundSuperellipse& round_superellipse,
                                   const Paint& paint) {
  if (IsShadowBlurDrawOperation(paint)) {
    if (AttemptDrawBlurredRSuperellipse(round_superellipse, paint)) {
      return;
    }
  }
 
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  if (renderer_.GetContext()->GetFlags().use_sdfs &&
      IsCompatibleWithSDFRendering(paint) &&
      round_superellipse.GetRadii().AreAllCornersSame()) {
    auto round_superellipse_params = RoundSuperellipseParam::MakeBoundsRadii(
        round_superellipse.GetBounds(), round_superellipse.GetRadii());
 
    RoundSuperellipseParam::Octant octant_top =
        round_superellipse_params.top_right.top;
    RoundSuperellipseParam::Octant octant_right =
        round_superellipse_params.top_right.right;
 
    auto adjusted_radii = RoundingRadii::MakeRadii(
        Size(octant_top.circle_radius, octant_right.circle_radius));
 
    auto params = UberSDFParameters::MakeRoundedSuperellipse(
        /*color=*/paint.color,
        /*bounds=*/round_superellipse.GetBounds(),
        /*superellipse_degree=*/Point(octant_top.se_n, octant_right.se_n),
        /*superellipse_a=*/Point(octant_top.se_a, octant_right.se_a),
        /*radii=*/adjusted_radii,
        /*corner_angle_span=*/
        Point(octant_top.circle_max_angle.radians,
              octant_right.circle_max_angle.radians),
        /*corner_circle_center_top=*/octant_top.circle_center,
        /*corner_circle_center_right=*/octant_right.circle_center,
        /*superellipse_c=*/octant_top.se_a - octant_right.se_a,
        /*superellipse_scale=*/
        Point(round_superellipse_params.top_right.signed_scale.Abs()),
        /*stroke=*/paint.GetStroke());
 
    AddRenderSDFEntityToCurrentPass(paint, params);
 
    return;
  }
 
  if (paint.style == Paint::Style::kFill) {
    RoundSuperellipseGeometry geom(round_superellipse.GetBounds(),
                                   round_superellipse.GetRadii());
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  } else {
    StrokeRoundSuperellipseGeometry geom(round_superellipse, paint.stroke);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  }
}
 
void Canvas::DrawCircle(const Point& center,
                        Scalar radius,
                        const Paint& paint) {
  if (IsShadowBlurDrawOperation(paint)) {
    Rect bounds = Rect::MakeCircleBounds(center, radius);
    RRectBlurShape shape(bounds, radius);
    if (AttemptDrawBlur(shape, paint)) {
      return;
    }
  }
 
  if (renderer_.GetContext()->GetFlags().use_sdfs &&
      IsCompatibleWithSDFRendering(paint)) {
    auto params = UberSDFParameters::MakeCircle(
        /*color=*/paint.color, /*center=*/center, /*radius=*/radius,
        /*stroke=*/paint.GetStroke());
    AddRenderSDFEntityToCurrentPass(paint, params);
    return;
  }
 
  if (AttemptDrawAntialiasedCircle(center, radius, paint)) {
    return;
  }
 
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  if (paint.style == Paint::Style::kStroke) {
    CircleGeometry geom(center, radius, paint.stroke.width);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  } else {
    CircleGeometry geom(center, radius);
    AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
  }
}
 
void Canvas::ClipGeometry(const Geometry& geometry,
                          Entity::ClipOperation clip_op,
                          bool is_aa) {
  if (IsSkipping()) {
    return;
  }
 
  // Ideally the clip depth would be greater than the current rendering
  // depth because any rendering calls that follow this clip operation will
  // pre-increment the depth and then be rendering above our clip depth,
  // but that case will be caught by the CHECK in AddRenderEntity above.
  // In practice we sometimes have a clip set with no rendering after it
  // and in such cases the current depth will equal the clip depth.
  // Eventually the DisplayList should optimize these out, but it is hard
  // to know if a clip will actually be used in advance of storing it in
  // the DisplayList buffer.
  // See https://github.com/flutter/flutter/issues/147021
  FML_DCHECK(current_depth_ <= transform_stack_.back().clip_depth)
      << current_depth_ << " <=? " << transform_stack_.back().clip_depth;
  uint32_t clip_depth = transform_stack_.back().clip_depth;
 
  const Matrix clip_transform =
      Matrix::MakeTranslation(Vector3(-GetGlobalPassPosition())) *
      GetCurrentTransform();
 
  std::optional<Rect> clip_coverage = geometry.GetCoverage(clip_transform);
  if (!clip_coverage.has_value()) {
    return;
  }
 
  ClipContents clip_contents(
      clip_coverage.value(),
      /*is_axis_aligned_rect=*/geometry.IsAxisAlignedRect() &&
          GetCurrentTransform().IsTranslationScaleOnly());
  clip_contents.SetClipOperation(clip_op);
 
  EntityPassClipStack::ClipStateResult clip_state_result =
      clip_coverage_stack_.RecordClip(
          clip_contents,                                     //
          /*transform=*/clip_transform,                      //
          /*global_pass_position=*/GetGlobalPassPosition(),  //
          /*clip_depth=*/clip_depth,                         //
          /*clip_height_floor=*/GetClipHeightFloor(),        //
          /*is_aa=*/is_aa);
 
  if (clip_state_result.clip_did_change) {
    // We only need to update the pass scissor if the clip state has changed.
    SetClipScissor(
        clip_coverage_stack_.CurrentClipCoverage(),
        *render_passes_.back().GetInlinePassContext()->GetRenderPass(),
        GetGlobalPassPosition());
  }
 
  ++transform_stack_.back().clip_height;
  ++transform_stack_.back().num_clips;
 
  if (!clip_state_result.should_render) {
    return;
  }
 
  // Note: this is a bit of a hack. Its not possible to construct a geometry
  // result without begninning the render pass. We should refactor the geometry
  // objects so that they only need a reference to the render pass size and/or
  // orthographic transform.
  Entity entity;
  entity.SetTransform(clip_transform);
  entity.SetClipDepth(clip_depth);
 
  GeometryResult geometry_result = geometry.GetPositionBuffer(
      renderer_,                                                      //
      entity,                                                         //
      *render_passes_.back().GetInlinePassContext()->GetRenderPass()  //
  );
  clip_contents.SetGeometry(geometry_result);
  clip_coverage_stack_.GetLastReplayResult().clip_contents.SetGeometry(
      geometry_result);
 
  clip_contents.Render(
      renderer_, *render_passes_.back().GetInlinePassContext()->GetRenderPass(),
      clip_depth);
}
 
void Canvas::DrawPoints(const Point points[],
                        uint32_t count,
                        Scalar radius,
                        const Paint& paint,
                        PointStyle point_style) {
  if (radius <= 0) {
    return;
  }
 
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  PointFieldGeometry geom(points, count, radius,
                          /*round=*/point_style == PointStyle::kRound);
  AddRenderEntityWithFiltersToCurrentPass(entity, &geom, paint);
}
 
void Canvas::DrawImage(const std::shared_ptr<Texture>& image,
                       Point offset,
                       const Paint& paint,
                       const SamplerDescriptor& sampler) {
  if (!image) {
    return;
  }
 
  const Rect source = Rect::MakeSize(image->GetSize());
  const Rect dest = source.Shift(offset);
 
  DrawImageRect(image, source, dest, paint, sampler);
}
 
void Canvas::DrawImageRect(const std::shared_ptr<Texture>& image,
                           Rect source,
                           Rect dest,
                           const Paint& paint,
                           const SamplerDescriptor& sampler,
                           SourceRectConstraint src_rect_constraint) {
  if (!image || source.IsEmpty() || dest.IsEmpty()) {
    return;
  }
 
  ISize size = image->GetSize();
  if (size.IsEmpty()) {
    return;
  }
 
  std::optional<Rect> clipped_source =
      source.Intersection(Rect::MakeSize(size));
  if (!clipped_source) {
    return;
  }
 
  if (AttemptColorFilterOptimization(image, source, dest, paint, sampler,
                                     src_rect_constraint)) {
    return;
  }
 
  if (*clipped_source != source) {
    Scalar sx = dest.GetWidth() / source.GetWidth();
    Scalar sy = dest.GetHeight() / source.GetHeight();
    Scalar tx = dest.GetLeft() - source.GetLeft() * sx;
    Scalar ty = dest.GetTop() - source.GetTop() * sy;
    Matrix src_to_dest = Matrix::MakeTranslateScale({sx, sy, 1}, {tx, ty, 0});
    dest = clipped_source->TransformBounds(src_to_dest);
  }
 
  auto texture_contents = TextureContents::MakeRect(dest);
  texture_contents->SetTexture(image);
  texture_contents->SetSourceRect(*clipped_source);
  texture_contents->SetStrictSourceRect(src_rect_constraint ==
                                        SourceRectConstraint::kStrict);
  texture_contents->SetSamplerDescriptor(sampler);
  texture_contents->SetOpacity(paint.color.alpha);
  texture_contents->SetDeferApplyingOpacity(paint.HasColorFilter());
 
  Entity entity;
  entity.SetBlendMode(paint.blend_mode);
  entity.SetTransform(GetCurrentTransform());
 
  if (!paint.mask_blur_descriptor.has_value()) {
    entity.SetContents(
        paint.WithFilters(renderer_, std::move(texture_contents)));
    AddRenderEntityToCurrentPass(entity);
    return;
  }
 
  FillRectGeometry out_rect(Rect{});
 
  entity.SetContents(paint.WithFilters(
      renderer_,
      paint.mask_blur_descriptor->CreateMaskBlur(texture_contents, &out_rect)));
  AddRenderEntityToCurrentPass(entity);
}
 
size_t Canvas::GetClipHeight() const {
  return transform_stack_.back().clip_height;
}
 
void Canvas::DrawVertices(const std::shared_ptr<VerticesGeometry>& vertices,
                          BlendMode blend_mode,
                          const Paint& paint) {
  // Override the blend mode with kDestination in order to match the behavior
  // of Skia's SK_LEGACY_IGNORE_DRAW_VERTICES_BLEND_WITH_NO_SHADER flag, which
  // is enabled when the Flutter engine builds Skia.
  if (!paint.color_source) {
    blend_mode = BlendMode::kDst;
  }
 
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  // If there are no vertex colors.
  if (UseColorSourceContents(vertices, paint)) {
    AddRenderEntityWithFiltersToCurrentPass(entity, vertices.get(), paint);
    return;
  }
 
  // If the blend mode is destination don't bother to bind or create a texture.
  if (blend_mode == BlendMode::kDst) {
    auto contents = std::make_shared<VerticesSimpleBlendContents>();
    contents->SetBlendMode(blend_mode);
    contents->SetAlpha(paint.color.alpha);
    contents->SetGeometry(vertices);
    entity.SetContents(paint.WithFilters(renderer_, std::move(contents)));
    AddRenderEntityToCurrentPass(entity);
    return;
  }
 
  // If there is a texture, use this directly. Otherwise render the color
  // source to a texture.
  if (paint.color_source &&
      paint.color_source->type() == flutter::DlColorSourceType::kImage) {
    const flutter::DlImageColorSource* image_color_source =
        paint.color_source->asImage();
    FML_DCHECK(image_color_source);
    auto texture =
        image_color_source->image()->asImpellerImage()->GetCachedTexture(
            renderer_);
    FML_DCHECK(texture);
    auto x_tile_mode = static_cast<Entity::TileMode>(
        image_color_source->horizontal_tile_mode());
    auto y_tile_mode =
        static_cast<Entity::TileMode>(image_color_source->vertical_tile_mode());
    auto sampler_descriptor =
        skia_conversions::ToSamplerDescriptor(image_color_source->sampling());
    auto effect_transform = image_color_source->matrix();
 
    auto contents = std::make_shared<VerticesSimpleBlendContents>();
    contents->SetBlendMode(blend_mode);
    contents->SetAlpha(paint.color.alpha);
    contents->SetGeometry(vertices);
    contents->SetEffectTransform(effect_transform);
    contents->SetTexture(texture);
    contents->SetTileMode(x_tile_mode, y_tile_mode);
    contents->SetSamplerDescriptor(sampler_descriptor);
 
    entity.SetContents(paint.WithFilters(renderer_, std::move(contents)));
    AddRenderEntityToCurrentPass(entity);
    return;
  }
 
  auto src_paint = paint;
  src_paint.color = paint.color.WithAlpha(1.0);
 
  std::shared_ptr<ColorSourceContents> src_contents =
      src_paint.CreateContents(renderer_, vertices.get());
 
  // If the color source has an intrinsic size, then we use that to
  // create the src contents as a simplification. Otherwise we use
  // the extent of the texture coordinates to determine how large
  // the src contents should be. If neither has a value we fall back
  // to using the geometry coverage data.
  Rect src_coverage;
  auto size = src_contents->GetColorSourceSize();
  if (size.has_value()) {
    src_coverage = Rect::MakeXYWH(0, 0, size->width, size->height);
  } else {
    auto cvg = vertices->GetCoverage(Matrix{});
    FML_CHECK(cvg.has_value());
    auto texture_coverage = vertices->GetTextureCoordinateCoverage();
    if (texture_coverage.has_value()) {
      src_coverage =
          Rect::MakeOriginSize(texture_coverage->GetOrigin(),
                               texture_coverage->GetSize().Max({1, 1}));
    } else {
      // NOLINTNEXTLINE(bugprone-unchecked-optional-access)
      src_coverage = cvg.value();
    }
  }
  clip_geometry_.push_back(Geometry::MakeRect(Rect::Round(src_coverage)));
  src_contents =
      src_paint.CreateContents(renderer_, clip_geometry_.back().get());
 
  auto contents = std::make_shared<VerticesSimpleBlendContents>();
  contents->SetBlendMode(blend_mode);
  contents->SetAlpha(paint.color.alpha);
  contents->SetGeometry(vertices);
  contents->SetLazyTextureCoverage(src_coverage);
  contents->SetLazyTexture(
      [src_contents, src_coverage](
          const ContentContext& renderer) -> std::shared_ptr<Texture> {
        // Applying the src coverage as the coverage limit prevents the 1px
        // coverage pad from adding a border that is picked up by developer
        // specified UVs.
        auto snapshot = src_contents->RenderToSnapshot(
            renderer, {}, {.coverage_limit = Rect::Round(src_coverage)});
        return snapshot.has_value() ? snapshot->texture : nullptr;
      });
  entity.SetContents(paint.WithFilters(renderer_, std::move(contents)));
  AddRenderEntityToCurrentPass(entity);
}
 
void Canvas::DrawAtlas(const std::shared_ptr<AtlasContents>& atlas_contents,
                       const Paint& paint) {
  atlas_contents->SetAlpha(paint.color.alpha);
 
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
  entity.SetContents(paint.WithFilters(renderer_, atlas_contents));
 
  AddRenderEntityToCurrentPass(entity);
}
 
/// Compositor Functionality
/////////////////////////////////////////
 
void Canvas::SetupRenderPass() {
  renderer_.GetRenderTargetCache()->Start();
  ColorAttachment color0 = render_target_.GetColorAttachment(0);
 
  auto& stencil_attachment = render_target_.GetStencilAttachment();
  auto& depth_attachment = render_target_.GetDepthAttachment();
  if (!stencil_attachment.has_value() || !depth_attachment.has_value()) {
    // Setup a new root stencil with an optimal configuration if one wasn't
    // provided by the caller.
    render_target_.SetupDepthStencilAttachments(
        *renderer_.GetContext(),
        *renderer_.GetContext()->GetResourceAllocator(),
        color0.texture->GetSize(),
        renderer_.GetContext()->GetCapabilities()->SupportsOffscreenMSAA() &&
            color0.texture->GetTextureDescriptor().sample_count >
                SampleCount::kCount1,
        "ImpellerOnscreen", kDefaultStencilConfig);
  }
 
  // Set up the clear color of the root pass.
  color0.clear_color = Color::BlackTransparent();
  render_target_.SetColorAttachment(color0, 0);
 
  // If requires_readback is true, then there is a backdrop filter or emulated
  // advanced blend in the first save layer. This requires a readback, which
  // isn't supported by onscreen textures. To support this, we immediately begin
  // a second save layer with the same dimensions as the onscreen. When
  // rendering is completed, we must blit this saveLayer to the onscreen.
  if (requires_readback_) {
    auto entity_pass_target =
        CreateRenderTarget(renderer_,                  //
                           color0.texture->GetSize(),  //
                           /*clear_color=*/Color::BlackTransparent());
    render_passes_.push_back(
        LazyRenderingConfig(renderer_, std::move(entity_pass_target)));
  } else {
    auto entity_pass_target = std::make_unique<EntityPassTarget>(
        render_target_,                                                    //
        renderer_.GetDeviceCapabilities().SupportsReadFromResolve(),       //
        renderer_.GetDeviceCapabilities().SupportsImplicitResolvingMSAA()  //
    );
    render_passes_.push_back(
        LazyRenderingConfig(renderer_, std::move(entity_pass_target)));
  }
}
 
void Canvas::SkipUntilMatchingRestore(size_t total_content_depth) {
  auto entry = CanvasStackEntry{};
  entry.skipping = true;
  entry.clip_depth = current_depth_ + total_content_depth;
  transform_stack_.push_back(entry);
}
 
void Canvas::Save(uint32_t total_content_depth) {
  if (IsSkipping()) {
    return SkipUntilMatchingRestore(total_content_depth);
  }
 
  auto entry = CanvasStackEntry{};
  entry.transform = transform_stack_.back().transform;
  entry.clip_depth = current_depth_ + total_content_depth;
  entry.distributed_opacity = transform_stack_.back().distributed_opacity;
  FML_DCHECK(entry.clip_depth <= transform_stack_.back().clip_depth)
      << entry.clip_depth << " <=? " << transform_stack_.back().clip_depth
      << " after allocating " << total_content_depth;
  entry.clip_height = transform_stack_.back().clip_height;
  entry.rendering_mode = Entity::RenderingMode::kDirect;
  transform_stack_.push_back(entry);
}
 
std::optional<Rect> Canvas::GetLocalCoverageLimit() const {
  if (!clip_coverage_stack_.HasCoverage()) {
    // The current clip is empty. This means the pass texture won't be
    // visible, so skip it.
    return std::nullopt;
  }
 
  std::optional<Rect> maybe_current_clip_coverage =
      clip_coverage_stack_.CurrentClipCoverage();
  if (!maybe_current_clip_coverage.has_value()) {
    return std::nullopt;
  }
 
  Rect current_clip_coverage = maybe_current_clip_coverage.value();
 
  FML_CHECK(!render_passes_.empty());
  const LazyRenderingConfig& back_render_pass = render_passes_.back();
  std::shared_ptr<Texture> back_texture =
      back_render_pass.GetInlinePassContext()->GetTexture();
  FML_CHECK(back_texture) << "Context is valid:"
                          << back_render_pass.GetInlinePassContext()->IsValid();
 
  // The maximum coverage of the subpass. Subpasses textures should never
  // extend outside the parent pass texture or the current clip coverage.
  std::optional<Rect> maybe_coverage_limit =
      Rect::MakeOriginSize(GetGlobalPassPosition(),
                           Size(back_texture->GetSize()))
          .Intersection(current_clip_coverage);
 
  if (!maybe_coverage_limit.has_value() || maybe_coverage_limit->IsEmpty()) {
    return std::nullopt;
  }
 
  return maybe_coverage_limit->Intersection(
      Rect::MakeSize(render_target_.GetRenderTargetSize()));
}
 
void Canvas::SaveLayer(const Paint& paint,
                       std::optional<Rect> bounds,
                       const flutter::DlImageFilter* backdrop_filter,
                       ContentBoundsPromise bounds_promise,
                       uint32_t total_content_depth,
                       bool can_distribute_opacity,
                       std::optional<int64_t> backdrop_id) {
  TRACE_EVENT0("flutter", "Canvas::saveLayer");
  if (IsSkipping()) {
    return SkipUntilMatchingRestore(total_content_depth);
  }
 
  auto maybe_coverage_limit = GetLocalCoverageLimit();
  if (!maybe_coverage_limit.has_value()) {
    return SkipUntilMatchingRestore(total_content_depth);
  }
  auto coverage_limit = maybe_coverage_limit.value();
 
  if (can_distribute_opacity && !backdrop_filter &&
      Paint::CanApplyOpacityPeephole(paint) &&
      bounds_promise != ContentBoundsPromise::kMayClipContents) {
    Save(total_content_depth);
    transform_stack_.back().distributed_opacity *= paint.color.alpha;
    return;
  }
 
  std::shared_ptr<FilterContents> filter_contents = paint.WithImageFilter(
      renderer_, Rect(), transform_stack_.back().transform,
      Entity::RenderingMode::kSubpassPrependSnapshotTransform);
 
  std::optional<Rect> maybe_subpass_coverage = ComputeSaveLayerCoverage(
      bounds.value_or(Rect::MakeMaximum()),
      transform_stack_.back().transform,  //
      coverage_limit,                     //
      filter_contents,                    //
      /*flood_output_coverage=*/
      Entity::IsBlendModeDestructive(paint.blend_mode),  //
      /*flood_input_coverage=*/!!backdrop_filter ||
          (paint.color_filter &&
           paint.color_filter->modifies_transparent_black())  //
  );
 
  if (!maybe_subpass_coverage.has_value()) {
    return SkipUntilMatchingRestore(total_content_depth);
  }
 
  auto subpass_coverage = maybe_subpass_coverage.value();
 
  // When an image filter is present, clamp to avoid flicking due to nearest
  // sampled image. For other cases, round out to ensure than any geometry is
  // not cut off.
  //
  // See also this bug: https://github.com/flutter/flutter/issues/144213
  //
  // TODO(jonahwilliams): this could still round out for filters that use decal
  // sampling mode.
  ISize subpass_size;
  bool did_round_out = false;
  Point coverage_origin_adjustment = Point{0, 0};
  if (paint.image_filter) {
    subpass_size = ISize(subpass_coverage.GetSize());
  } else {
    did_round_out = true;
    subpass_size =
        static_cast<ISize>(IRect::RoundOut(subpass_coverage).GetSize());
    // If rounding out, adjust the coverage to account for the subpixel shift.
    coverage_origin_adjustment =
        Point(subpass_coverage.GetLeftTop().x -
                  std::floor(subpass_coverage.GetLeftTop().x),
              subpass_coverage.GetLeftTop().y -
                  std::floor(subpass_coverage.GetLeftTop().y));
  }
  if (subpass_size.IsEmpty()) {
    return SkipUntilMatchingRestore(total_content_depth);
  }
 
  // When there are scaling filters present, these contents may exceed the
  // maximum texture size. Perform a clamp here, which may cause rendering
  // artifacts.
  subpass_size = subpass_size.Min(renderer_.GetContext()
                                      ->GetCapabilities()
                                      ->GetMaximumRenderPassAttachmentSize());
 
  // Backdrop filter state, ignored if there is no BDF.
  std::shared_ptr<FilterContents> backdrop_filter_contents;
  Point local_position = Point(0, 0);
  if (backdrop_filter) {
    local_position = subpass_coverage.GetOrigin() - GetGlobalPassPosition();
 
    std::shared_ptr<Texture> input_texture;
 
    // If the backdrop ID is not nullopt and there is more than one usage
    // of it in the current scene, cache the backdrop texture and remove it from
    // the current entity pass flip.
    bool will_cache_backdrop_texture = false;
    BackdropData* backdrop_data = nullptr;
    // If we've reached this point, there is at least one backdrop filter. But
    // potentially more if there is a backdrop id. We may conditionally set this
    // to a higher value in the if block below.
    size_t backdrop_count = 1;
    if (backdrop_id.has_value()) {
      std::unordered_map<int64_t, BackdropData>::iterator backdrop_data_it =
          backdrop_data_.find(backdrop_id.value());
      if (backdrop_data_it != backdrop_data_.end()) {
        backdrop_data = &backdrop_data_it->second;
        will_cache_backdrop_texture =
            backdrop_data_it->second.backdrop_count > 1;
        backdrop_count = backdrop_data_it->second.backdrop_count;
      }
    }
 
    if (!will_cache_backdrop_texture || !backdrop_data->texture_slot) {
      backdrop_count_ -= backdrop_count;
 
      // The onscreen texture can be flipped to if:
      // 1. The device supports framebuffer fetch
      // 2. There are no more backdrop filters
      // 3. The current render pass is for the onscreen pass.
      const bool should_use_onscreen =
          renderer_.GetDeviceCapabilities().SupportsFramebufferFetch() &&
          backdrop_count_ == 0 && render_passes_.size() == 1u;
      input_texture = FlipBackdrop(
          GetGlobalPassPosition(),                                //
          /*should_remove_texture=*/will_cache_backdrop_texture,  //
          /*should_use_onscreen=*/should_use_onscreen             //
      );
      if (!input_texture) {
        // Validation failures are logged in FlipBackdrop.
        return;
      }
 
      if (will_cache_backdrop_texture) {
        backdrop_data->texture_slot = input_texture;
      }
    } else {
      input_texture = backdrop_data->texture_slot;
    }
 
    backdrop_filter_contents =
        WrapInput(renderer_, backdrop_filter,
                  FilterInput::Make(std::move(input_texture)));
    backdrop_filter_contents->SetEffectTransform(
        transform_stack_.back().transform.Basis());
    backdrop_filter_contents->SetRenderingMode(
        transform_stack_.back().transform.HasTranslation()
            ? Entity::RenderingMode::kSubpassPrependSnapshotTransform
            : Entity::RenderingMode::kSubpassAppendSnapshotTransform);
 
    if (will_cache_backdrop_texture) {
      FML_DCHECK(backdrop_data);
      // If all filters on the shared backdrop layer are equal, process the
      // layer once.
      if (backdrop_data->all_filters_equal &&
          !backdrop_data->shared_filter_snapshot.has_value()) {
        // TODO(157110): compute minimum input hint.
        backdrop_data->shared_filter_snapshot =
            backdrop_filter_contents->RenderToSnapshot(renderer_, {}, {});
      }
 
      std::optional<Snapshot> maybe_snapshot =
          backdrop_data->shared_filter_snapshot;
      if (maybe_snapshot.has_value()) {
        const Snapshot& snapshot = maybe_snapshot.value();
        std::shared_ptr<TextureContents> contents = TextureContents::MakeRect(
            subpass_coverage.Shift(-GetGlobalPassPosition()));
        auto scaled =
            subpass_coverage.TransformBounds(snapshot.transform.Invert());
        contents->SetTexture(snapshot.texture);
        contents->SetSourceRect(scaled);
        contents->SetSamplerDescriptor(snapshot.sampler_descriptor);
 
        // This backdrop entity sets a depth value as it is written to the newly
        // flipped backdrop and not into a new saveLayer.
        Entity backdrop_entity;
        backdrop_entity.SetContents(std::move(contents));
        backdrop_entity.SetClipDepth(++current_depth_);
        backdrop_entity.SetBlendMode(paint.blend_mode);
 
        backdrop_entity.Render(renderer_, GetCurrentRenderPass());
        Save(0);
        return;
      }
    }
  }
 
  // When applying a save layer, absorb any pending distributed opacity.
  Paint paint_copy = paint;
  paint_copy.color.alpha *= transform_stack_.back().distributed_opacity;
  transform_stack_.back().distributed_opacity = 1.0;
 
  render_passes_.push_back(
      LazyRenderingConfig(renderer_,                                    //
                          CreateRenderTarget(renderer_,                 //
                                             subpass_size,              //
                                             Color::BlackTransparent()  //
                                             )));
  save_layer_state_.push_back(SaveLayerState{
      paint_copy, subpass_coverage.Shift(-coverage_origin_adjustment)});
 
  CanvasStackEntry entry;
  entry.transform = transform_stack_.back().transform;
  entry.clip_depth = current_depth_ + total_content_depth;
  FML_DCHECK(entry.clip_depth <= transform_stack_.back().clip_depth)
      << entry.clip_depth << " <=? " << transform_stack_.back().clip_depth
      << " after allocating " << total_content_depth;
  entry.clip_height = transform_stack_.back().clip_height;
  entry.rendering_mode = Entity::RenderingMode::kSubpassAppendSnapshotTransform;
  entry.did_round_out = did_round_out;
  transform_stack_.emplace_back(entry);
 
  // Start non-collapsed subpasses with a fresh clip coverage stack limited by
  // the subpass coverage. This is important because image filters applied to
  // save layers may transform the subpass texture after it's rendered,
  // causing parent clip coverage to get misaligned with the actual area that
  // the subpass will affect in the parent pass.
  clip_coverage_stack_.PushSubpass(subpass_coverage, GetClipHeight());
 
  if (!backdrop_filter_contents) {
    return;
  }
 
  // Render the backdrop entity.
  Entity backdrop_entity;
  backdrop_entity.SetContents(std::move(backdrop_filter_contents));
  backdrop_entity.SetTransform(
      Matrix::MakeTranslation(Vector3(-local_position)));
  backdrop_entity.SetClipDepth(std::numeric_limits<uint32_t>::max());
  backdrop_entity.Render(renderer_, GetCurrentRenderPass());
}
 
bool Canvas::Restore() {
  FML_DCHECK(transform_stack_.size() > 0);
  if (transform_stack_.size() == 1) {
    return false;
  }
 
  // This check is important to make sure we didn't exceed the depth
  // that the clips were rendered at while rendering any of the
  // rendering ops. It is OK for the current depth to equal the
  // outgoing clip depth because that means the clipping would have
  // been successful up through the last rendering op, but it cannot
  // be greater.
  // Also, we bump the current rendering depth to the outgoing clip
  // depth so that future rendering operations are not clipped by
  // any of the pixels set by the expiring clips. It is OK for the
  // estimates used to determine the clip depth in save/saveLayer
  // to be overly conservative, but we need to jump the depth to
  // the clip depth so that the next rendering op will get a
  // larger depth (it will pre-increment the current_depth_ value).
  FML_DCHECK(current_depth_ <= transform_stack_.back().clip_depth)
      << current_depth_ << " <=? " << transform_stack_.back().clip_depth;
  current_depth_ = transform_stack_.back().clip_depth;
 
  if (IsSkipping()) {
    transform_stack_.pop_back();
    return true;
  }
 
  if (transform_stack_.back().rendering_mode ==
          Entity::RenderingMode::kSubpassAppendSnapshotTransform ||
      transform_stack_.back().rendering_mode ==
          Entity::RenderingMode::kSubpassPrependSnapshotTransform) {
    auto lazy_render_pass = std::move(render_passes_.back());
    render_passes_.pop_back();
    // Force the render pass to be constructed if it never was.
    lazy_render_pass.GetInlinePassContext()->GetRenderPass();
 
    SaveLayerState save_layer_state = save_layer_state_.back();
    save_layer_state_.pop_back();
    auto global_pass_position = GetGlobalPassPosition();
 
    std::shared_ptr<Contents> contents = CreateContentsForSubpassTarget(
        renderer_, save_layer_state.paint,                         //
        lazy_render_pass.GetInlinePassContext()->GetTexture(),     //
        Matrix::MakeTranslation(Vector3{-global_pass_position}) *  //
            transform_stack_.back().transform                      //
    );
 
    lazy_render_pass.GetInlinePassContext()->EndPass();
 
    // Round the subpass texture position for pixel alignment with the parent
    // pass render target. By default, we draw subpass textures with nearest
    // sampling, so aligning here is important for avoiding visual nearest
    // sampling errors caused by limited floating point precision when
    // straddling a half pixel boundary.
    Point subpass_texture_position;
    if (transform_stack_.back().did_round_out) {
      // Subpass coverage was rounded out, origin potentially moved "down" by
      // as much as a pixel.
      subpass_texture_position =
          (save_layer_state.coverage.GetOrigin() - global_pass_position)
              .Floor();
    } else {
      // Subpass coverage was truncated. Pick the closest phyiscal pixel.
      subpass_texture_position =
          (save_layer_state.coverage.GetOrigin() - global_pass_position)
              .Round();
    }
 
    Entity element_entity;
    element_entity.SetClipDepth(++current_depth_);
    element_entity.SetContents(std::move(contents));
    element_entity.SetBlendMode(save_layer_state.paint.blend_mode);
    element_entity.SetTransform(
        Matrix::MakeTranslation(Vector3(subpass_texture_position)));
 
    if (element_entity.GetBlendMode() > Entity::kLastPipelineBlendMode) {
      if (renderer_.GetDeviceCapabilities().SupportsFramebufferFetch()) {
        ApplyFramebufferBlend(element_entity);
      } else {
        // End the active pass and flush the buffer before rendering "advanced"
        // blends. Advanced blends work by binding the current render target
        // texture as an input ("destination"), blending with a second texture
        // input ("source"), writing the result to an intermediate texture, and
        // finally copying the data from the intermediate texture back to the
        // render target texture. And so all of the commands that have written
        // to the render target texture so far need to execute before it's bound
        // for blending (otherwise the blend pass will end up executing before
        // all the previous commands in the active pass).
        auto input_texture = FlipBackdrop(GetGlobalPassPosition());
        if (!input_texture) {
          return false;
        }
 
        FilterInput::Vector inputs = {
            FilterInput::Make(input_texture,
                              element_entity.GetTransform().Invert()),
            FilterInput::Make(element_entity.GetContents())};
        auto contents = ColorFilterContents::MakeBlend(
            element_entity.GetBlendMode(), inputs);
        contents->SetCoverageHint(element_entity.GetCoverage());
        element_entity.SetContents(std::move(contents));
        element_entity.SetBlendMode(BlendMode::kSrc);
      }
    }
 
    element_entity.Render(
        renderer_,                                                      //
        *render_passes_.back().GetInlinePassContext()->GetRenderPass()  //
    );
    clip_coverage_stack_.PopSubpass();
    transform_stack_.pop_back();
 
    // We don't need to restore clips if a saveLayer was performed, as the clip
    // state is per render target, and no more rendering operations will be
    // performed as the render target workloaded is completed in the restore.
    return true;
  }
 
  size_t num_clips = transform_stack_.back().num_clips;
  transform_stack_.pop_back();
 
  if (num_clips > 0) {
    EntityPassClipStack::ClipStateResult clip_state_result =
        clip_coverage_stack_.RecordRestore(GetGlobalPassPosition(),
                                           GetClipHeight());
 
    // Clip restores are never required with depth based clipping.
    FML_DCHECK(!clip_state_result.should_render);
    if (clip_state_result.clip_did_change) {
      // We only need to update the pass scissor if the clip state has changed.
      SetClipScissor(
          clip_coverage_stack_.CurrentClipCoverage(),                      //
          *render_passes_.back().GetInlinePassContext()->GetRenderPass(),  //
          GetGlobalPassPosition()                                          //
      );
    }
  }
 
  return true;
}
 
bool Canvas::AttemptBlurredTextOptimization(
    const std::shared_ptr<TextFrame>& text_frame,
    const std::shared_ptr<TextContents>& text_contents,
    Entity& entity,
    const Paint& paint) {
  if (!paint.mask_blur_descriptor.has_value() ||  //
      paint.image_filter != nullptr ||            //
      paint.color_filter != nullptr ||            //
      paint.invert_colors) {
    return false;
  }
 
  // TODO(bdero): This mask blur application is a hack. It will always wind up
  //              doing a gaussian blur that affects the color source itself
  //              instead of just the mask. The color filter text support
  //              needs to be reworked in order to interact correctly with
  //              mask filters.
  //              https://github.com/flutter/flutter/issues/133297
  std::shared_ptr<FilterContents> filter =
      paint.mask_blur_descriptor->CreateMaskBlur(
          FilterInput::Make(text_contents),
          /*is_solid_color=*/true, GetCurrentTransform());
 
  std::optional<Glyph> maybe_glyph = text_frame->AsSingleGlyph();
  int64_t identifier = maybe_glyph.has_value()
                           ? maybe_glyph.value().index
                           : reinterpret_cast<int64_t>(text_frame.get());
  TextShadowCache::TextShadowCacheKey cache_key(
      /*p_max_basis=*/entity.GetTransform().GetMaxBasisLengthXY(),
      /*p_identifier=*/identifier,
      /*p_is_single_glyph=*/maybe_glyph.has_value(),
      /*p_font=*/text_frame->GetFont(),
      /*p_sigma=*/paint.mask_blur_descriptor->sigma,
      /*p_color=*/paint.color);
 
  std::optional<Entity> result = renderer_.GetTextShadowCache().Lookup(
      renderer_, entity, filter, cache_key);
  if (result.has_value()) {
    AddRenderEntityToCurrentPass(result.value(), /*reuse_depth=*/false);
    return true;
  } else {
    return false;
  }
}
 
// If the text point size * max basis XY is larger than this value,
// render the text as paths (if available) for faster and higher
// fidelity rendering. This is a somewhat arbitrary cutoff
static constexpr Scalar kMaxTextScale = 250;
 
void Canvas::DrawTextFrame(const std::shared_ptr<TextFrame>& text_frame,
                           Point position,
                           const Paint& paint) {
  Scalar max_scale = GetCurrentTransform().GetMaxBasisLengthXY();
  if (max_scale * text_frame->GetFont().GetMetrics().point_size >
      kMaxTextScale) {
    fml::StatusOr<flutter::DlPath> path = text_frame->GetPath();
    if (path.ok()) {
      Save(1);
      Concat(Matrix::MakeTranslation(position));
      DrawPath(path.value(), paint);
      Restore();
      return;
    }
  }
 
  Entity entity;
  entity.SetClipDepth(GetClipHeight());
  entity.SetBlendMode(paint.blend_mode);
 
  auto text_contents = std::make_shared<TextContents>();
  text_contents->SetTextFrame(text_frame);
  text_contents->SetPosition(position);
  text_contents->SetScreenTransform(GetCurrentTransform());
  text_contents->SetForceTextColor(paint.mask_blur_descriptor.has_value());
  text_contents->SetColor(paint.color);
  text_contents->SetTextProperties(paint.color, paint.GetStroke());
 
  entity.SetTransform(GetCurrentTransform());
 
  if (AttemptBlurredTextOptimization(text_frame, text_contents, entity,
                                     paint)) {
    return;
  }
 
  entity.SetContents(paint.WithFilters(renderer_, std::move(text_contents)));
  AddRenderEntityToCurrentPass(entity, false);
}
 
void Canvas::AddRenderSDFEntityToCurrentPass(const Paint& paint,
                                             UberSDFParameters params) {
  Entity entity;
  entity.SetTransform(GetCurrentTransform());
  entity.SetBlendMode(paint.blend_mode);
 
  if (paint.color_source) {
    // Since we are going to use BlendMode::kSrcIn to implement the color_source
    // the SDF portion of the blend should just be solid white to get the
    // correct color from the color_source.
    params.color = Color::White();
  }
  auto geometry = std::make_unique<UberSDFGeometry>(params);
  auto contents = UberSDFContents::Make(params, std::move(geometry));
  const Geometry* geom = contents->GetGeometry();
 
  if (paint.color_source) {
    // UberSDF doesn't perform things like gradients so we blend the SDF
    // with the color source.
    std::shared_ptr<Contents> color_source_contents =
        paint.CreateContents(renderer_, geom);
    std::shared_ptr<Contents> final_contents = ColorFilterContents::MakeBlend(
        BlendMode::kSrcIn, {FilterInput::Make(std::move(contents)),
                            FilterInput::Make(color_source_contents)});
 
    Paint new_paint = paint;
    new_paint.color_source = nullptr;
    AddRenderEntityWithFiltersToCurrentPass(entity, geom, new_paint,
                                            /*reuse_depth=*/false,
                                            /*override_contents=*/
                                            std::move(final_contents));
  } else {
    AddRenderEntityWithFiltersToCurrentPass(entity, geom, paint,
                                            /*reuse_depth=*/false,
                                            /*override_contents=*/
                                            std::move(contents));
  }
}
 
void Canvas::AddRenderEntityWithFiltersToCurrentPass(
    Entity& entity,
    const Geometry* geometry,
    const Paint& paint,
    bool reuse_depth,
    std::shared_ptr<Contents> override_contents) {
  std::shared_ptr<ColorSourceContents> color_source_contents;
  std::shared_ptr<Contents> contents;
  if (override_contents) {
    contents = std::move(override_contents);
  } else {
    color_source_contents = paint.CreateContents(renderer_, geometry);
    contents = color_source_contents;
  }
 
  if (!paint.color_filter && !paint.invert_colors && !paint.image_filter &&
      !paint.mask_blur_descriptor.has_value()) {
    entity.SetContents(std::move(contents));
    AddRenderEntityToCurrentPass(entity, reuse_depth);
    return;
  }
 
  // Attempt to apply the color filter on the CPU first.
  // Note: This is not just an optimization; some color sources rely on
  //       CPU-applied color filters to behave properly.
  bool needs_color_filter = paint.color_filter || paint.invert_colors;
  if (needs_color_filter &&
      contents->ApplyColorFilter([&](Color color) -> Color {
        if (paint.color_filter) {
          color = GetCPUColorFilterProc(paint.color_filter)(color);
        }
        if (paint.invert_colors) {
          color = color.ApplyColorMatrix(kColorInversion);
        }
        return color;
      })) {
    needs_color_filter = false;
  }
 
  bool can_apply_mask_filter = geometry->CanApplyMaskFilter();
 
  if (can_apply_mask_filter && paint.mask_blur_descriptor.has_value()) {
    // If there's a mask blur and we need to apply the color filter on the GPU,
    // we need to be careful to only apply the color filter to the source
    // colors. CreateMaskBlur is able to handle this case.
    FML_DCHECK(color_source_contents) << "Mask blur is only supported when no "
                                         "override contents are provided.";
    FillRectGeometry out_rect(Rect{});
    auto filter = paint.mask_blur_descriptor->CreateMaskBlur(
        paint, renderer_, geometry, color_source_contents, needs_color_filter,
        &out_rect);
    entity.SetContents(std::move(filter));
    AddRenderEntityToCurrentPass(entity, reuse_depth);
    return;
  }
 
  std::shared_ptr<Contents> contents_copy = std::move(contents);
 
  // Image input types will directly set their color filter,
  // if any. See `TiledTextureContents.SetColorFilter`.
  if (needs_color_filter &&
      (!paint.color_source ||
       paint.color_source->type() != flutter::DlColorSourceType::kImage)) {
    if (paint.color_filter) {
      contents_copy = WrapWithGPUColorFilter(
          paint.color_filter, FilterInput::Make(std::move(contents_copy)),
          ColorFilterContents::AbsorbOpacity::kYes);
    }
    if (paint.invert_colors) {
      contents_copy =
          WrapWithInvertColors(FilterInput::Make(std::move(contents_copy)),
                               ColorFilterContents::AbsorbOpacity::kYes);
    }
  }
 
  if (paint.image_filter) {
    std::shared_ptr<FilterContents> filter =
        WrapInput(renderer_, paint.image_filter,
                  FilterInput::Make(std::move(contents_copy)));
    filter->SetRenderingMode(Entity::RenderingMode::kDirect);
    entity.SetContents(filter);
    AddRenderEntityToCurrentPass(entity, reuse_depth);
    return;
  }
 
  entity.SetContents(std::move(contents_copy));
  AddRenderEntityToCurrentPass(entity, reuse_depth);
}
 
void Canvas::AddRenderEntityToCurrentPass(Entity& entity, bool reuse_depth) {
  if (IsSkipping()) {
    return;
  }
 
  entity.SetTransform(
      Matrix::MakeTranslation(Vector3(-GetGlobalPassPosition())) *
      entity.GetTransform());
  entity.SetInheritedOpacity(transform_stack_.back().distributed_opacity);
  if (entity.GetBlendMode() == BlendMode::kSrcOver &&
      entity.GetContents()->IsOpaque(entity.GetTransform())) {
    entity.SetBlendMode(BlendMode::kSrc);
  }
 
  // If the entity covers the current render target and is a solid color, then
  // conditionally update the backdrop color to its solid color value blended
  // with the current backdrop.
  if (render_passes_.back().IsApplyingClearColor()) {
    std::optional<Color> maybe_color = entity.AsBackgroundColor(
        render_passes_.back().GetInlinePassContext()->GetTexture()->GetSize());
    if (maybe_color.has_value()) {
      Color color = maybe_color.value();
      RenderTarget& render_target = render_passes_.back()
                                        .GetInlinePassContext()
                                        ->GetPassTarget()
                                        .GetRenderTarget();
      ColorAttachment attachment = render_target.GetColorAttachment(0);
      // Attachment.clear color needs to be premultiplied at all times, but the
      // Color::Blend function requires unpremultiplied colors.
      attachment.clear_color = attachment.clear_color.Unpremultiply()
                                   .Blend(color, entity.GetBlendMode())
                                   .Premultiply();
      render_target.SetColorAttachment(attachment, 0u);
      return;
    }
  }
  if (!reuse_depth) {
    ++current_depth_;
  }
 
  // We can render at a depth up to and including the depth of the currently
  // active clips and we will still be clipped out, but we cannot render at
  // a depth that is greater than the current clips or we will not be clipped.
  FML_DCHECK(current_depth_ <= transform_stack_.back().clip_depth)
      << current_depth_ << " <=? " << transform_stack_.back().clip_depth;
  entity.SetClipDepth(current_depth_);
 
  if (entity.GetBlendMode() > Entity::kLastPipelineBlendMode) {
    if (renderer_.GetDeviceCapabilities().SupportsFramebufferFetch()) {
      ApplyFramebufferBlend(entity);
    } else {
      // End the active pass and flush the buffer before rendering "advanced"
      // blends. Advanced blends work by binding the current render target
      // texture as an input ("destination"), blending with a second texture
      // input ("source"), writing the result to an intermediate texture, and
      // finally copying the data from the intermediate texture back to the
      // render target texture. And so all of the commands that have written
      // to the render target texture so far need to execute before it's bound
      // for blending (otherwise the blend pass will end up executing before
      // all the previous commands in the active pass).
      auto input_texture = FlipBackdrop(GetGlobalPassPosition(),  //
                                        /*should_remove_texture=*/false,
                                        /*should_use_onscreen=*/false,
                                        /*post_depth_increment=*/true);
      if (!input_texture) {
        return;
      }
 
      // The coverage hint tells the rendered Contents which portion of the
      // rendered output will actually be used, and so we set this to the
      // current clip coverage (which is the max clip bounds). The contents may
      // optionally use this hint to avoid unnecessary rendering work.
      auto element_coverage_hint = entity.GetContents()->GetCoverageHint();
      entity.GetContents()->SetCoverageHint(Rect::Intersection(
          element_coverage_hint, clip_coverage_stack_.CurrentClipCoverage()));
 
      FilterInput::Vector inputs = {
          FilterInput::Make(input_texture, entity.GetTransform().Invert()),
          FilterInput::Make(entity.GetContents())};
      auto contents =
          ColorFilterContents::MakeBlend(entity.GetBlendMode(), inputs);
      entity.SetContents(std::move(contents));
      entity.SetBlendMode(BlendMode::kSrc);
    }
  }
 
  const std::shared_ptr<RenderPass>& result =
      render_passes_.back().GetInlinePassContext()->GetRenderPass();
  if (!result) {
    // Failure to produce a render pass should be explained by specific errors
    // in `InlinePassContext::GetRenderPass()`, so avoid log spam and don't
    // append a validation log here.
    return;
  }
 
  entity.Render(renderer_, *result);
}
 
RenderPass& Canvas::GetCurrentRenderPass() const {
  return *render_passes_.back().GetInlinePassContext()->GetRenderPass();
}
 
void Canvas::SetBackdropData(
    std::unordered_map<int64_t, BackdropData> backdrop_data,
    size_t backdrop_count) {
  backdrop_data_ = std::move(backdrop_data);
  backdrop_count_ = backdrop_count;
}
 
std::shared_ptr<Texture> Canvas::FlipBackdrop(Point global_pass_position,
                                              bool should_remove_texture,
                                              bool should_use_onscreen,
                                              bool post_depth_increment) {
  LazyRenderingConfig rendering_config = std::move(render_passes_.back());
  render_passes_.pop_back();
 
  // If the very first thing we render in this EntityPass is a subpass that
  // happens to have a backdrop filter or advanced blend, than that backdrop
  // filter/blend will sample from an uninitialized texture.
  //
  // By calling `pass_context.GetRenderPass` here, we force the texture to pass
  // through at least one RenderPass with the correct clear configuration before
  // any sampling occurs.
  //
  // In cases where there are no contents, we
  // could instead check the clear color and initialize a 1x2 CPU texture
  // instead of ending the pass.
  rendering_config.GetInlinePassContext()->GetRenderPass();
  if (!rendering_config.GetInlinePassContext()->EndPass()) {
    VALIDATION_LOG
        << "Failed to end the current render pass in order to read from "
           "the backdrop texture and apply an advanced blend or backdrop "
           "filter.";
    // Note: adding this render pass ensures there are no later crashes from
    // unbalanced save layers. Ideally, this method would return false and the
    // renderer could handle that by terminating dispatch.
    render_passes_.emplace_back(std::move(rendering_config));
    return nullptr;
  }
 
  const std::shared_ptr<Texture>& input_texture =
      rendering_config.GetInlinePassContext()->GetTexture();
 
  if (!input_texture) {
    VALIDATION_LOG << "Failed to fetch the color texture in order to "
                      "apply an advanced blend or backdrop filter.";
 
    // Note: see above.
    render_passes_.emplace_back(std::move(rendering_config));
    return nullptr;
  }
 
  if (should_use_onscreen) {
    ColorAttachment color0 = render_target_.GetColorAttachment(0);
    // When MSAA is being used, we end up overriding the entire backdrop by
    // drawing the previous pass texture, and so we don't have to clear it and
    // can use kDontCare.
    color0.load_action = color0.resolve_texture != nullptr
                             ? LoadAction::kDontCare
                             : LoadAction::kLoad;
    render_target_.SetColorAttachment(color0, 0);
 
    auto entity_pass_target = std::make_unique<EntityPassTarget>(
        render_target_,                                                    //
        renderer_.GetDeviceCapabilities().SupportsReadFromResolve(),       //
        renderer_.GetDeviceCapabilities().SupportsImplicitResolvingMSAA()  //
    );
    render_passes_.push_back(
        LazyRenderingConfig(renderer_, std::move(entity_pass_target)));
    requires_readback_ = false;
  } else {
    render_passes_.emplace_back(std::move(rendering_config));
    // If the current texture is being cached for a BDF we need to ensure we
    // don't recycle it during recording; remove it from the entity pass target.
    if (should_remove_texture) {
      render_passes_.back().GetEntityPassTarget()->RemoveSecondary();
    }
  }
  RenderPass& current_render_pass =
      *render_passes_.back().GetInlinePassContext()->GetRenderPass();
 
  // Eagerly restore the BDF contents.
 
  // If the pass context returns a backdrop texture, we need to draw it to the
  // current pass. We do this because it's faster and takes significantly less
  // memory than storing/loading large MSAA textures. Also, it's not possible
  // to blit the non-MSAA resolve texture of the previous pass to MSAA
  // textures (let alone a transient one).
  Rect size_rect = Rect::MakeSize(input_texture->GetSize());
  auto msaa_backdrop_contents = TextureContents::MakeRect(size_rect);
  msaa_backdrop_contents->SetStencilEnabled(false);
  msaa_backdrop_contents->SetLabel("MSAA backdrop");
  msaa_backdrop_contents->SetSourceRect(size_rect);
  msaa_backdrop_contents->SetTexture(input_texture);
 
  Entity msaa_backdrop_entity;
  msaa_backdrop_entity.SetContents(std::move(msaa_backdrop_contents));
  msaa_backdrop_entity.SetBlendMode(BlendMode::kSrc);
  msaa_backdrop_entity.SetClipDepth(std::numeric_limits<uint32_t>::max());
  if (!msaa_backdrop_entity.Render(renderer_, current_render_pass)) {
    VALIDATION_LOG << "Failed to render MSAA backdrop entity.";
    return nullptr;
  }
 
  // Restore any clips that were recorded before the backdrop filter was
  // applied.
  auto& replay_entities = clip_coverage_stack_.GetReplayEntities();
  uint64_t current_depth =
      post_depth_increment ? current_depth_ - 1 : current_depth_;
  for (const auto& replay : replay_entities) {
    if (replay.clip_depth <= current_depth) {
      continue;
    }
 
    SetClipScissor(replay.clip_coverage, current_render_pass,
                   global_pass_position);
    if (!replay.clip_contents.Render(renderer_, current_render_pass,
                                     replay.clip_depth)) {
      VALIDATION_LOG << "Failed to render entity for clip restore.";
    }
  }
 
  return input_texture;
}
 
bool Canvas::SupportsBlitToOnscreen() const {
  return renderer_.GetContext()
             ->GetCapabilities()
             ->SupportsTextureToTextureBlits() &&
         renderer_.GetContext()->GetBackendType() ==
             Context::BackendType::kMetal;
}
 
bool Canvas::BlitToOnscreen(bool is_onscreen) {
  auto command_buffer = renderer_.GetContext()->CreateCommandBuffer();
  command_buffer->SetLabel("EntityPass Root Command Buffer");
  auto offscreen_target = render_passes_.back()
                              .GetInlinePassContext()
                              ->GetPassTarget()
                              .GetRenderTarget();
  if (SupportsBlitToOnscreen()) {
    auto blit_pass = command_buffer->CreateBlitPass();
    blit_pass->AddCopy(offscreen_target.GetRenderTargetTexture(),
                       render_target_.GetRenderTargetTexture());
    if (!blit_pass->EncodeCommands()) {
      VALIDATION_LOG << "Failed to encode root pass blit command.";
      return false;
    }
  } else {
    auto render_pass = command_buffer->CreateRenderPass(render_target_);
    render_pass->SetLabel("EntityPass Root Render Pass");
 
    {
      auto size_rect = Rect::MakeSize(offscreen_target.GetRenderTargetSize());
      auto contents = TextureContents::MakeRect(size_rect);
      contents->SetTexture(offscreen_target.GetRenderTargetTexture());
      contents->SetSourceRect(size_rect);
      contents->SetLabel("Root pass blit");
 
      Entity entity;
      entity.SetContents(contents);
      entity.SetBlendMode(BlendMode::kSrc);
 
      if (!entity.Render(renderer_, *render_pass)) {
        VALIDATION_LOG << "Failed to render EntityPass root blit.";
        return false;
      }
    }
 
    if (!render_pass->EncodeCommands()) {
      VALIDATION_LOG << "Failed to encode root pass command buffer.";
      return false;
    }
  }
 
  if (is_onscreen) {
    return renderer_.GetContext()->SubmitOnscreen(std::move(command_buffer));
  } else {
    return renderer_.GetContext()->EnqueueCommandBuffer(
        std::move(command_buffer));
  }
}
 
bool Canvas::EnsureFinalMipmapGeneration() const {
  if (!render_target_.GetRenderTargetTexture()->NeedsMipmapGeneration()) {
    return true;
  }
  std::shared_ptr<CommandBuffer> cmd_buffer =
      renderer_.GetContext()->CreateCommandBuffer();
  if (!cmd_buffer) {
    return false;
  }
  std::shared_ptr<BlitPass> blit_pass = cmd_buffer->CreateBlitPass();
  if (!blit_pass) {
    return false;
  }
  blit_pass->GenerateMipmap(render_target_.GetRenderTargetTexture());
  blit_pass->EncodeCommands();
  return renderer_.GetContext()->EnqueueCommandBuffer(std::move(cmd_buffer));
}
 
void Canvas::EndReplay() {
  FML_DCHECK(render_passes_.size() == 1u);
  render_passes_.back().GetInlinePassContext()->GetRenderPass();
  render_passes_.back().GetInlinePassContext()->EndPass(
      /*is_onscreen=*/!requires_readback_ && is_onscreen_);
  backdrop_data_.clear();
 
  // If requires_readback_ was true, then we rendered to an offscreen texture
  // instead of to the onscreen provided in the render target. Now we need to
  // draw or blit the offscreen back to the onscreen.
  if (requires_readback_) {
    BlitToOnscreen(/*is_onscreen_=*/is_onscreen_);
  }
  if (!EnsureFinalMipmapGeneration()) {
    VALIDATION_LOG << "Failed to generate onscreen mipmaps.";
  }
  if (!renderer_.GetContext()->FlushCommandBuffers()) {
    // Not much we can do.
    VALIDATION_LOG << "Failed to submit command buffers";
  }
  render_passes_.clear();
  renderer_.GetRenderTargetCache()->End();
  clip_geometry_.clear();
 
  Reset();
  Initialize(initial_cull_rect_);
}
 
bool Canvas::IsCompatibleWithSDFRendering(const Paint& paint) {
  if (!paint.anti_alias) {
    return false;
  }
  if (paint.mask_blur_descriptor.has_value()) {
    return false;
  }
  switch (paint.blend_mode) {
    // Incompatible blend modes:
    case BlendMode::kClear:
    case BlendMode::kSrc:
    case BlendMode::kSrcIn:
    case BlendMode::kDstIn:
    case BlendMode::kSrcOut:
    case BlendMode::kDstATop:
    case BlendMode::kPlus:
    case BlendMode::kModulate:
      return false;
    // Compatible blend modes:
    case BlendMode::kDst:
    case BlendMode::kSrcOver:
    case BlendMode::kDstOver:
    case BlendMode::kDstOut:
    case BlendMode::kSrcATop:
    case BlendMode::kXor:
    case BlendMode::kScreen:
    case BlendMode::kOverlay:
    case BlendMode::kDarken:
    case BlendMode::kLighten:
    case BlendMode::kColorDodge:
    case BlendMode::kColorBurn:
    case BlendMode::kHardLight:
    case BlendMode::kSoftLight:
    case BlendMode::kDifference:
    case BlendMode::kExclusion:
    case BlendMode::kMultiply:
    case BlendMode::kHue:
    case BlendMode::kSaturation:
    case BlendMode::kColor:
    case BlendMode::kLuminosity:
      return true;
  }
}
 
LazyRenderingConfig::LazyRenderingConfig(
    ContentContext& renderer,
    std::unique_ptr<EntityPassTarget> p_entity_pass_target)
    : entity_pass_target_(std::move(p_entity_pass_target)) {
  inline_pass_context_ =
      std::make_unique<InlinePassContext>(renderer, *entity_pass_target_);
}
 
bool LazyRenderingConfig::IsApplyingClearColor() const {
  return !inline_pass_context_->IsActive();
}
 
EntityPassTarget* LazyRenderingConfig::GetEntityPassTarget() const {
  return entity_pass_target_.get();
}
 
InlinePassContext* LazyRenderingConfig::GetInlinePassContext() const {
  return inline_pass_context_.get();
}
 
}  // namespace impeller