clean up public m44 and camera api

saveCamera() is no longer experimental

In a separate CL, will stage changes to concat virtual to take M44.

Change-Id: Iaf37ce2f24ab1223c54aeb1e79eaebf18f87fece
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/281589
Reviewed-by: Brian Osman <[email protected]>
Commit-Queue: Mike Reed <[email protected]>

Author: reed-at-google

bench/GameBench.cpp

@@ -368,7 +368,7 @@ class CanvasMatrixBench : public Benchmark {
                     case kScale_Type:     canvas->scale(1.0001f, 0.9999f); break;
                     case k2x3_Type:       canvas->concat(m); break;
                     case k3x3_Type:       canvas->concat(m); break;
-                    case k4x4_Type:       canvas->concat44(m4); break;
+                    case k4x4_Type:       canvas->concat(m4); break;
                 }
             }
             canvas->restore();

bench/Matrix44Bench.cpp

@@ -21,8 +21,8 @@ class M4Bench : public Benchmark {
         for (auto& v : value) {
             v = rand.nextF();
         }
-        fM1.setColMajor(value + 0);
-        fM2.setColMajor(value + 16);
+        fM1 = SkM44::ColMajor(value + 0);
+        fM2 = SkM44::ColMajor(value + 16);
     }
 
     bool isSuitableFor(Backend backend) override {

gm/3d.cpp

@@ -50,7 +50,7 @@ static void do_draw(SkCanvas* canvas, SkColor color) {
 
     SkM44 m = SkM44::Rotate({0, 1, 0}, SK_ScalarPI/6);
 
-    canvas->concat44(make_ctm(info, m, {300, 300}));
+    canvas->concat(make_ctm(info, m, {300, 300}));
 
     canvas->translate(150, 150);
     SkPaint paint;

gm/crbug_224618.cpp

@@ -88,7 +88,7 @@ class CrBug224618GM : public skiagm::GM {
                     SkM44::Translate(-radius, -radius);          // center content
 
             canvas->save();
-            canvas->concat44(model);
+            canvas->concat(model);
 
             SkPaint fillPaint;
             fillPaint.setAntiAlias(true);

gm/postercircle.cpp

@@ -124,7 +124,7 @@ class PosterCircleGM : public skiagm::GM {
                                 * SkM44::Translate(0, ringY, 0)
                                 * SkM44::Rotate({0,1,0}, SkDegreesToRadians(yRotation))
                                 * SkM44::Translate(0, 0, kRingRadius);
-                    canvas->concat44(model);
+                    canvas->concat(model);
 
                     SkRect poster = SkRect::MakeLTRB(-0.5f * kPosterSize, -0.5f * kPosterSize,
                                                       0.5f * kPosterSize,  0.5f * kPosterSize);

include/core/SkCanvas.h

@@ -756,8 +756,19 @@ class SK_API SkCanvas {
     */
     int saveLayer(const SaveLayerRec& layerRec);
 
-    int experimental_saveCamera(const SkM44& projection, const SkM44& camera);
-    int experimental_saveCamera(const SkScalar projection[16], const SkScalar camera[16]);
+    /**
+     *  Save the matrix and clip state (just like save()), but then also concat
+     *  two more matrices: projection and camera. This call is logically similar to:
+     *      save()
+     *      concat(projection)
+     *      concat(camera)
+     *  However, these matrices are tracked by the canvas, so if any shader references
+     *  lights or normals, these can be properly transformed, as they will have access to
+     *  local-to-world and local-to-camera.
+     *
+     *  returns the current save count (see getSaveCount()).
+     */
+    int saveCamera(const SkM44& projection, const SkM44& camera);
 
     /** Removes changes to SkMatrix and clip since SkCanvas state was
         last saved. The state is removed from the stack.
@@ -880,8 +891,13 @@ class SK_API SkCanvas {
         example: https://fiddle.skia.org/c/@Canvas_concat
     */
     void concat(const SkMatrix& matrix);
-    void concat44(const SkM44&);
-    void concat44(const SkScalar[]); // column-major
+    void concat(const SkM44&);
+
+    // DEPRECATED
+#if 1
+    void concat44(const SkM44& m) { this->concat(m); }
+    void concat44(const SkScalar cm[]) { this->concat(SkM44::ColMajor(cm)); }
+#endif
 
     /** Replaces SkMatrix with matrix.
         Unlike concat(), any prior matrix state is overwritten.
@@ -2427,15 +2443,13 @@ class SK_API SkCanvas {
         example: https://fiddle.skia.org/c/@Clip
     */
     SkMatrix getTotalMatrix() const;
+
     SkM44 getLocalToDevice() const; // entire matrix stack
-    void getLocalToDevice(SkScalar colMajor[16]) const;
 
+    // These will go away when we have formal access to these from SkSL
     SkM44 experimental_getLocalToWorld() const;  // up to but not including top-most camera
     SkM44 experimental_getLocalToCamera() const; // up to and including top-most camera
 
-    void experimental_getLocalToWorld(SkScalar colMajor[16]) const;
-    void experimental_getLocalToCamera(SkScalar colMajor[16]) const;
-
     ///////////////////////////////////////////////////////////////////////////
 
     // don't call

include/core/SkM44.h

@@ -158,10 +158,10 @@ class SkM44 {
           SkScalar m2, SkScalar m6, SkScalar m10, SkScalar m14,
           SkScalar m3, SkScalar m7, SkScalar m11, SkScalar m15)
     {
-        this->set44(m0, m4, m8,  m12,
-                    m1, m5, m9,  m13,
-                    m2, m6, m10, m14,
-                    m3, m7, m11, m15);
+        fMat[0] = m0; fMat[4] = m4; fMat[8]  = m8;  fMat[12] = m12;
+        fMat[1] = m1; fMat[5] = m5; fMat[9]  = m9;  fMat[13] = m13;
+        fMat[2] = m2; fMat[6] = m6; fMat[10] = m10; fMat[14] = m14;
+        fMat[3] = m3; fMat[7] = m7; fMat[11] = m11; fMat[15] = m15;
     }
 
     static SkM44 Rows(const SkV4& r0, const SkV4& r1, const SkV4& r2, const SkV4& r3) {
@@ -181,6 +181,19 @@ class SkM44 {
         return m;
     }
 
+    static SkM44 RowMajor(const SkScalar r[16]) {
+        return SkM44(r[ 0], r[ 1], r[ 2], r[ 3],
+                     r[ 4], r[ 5], r[ 6], r[ 7],
+                     r[ 8], r[ 9], r[10], r[11],
+                     r[12], r[13], r[14], r[15]);
+    }
+    static SkM44 ColMajor(const SkScalar c[16]) {
+        return SkM44(c[0], c[4], c[ 8], c[12],
+                     c[1], c[5], c[ 9], c[13],
+                     c[2], c[6], c[10], c[14],
+                     c[3], c[7], c[11], c[15]);
+    }
+
     static SkM44 Translate(SkScalar x, SkScalar y, SkScalar z = 0) {
         return SkM44(1, 0, 0, x,
                      0, 1, 0, y,
@@ -211,25 +224,6 @@ class SkM44 {
     }
     void getRowMajor(SkScalar v[]) const;
 
-    SkM44& setColMajor(const SkScalar v[]) {
-        memcpy(fMat, v, sizeof(fMat));
-        return *this;
-    }
-    SkM44& setRowMajor(const SkScalar v[]);
-
-    /* Parameters in same order as constructor.
-     */
-    SkM44& set44(SkScalar m0, SkScalar m4, SkScalar m8,  SkScalar m12,
-                 SkScalar m1, SkScalar m5, SkScalar m9,  SkScalar m13,
-                 SkScalar m2, SkScalar m6, SkScalar m10, SkScalar m14,
-                 SkScalar m3, SkScalar m7, SkScalar m11, SkScalar m15) {
-        fMat[0] = m0; fMat[4] = m4; fMat[8]  = m8;  fMat[12] = m12;
-        fMat[1] = m1; fMat[5] = m5; fMat[9]  = m9;  fMat[13] = m13;
-        fMat[2] = m2; fMat[6] = m6; fMat[10] = m10; fMat[14] = m14;
-        fMat[3] = m3; fMat[7] = m7; fMat[11] = m11; fMat[15] = m15;
-        return *this;
-    }
-
     SkScalar rc(int r, int c) const {
         SkASSERT(r >= 0 && r <= 3);
         SkASSERT(c >= 0 && c <= 3);
@@ -263,24 +257,27 @@ class SkM44 {
     }
 
     SkM44& setIdentity() {
-        return this->set44(1, 0, 0, 0,
-                           0, 1, 0, 0,
-                           0, 0, 1, 0,
-                           0, 0, 0, 1);
+        *this = { 1, 0, 0, 0,
+                  0, 1, 0, 0,
+                  0, 0, 1, 0,
+                  0, 0, 0, 1 };
+        return *this;
     }
 
     SkM44& setTranslate(SkScalar x, SkScalar y, SkScalar z = 0) {
-        return this->set44(1, 0, 0, x,
-                           0, 1, 0, y,
-                           0, 0, 1, z,
-                           0, 0, 0, 1);
+        *this = { 1, 0, 0, x,
+                  0, 1, 0, y,
+                  0, 0, 1, z,
+                  0, 0, 0, 1 };
+        return *this;
     }
 
     SkM44& setScale(SkScalar x, SkScalar y, SkScalar z = 1) {
-        return this->set44(x, 0, 0, 0,
-                           0, y, 0, 0,
-                           0, 0, z, 0,
-                           0, 0, 0, 1);
+        *this = { x, 0, 0, 0,
+                  0, y, 0, 0,
+                  0, 0, z, 0,
+                  0, 0, 0, 1 };
+        return *this;
     }
 
     /**
@@ -311,18 +308,14 @@ class SkM44 {
      */
     SkM44& setRotate(SkV3 axis, SkScalar radians);
 
-    SkM44& setConcat16(const SkM44& a, const SkScalar colMajor[16]);
-
-    SkM44& setConcat(const SkM44& a, const SkM44& b) {
-        return this->setConcat16(a, b.fMat);
-    }
+    SkM44& setConcat(const SkM44& a, const SkM44& b);
 
     friend SkM44 operator*(const SkM44& a, const SkM44& b) {
         return SkM44(a, b);
     }
 
-    SkM44& preConcat16(const SkScalar colMajor[16]) {
-        return this->setConcat16(*this, colMajor);
+    SkM44& preConcat(const SkM44& m) {
+        return this->setConcat(*this, m);
     }
 
     /** If this is invertible, return that in inverse and return true. If it is

modules/canvaskit/canvaskit_bindings.cpp

@@ -1051,10 +1051,10 @@ EMSCRIPTEN_BINDINGS(Skia) {
         // 4x4 matrix functions
         .function("saveCamera", optional_override([](SkCanvas& self,
             const SimpleM44& projection, const SimpleM44& camera) {
-            self.experimental_saveCamera(toSkM44(projection), toSkM44(camera));
+            self.saveCamera(toSkM44(projection), toSkM44(camera));
         }))
         .function("concat44", optional_override([](SkCanvas& self, const SimpleM44& m) {
-            self.concat44(toSkM44(m));
+            self.concat(toSkM44(m));
         }))
         .function("getLocalToDevice", optional_override([](const SkCanvas& self)->SimpleM44 {
             SkM44 m = self.getLocalToDevice();

modules/sksg/src/SkSGTransform.cpp

@@ -179,7 +179,7 @@ TransformEffect::~TransformEffect() {
 
 void TransformEffect::onRender(SkCanvas* canvas, const RenderContext* ctx) const {
     SkAutoCanvasRestore acr(canvas, true);
-    canvas->concat44(TransformPriv::As<SkM44>(fTransform));
+    canvas->concat(TransformPriv::As<SkM44>(fTransform));
 
     this->INHERITED::onRender(canvas, ctx);
 }

samplecode/Sample3D.cpp

@@ -90,7 +90,7 @@ class Sample3DView : public Sample {
 
         // want "world" to be in our big coordinates (e.g. area), so apply this inverse
         // as part of our "camera".
-        canvas->experimental_saveCamera(viewport * perspective, camera * inv(viewport));
+        canvas->saveCamera(viewport * perspective, camera * inv(viewport));
     }
 };
 
@@ -289,7 +289,7 @@ class SampleCubeBase : public Sample3DView {
                 SkM44 trans = SkM44::Translate(200, 200, 0);   // center of the rotation
                 SkM44 m = fRotateAnimator.rotation() * fRotation * f.asM44(200);
 
-                canvas->concat44(trans * m * inv(trans));
+                canvas->concat(trans * m * inv(trans));
                 this->drawContent(canvas, f.fColor, index++, drawFront);
             }
         }