Migrate surface frame shell code to DisplayList/Impeller geometry classes (flutter#173086)

Converting a large variety of classes involved in tracking surfaces,
frames, surface damage, etc. to using the DisplayList/Impeller geometry
classes.

Addresses a bullet item in
flutter#161456

---------

Co-authored-by: Reid Baker <[email protected]>

Author: 2 people

engine/src/flutter/display_list/skia/dl_sk_conversions_unittests.cc

@@ -29,6 +29,70 @@ TEST(DisplayListImageFilter, LocalImageSkiaNull) {
   ASSERT_EQ(ToSk(dl_local_matrix_filter), nullptr);
 }
 
+// This test exists just to confirm and demonstrate how to convert existing
+// SkMatrix construction code into the same operations using the replacement
+// DlMatrix/impeller::Matrix objects.
+//
+// To be clear, it verifies:
+// SkMatrix.pre<Op>(data) is the same as DlMatrix * DlMatrix::Make<Op>(data).
+// SkMatrix1.preConcat(SkMatrix2) is the same as DlMatrix1 * DlMatrix2.
+TEST(DisplayListSkConversions, OpOrderPreMethodsVsMatrixMultiply) {
+  // If you have code like this...
+  const SkMatrix sk_matrix =
+      SkMatrix().preTranslate(0, 800).preRotate(-90, 0, 0);
+
+  // Convert it to math like this (same order as the pre<Op>() calls)...
+  const DlMatrix dl_matrix = DlMatrix::MakeTranslation({0, 800}) *
+                             DlMatrix::MakeRotationZ(DlDegrees(-90));
+  SkPoint sk_result = sk_matrix.mapPoint({10, 10});
+  DlPoint dl_result = dl_matrix * DlPoint(10, 10);
+  EXPECT_FLOAT_EQ(sk_result.fX, dl_result.x);
+  EXPECT_FLOAT_EQ(sk_result.fY, dl_result.y);
+
+  // Not like this...
+  const DlMatrix dl_matrix_2 = DlMatrix::MakeRotationZ(DlDegrees(-90)) *
+                               DlMatrix::MakeTranslation({0, 800});
+  DlPoint dl_result_2 = dl_matrix_2 * DlPoint(10, 10);
+  EXPECT_FALSE(impeller::ScalarNearlyEqual(sk_result.fX, dl_result_2.x));
+  EXPECT_FALSE(impeller::ScalarNearlyEqual(sk_result.fY, dl_result_2.y));
+
+  // -------------------------------------------------------------------
+
+  // And if you have this...
+  SkMatrix sk_matrix_2;
+  sk_matrix_2.preConcat(SkMatrix::Translate(0, 800));
+  sk_matrix_2.preConcat(SkMatrix::RotateDeg(-90));
+
+  // It's really the same as the above case, btw...
+  SkPoint sk_result_2 = sk_matrix_2.mapPoint({10, 10});
+  EXPECT_FLOAT_EQ(sk_result.fX, sk_result_2.fX);
+  EXPECT_FLOAT_EQ(sk_result.fY, sk_result_2.fY);
+
+  // Convert it to math like this (same order as the pre<Op>() calls)...
+  DlMatrix dl_matrix_3;
+  dl_matrix_3 = dl_matrix_3 * DlMatrix::MakeTranslation({0, 800});
+  dl_matrix_3 = dl_matrix_3 * DlMatrix::MakeRotationZ(DlDegrees(-90));
+  DlPoint dl_result_3 = dl_matrix_3 * DlPoint(10, 10);
+  EXPECT_FLOAT_EQ(sk_result_2.fX, dl_result_3.x);
+  EXPECT_FLOAT_EQ(sk_result_2.fY, dl_result_3.y);
+
+  // Which is also the same result as the first case above...
+  EXPECT_FLOAT_EQ(dl_result_3.x, dl_result.x);
+  EXPECT_FLOAT_EQ(dl_result_3.y, dl_result.y);
+
+  // Not like this...
+  DlMatrix dl_matrix_4;
+  dl_matrix_4 = dl_matrix_4 * DlMatrix::MakeRotationZ(DlDegrees(-90));
+  dl_matrix_4 = dl_matrix_4 * DlMatrix::MakeTranslation({0, 800});
+  DlPoint dl_result_4 = dl_matrix_4 * DlPoint(10, 10);
+  EXPECT_FALSE(impeller::ScalarNearlyEqual(sk_result_2.fX, dl_result_4.x));
+  EXPECT_FALSE(impeller::ScalarNearlyEqual(sk_result_2.fY, dl_result_4.y));
+
+  // Which is also the same result as the second case above...
+  EXPECT_FLOAT_EQ(dl_result_4.x, dl_result_2.x);
+  EXPECT_FLOAT_EQ(dl_result_4.y, dl_result_2.y);
+}
+
 TEST(DisplayListSkConversions, ToSkColor) {
   // Red
   ASSERT_EQ(ToSkColor(DlColor::kRed()), SK_ColorRED);

engine/src/flutter/display_list/testing/dl_test_snippets.h

@@ -12,7 +12,6 @@
 #include "flutter/display_list/effects/dl_image_filters.h"
 #include "flutter/testing/testing.h"
 
-#include "third_party/skia/include/core/SkCanvas.h"
 #include "third_party/skia/include/core/SkPath.h"
 #include "third_party/skia/include/core/SkRRect.h"
 #include "third_party/skia/include/core/SkSurface.h"

engine/src/flutter/display_list/testing/dl_test_surface_gl.cc

@@ -4,7 +4,6 @@
 
 #include "flutter/display_list/testing/dl_test_surface_gl.h"
 
-#include "third_party/skia/include/core/SkCanvas.h"
 #include "third_party/skia/include/core/SkSurface.h"
 #include "third_party/skia/include/gpu/ganesh/SkSurfaceGanesh.h"
 
@@ -16,7 +15,7 @@ using PixelFormat = DlSurfaceProvider::PixelFormat;
 bool DlOpenGLSurfaceProvider::InitializeSurface(size_t width,
                                                 size_t height,
                                                 PixelFormat format) {
-  gl_surface_ = std::make_unique<TestGLSurface>(SkISize::Make(width, height));
+  gl_surface_ = std::make_unique<TestGLSurface>(DlISize(width, height));
   gl_surface_->MakeCurrent();
 
   primary_ = MakeOffscreenSurface(width, height, format);

engine/src/flutter/display_list/testing/dl_test_surface_metal.mm

@@ -7,7 +7,6 @@
 #include "flutter/impeller/display_list/dl_image_impeller.h"
 #include "flutter/impeller/typographer/backends/skia/typographer_context_skia.h"
 
-#include "third_party/skia/include/core/SkCanvas.h"
 #include "third_party/skia/include/core/SkSurface.h"
 
 namespace flutter {
@@ -48,7 +47,7 @@ explicit DlMetalSurfaceInstance(std::unique_ptr<TestMetalSurface> metal_surface)
     size_t width,
     size_t height,
     PixelFormat format) const {
-  auto surface = TestMetalSurface::Create(*metal_context_, SkISize::Make(width, height));
+  auto surface = TestMetalSurface::Create(*metal_context_, DlISize(width, height));
   surface->GetSurface()->getCanvas()->clear(SK_ColorTRANSPARENT);
   return std::make_shared<DlMetalSurfaceInstance>(std::move(surface));
 }

engine/src/flutter/display_list/testing/dl_test_surface_provider.cc

@@ -4,10 +4,6 @@
 
 #include "flutter/display_list/testing/dl_test_surface_provider.h"
 
-#include "third_party/skia/include/core/SkCanvas.h"
-#include "third_party/skia/include/core/SkData.h"
-#include "third_party/skia/include/core/SkImage.h"
-#include "third_party/skia/include/core/SkSurface.h"
 #include "third_party/skia/include/encode/SkPngEncoder.h"
 #include "third_party/skia/include/gpu/ganesh/GrDirectContext.h"
 

engine/src/flutter/display_list/testing/dl_test_surface_software.cc

@@ -4,7 +4,6 @@
 
 #include "flutter/display_list/testing/dl_test_surface_software.h"
 
-#include "third_party/skia/include/core/SkCanvas.h"
 #include "third_party/skia/include/core/SkSurface.h"
 
 namespace flutter {

engine/src/flutter/flow/compositor_context.cc

@@ -7,7 +7,6 @@
 #include <optional>
 #include <utility>
 #include "flutter/flow/layers/layer_tree.h"
-#include "third_party/skia/include/core/SkCanvas.h"
 
 namespace flutter {
 
@@ -74,7 +73,7 @@ std::unique_ptr<CompositorContext::ScopedFrame> CompositorContext::AcquireFrame(
     GrDirectContext* gr_context,
     DlCanvas* canvas,
     ExternalViewEmbedder* view_embedder,
-    const SkMatrix& root_surface_transformation,
+    const DlMatrix& root_surface_transformation,
     bool instrumentation_enabled,
     bool surface_supports_readback,
     fml::RefPtr<fml::RasterThreadMerger>
@@ -91,7 +90,7 @@ CompositorContext::ScopedFrame::ScopedFrame(
     GrDirectContext* gr_context,
     DlCanvas* canvas,
     ExternalViewEmbedder* view_embedder,
-    const SkMatrix& root_surface_transformation,
+    const DlMatrix& root_surface_transformation,
     bool instrumentation_enabled,
     bool surface_supports_readback,
     fml::RefPtr<fml::RasterThreadMerger> raster_thread_merger,

engine/src/flutter/flow/compositor_context.h

@@ -16,7 +16,6 @@
 #include "flutter/flow/stopwatch.h"
 #include "flutter/fml/macros.h"
 #include "flutter/fml/raster_thread_merger.h"
-#include "third_party/skia/include/core/SkCanvas.h"
 #include "third_party/skia/include/gpu/ganesh/GrDirectContext.h"
 
 namespace flutter {
@@ -111,7 +110,7 @@ class CompositorContext {
                 GrDirectContext* gr_context,
                 DlCanvas* canvas,
                 ExternalViewEmbedder* view_embedder,
-                const SkMatrix& root_surface_transformation,
+                const DlMatrix& root_surface_transformation,
                 bool instrumentation_enabled,
                 bool surface_supports_readback,
                 fml::RefPtr<fml::RasterThreadMerger> raster_thread_merger,
@@ -125,7 +124,7 @@ class CompositorContext {
 
     CompositorContext& context() const { return context_; }
 
-    const SkMatrix& root_surface_transformation() const {
+    const DlMatrix& root_surface_transformation() const {
       return root_surface_transformation_;
     }
 
@@ -154,7 +153,7 @@ class CompositorContext {
     DlCanvas* canvas_;
     impeller::AiksContext* aiks_context_;
     ExternalViewEmbedder* view_embedder_;
-    const SkMatrix root_surface_transformation_;
+    const DlMatrix root_surface_transformation_;
     const bool instrumentation_enabled_;
     const bool surface_supports_readback_;
     fml::RefPtr<fml::RasterThreadMerger> raster_thread_merger_;
@@ -172,7 +171,7 @@ class CompositorContext {
       GrDirectContext* gr_context,
       DlCanvas* canvas,
       ExternalViewEmbedder* view_embedder,
-      const SkMatrix& root_surface_transformation,
+      const DlMatrix& root_surface_transformation,
       bool instrumentation_enabled,
       bool surface_supports_readback,
       fml::RefPtr<fml::RasterThreadMerger> raster_thread_merger,

engine/src/flutter/flow/layers/layer_tree.cc

@@ -37,8 +37,8 @@ bool LayerTree::Preroll(CompositorContext::ScopedFrame& frame,
 
   SkColorSpace* color_space = GetColorSpace(frame.canvas());
   LayerStateStack state_stack;
-  state_stack.set_preroll_delegate(
-      cull_rect, ToDlMatrix(frame.root_surface_transformation()));
+  state_stack.set_preroll_delegate(cull_rect,
+                                   frame.root_surface_transformation());
 
   raster_cache_items_.clear();
 

engine/src/flutter/flow/layers/layer_tree_unittests.cc

@@ -22,15 +22,14 @@ class LayerTreeTest : public CanvasTest {
   LayerTreeTest()
       : root_transform_(DlMatrix::MakeTranslation({1.0f, 1.0f})),
         builder_(DisplayListBuilder::kMaxCullRect),
-        scoped_frame_(
-            compositor_context_.AcquireFrame(nullptr,
-                                             &builder_,
-                                             nullptr,
-                                             ToSkMatrix(root_transform_),
-                                             false,
-                                             true,
-                                             nullptr,
-                                             nullptr)) {}
+        scoped_frame_(compositor_context_.AcquireFrame(nullptr,
+                                                       &builder_,
+                                                       nullptr,
+                                                       root_transform_,
+                                                       false,
+                                                       true,
+                                                       nullptr,
+                                                       nullptr)) {}
 
   CompositorContext::ScopedFrame& frame() { return *scoped_frame_.get(); }
   const DlMatrix& root_transform() { return root_transform_; }