Making a sample for shadow maps for more intensive development

samplecode/SampleShadowing.cpp

Index: samplecode/SampleShadowing.cpp
diff --git a/samplecode/SampleShadowing.cpp b/samplecode/SampleShadowing.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..914f4694a26ef1ce511de3dea9643f6ebb325827
--- /dev/null
+++ b/samplecode/SampleShadowing.cpp
@@ -0,0 +1,343 @@
+/*
+ * Copyright 2016 Google Inc.
+ *
+ * Use of this source code is governed by a BSD-style license that can be
+ * found in the LICENSE file.
+ */
+
+#include "sk_tool_utils.h"
+#include "SampleCode.h"
+#include "SkPictureRecorder.h"
+#include "SkSurface.h"

[robertphillips, 2016/08/04 15:17:35]

out of order here 

[vjiaoblack, 2016/08/04 18:03:58]

Done.

+#include "SkShadowPaintFilterCanvas.h"
+#include "SkShadowShader.h"
+
+#ifdef SK_EXPERIMENTAL_SHADOWING
+
+
+static sk_sp<SkShader> make_shadow_shader(sk_sp<SkImage> povDepth,
+                                          sk_sp<SkImage> diffuse,
+                                          sk_sp<SkLights> lights) {
+
+    sk_sp<SkShader> povDepthShader = povDepth->makeShader(SkShader::kClamp_TileMode,
+                                                          SkShader::kClamp_TileMode);
+
+    sk_sp<SkShader> diffuseShader = diffuse->makeShader(SkShader::kClamp_TileMode,
+                                                        SkShader::kClamp_TileMode);
+
+    return SkShadowShader::Make(std::move(povDepthShader),
+                                std::move(diffuseShader),
+                                std::move(lights),
+                                diffuse->width(), diffuse->height());
+}
+
+
+class IndexClick : public SkView::Click {
+public:
+    IndexClick(SkView* v, int index) : INHERITED(v), fIndex(index) {}
+

[robertphillips, 2016/08/04 15:17:35]

We don't seem to use this entry point.

Do we ever use fIndex either? Can we just create a raw SkView::Click object?

[vjiaoblack, 2016/08/04 18:03:58]

Done.

+    static int GetIndex(SkView::Click* click) {
+        return ((IndexClick*)click)->fIndex;
+    }
+
+private:
+    int fIndex;
+    typedef SkView::Click INHERITED;
+};
+
+class ShadowingView : public SampleView {
+public:
+    ShadowingView() {
+
+        this->setBGColor(0xFFCCCCCC);
+        SkLights::Builder builder;
+        builder.add(SkLights::Light(SkColor3f::Make(0.2f, 0.3f, 0.4f),
+                                    SkVector3::Make(0.27f, 0.07f, 1.0f)));
+        builder.add(SkLights::Light(SkColor3f::Make(0.4f, 0.3f, 0.2f),
+                                    SkVector3::Make(0.03f, 0.27f, 1.0f)));
+        builder.add(SkLights::Light(SkColor3f::Make(0.4f, 0.4f, 0.4f)));
+        fLights = builder.finish();
+
+        fTestRects[0].fColor = 0xFFEE8888;
+        fTestRects[0].fDepth = 80;
+        fTestRects[0].fGeometry = SkRect::MakeLTRB(200,150,350,300);
+
+        fTestRects[1].fColor = 0xFF88EE88;
+        fTestRects[1].fDepth = 160;
+        fTestRects[1].fGeometry = SkRect::MakeLTRB(150,200,300,350);
+
+        fTestRects[2].fColor = 0xFF8888EE;
+        fTestRects[2].fDepth = 240;
+        fTestRects[2].fGeometry = SkRect::MakeLTRB(100,100,250,250);
+
+        fSceneChanged = true;
+        fLightsChanged = true;
+
+        fSelectedRect = -1;
+        fMoveLight = false;
+    }
+
+protected:
+    bool onQuery(SkEvent *evt) override {
+        if (SampleCode::TitleQ(*evt)) {
+            SampleCode::TitleR(evt, "shadowing");
+            return true;
+        }
+
+        SkUnichar uni;
+        if (SampleCode::CharQ(*evt, &uni)) {
+            switch (uni) {
+                case 'L':
+                    fMoveLight = !fMoveLight;
+                    break;
+                default:
+                    break;
+            }
+        }
+        return this->INHERITED::onQuery(evt);
+    }
+

[robertphillips, 2016/08/04 15:17:35]

This is file scope syntax. Either move to file scope or switch to in-class
syntax.

I would suggest making this a static helper function in SkLights. Then we could
reuse it in the GM.

I would put the light parameter first as it seems to be the most important.

[vjiaoblack, 2016/08/04 18:03:59]

Done.

+    static SkISize compute_dmap_size(int maxDepth, const SkLights::Light& light,
+                                     int width, int height) {

[robertphillips, 2016/08/04 15:17:35]

assert it isn't an ambient light?

[vjiaoblack, 2016/08/04 18:03:58]

Done.

+        int dMapWidth = SkMin32(maxDepth * fabs(light.dir().fX) + kWidth,
+                                kWidth * 2);
+        int dMapHeight = SkMin32(maxDepth * fabs(light.dir().fY) + kHeight,
+                                 kHeight * 2);
+
+        return SkISize::Make(dMapWidth, dMapHeight);
+    }
+
+    sk_sp<SkPicture> makeTestPicture(int width, int height) {
+        SkPictureRecorder recorder;
+
+        // LONG RANGE TODO: eventually add SkBBHFactory (bounding box factory)
+        SkCanvas* canvas = recorder.beginRecording(SkRect::MakeIWH(width, height));
+
+        SkASSERT(canvas->getTotalMatrix().isIdentity());
+        SkPaint paint;
+        paint.setColor(SK_ColorGRAY);
+
+        // LONG RANGE TODO: tag occluders
+        // LONG RANGE TODO: track number of IDs we need (hopefully less than 256)
+        //                  and determinate the mapping from z to id
+
+        // universal receiver, "ground"
+        canvas->drawRect(SkRect::MakeIWH(width, height), paint);
+
+        for (int i = 0; i < kNumTestRects; i++) {
+            paint.setColor(fTestRects[i].fColor);
+            if (i == 0) {
+                canvas->translateZ(fTestRects[0].fDepth);
+            } else {
+                canvas->translateZ(fTestRects[i].fDepth - fTestRects[i-1].fDepth);
+            }
+            canvas->drawRect(fTestRects[i].fGeometry, paint);
+        }
+
+        return recorder.finishRecordingAsPicture();
+    }
+
+    void updateDepthMaps(SkCanvas *canvas) {
+        for (int i = 0; i < fLights->numLights(); ++i) {
+            // skip over ambient lights; they don't cast shadows
+            if (SkLights::Light::kAmbient_LightType == fLights->light(i).type()) {
+                continue;
+            }
+
+            // TODO: maybe add a kDepth_8_SkColorType when vertices have depth
+            // assume max depth is 255.
+            // TODO: find actual max depth of picture
+            SkISize shMapSize = compute_dmap_size(255, fLights->light(i), kWidth, kHeight);
+
+            SkImageInfo info = SkImageInfo::Make(shMapSize.fWidth, shMapSize.fHeight,
+                                                 kBGRA_8888_SkColorType,
+                                                 kOpaque_SkAlphaType);
+
+            // Create a new surface (that matches the backend of canvas)
+            // for each shadow map
+            sk_sp<SkSurface> surf(canvas->makeSurface(info));
+
+            // Wrap another SPFCanvas around the surface
+            sk_sp<SkShadowPaintFilterCanvas> depthMapCanvas =
+                    sk_make_sp<SkShadowPaintFilterCanvas>(surf->getCanvas());
+
+            // set the depth map canvas to have the light we're drawing.
+            SkLights::Builder builder;
+            builder.add(fLights->light(i));
+            sk_sp<SkLights> curLight = builder.finish();
+
+            depthMapCanvas->setLights(std::move(curLight));
+            depthMapCanvas->drawPicture(fPicture);
+
+            fLights->light(i).setShadowMap(surf->makeImageSnapshot());
+        }
+    }
+
+    void updatePovDepthMap(SkCanvas* canvas) {
+        // TODO: pass the depth to the shader in vertices, or uniforms
+        //       so we don't have to render depth and color separately
+
+        SkLights::Builder builder;
+        builder.add(SkLights::Light(SkColor3f::Make(1.0f, 1.0f, 1.0f),
+                                    SkVector3::Make(0.0f, 0.0f, 1.0f)));
+        sk_sp<SkLights> povLight = builder.finish();
+
+        SkImageInfo info = SkImageInfo::Make(kWidth, kHeight,
+                                             kBGRA_8888_SkColorType,
+                                             kOpaque_SkAlphaType);
+
+        // Create a new surface (that matches the backend of canvas)
+        // to create the povDepthMap
+        sk_sp<SkSurface> surf(canvas->makeSurface(info));
+
+        // Wrap another SPFCanvas around the surface
+        sk_sp<SkShadowPaintFilterCanvas> depthMapCanvas =
+                sk_make_sp<SkShadowPaintFilterCanvas>(surf->getCanvas());
+
+        // set the depth map canvas to have the light as the user's POV
+        depthMapCanvas->setLights(std::move(povLight));
+
+        depthMapCanvas->drawPicture(fPicture);
+
+        fPovDepthMap = surf->makeImageSnapshot();
+    }
+
+    void updateDiffuseMap(SkCanvas* canvas) {
+        SkImageInfo info = SkImageInfo::Make(kWidth, kHeight,
+                                             kBGRA_8888_SkColorType,
+                                             kOpaque_SkAlphaType);
+
+        sk_sp<SkSurface> surf(canvas->makeSurface(info));
+        surf->getCanvas()->drawPicture(fPicture);
+
+        fDiffuseMap = surf->makeImageSnapshot();
+    }
+
+    void onDrawContent(SkCanvas *canvas) override {
+        if (fSceneChanged || !fPovDepthMap) {
+            fPicture = this->makeTestPicture(kWidth, kHeight);
+            this->updateDepthMaps(canvas);
+            this->updatePovDepthMap(canvas);
+            this->updateDiffuseMap(canvas);
+        }
+
+        if (fLightsChanged) {
+            this->updateDepthMaps(canvas);
+        }
+

[robertphillips, 2016/08/04 15:17:35]

[Optional] It looks like we keep recreating the shadow shader all the time.
Maybe:

if (fSceneChanged || fLightsChanged || !fShadowShader) {
   fShadowShader = make_shadow_shader();
}

SkPaint paint;
paint.setShader(fShadowShader);

[vjiaoblack, 2016/08/04 18:03:58]

Done.

[vjiaoblack, 2016/08/04 18:03:58]

Done.

+        SkPaint paint;
+        paint.setShader(make_shadow_shader(fPovDepthMap,
+                                           fDiffuseMap,
+                                           fLights));
+
+        canvas->drawRect(SkRect::MakeIWH(kWidth, kHeight), paint);
+    }
+

[robertphillips, 2016/08/04 15:17:35]

What does the base class' implementation do?

[vjiaoblack, 2016/08/04 18:03:58]

I don't think there's a base class' implementation, is there?
It's just all .h

Anyways, I've changed this to just return a Click* and it seemed to work

[vjiaoblack, 2016/08/04 18:03:58]

Done.

+    SkView::Click* onFindClickHandler(SkScalar x, SkScalar y, unsigned modi) override {
+        int index = 0;
+
+        return new IndexClick(this, index);
+    }
+
+    bool onClick(Click *click) override {
+        SkScalar x = click->fCurr.fX;
+        SkScalar y = click->fCurr.fY;
+
+        SkScalar dx = x - click->fPrev.fX;
+        SkScalar dy = y - click->fPrev.fY;
+
+        if (fMoveLight) {

[robertphillips, 2016/08/04 15:17:35]

Shouldn't this be an || ?

[vjiaoblack, 2016/08/04 18:03:58]

Done.

+            if (dx != 0 && dy != 0) {
+                float recipX = 1.0f / kWidth;
+                float recipY = 1.0f / kHeight;
+
+                SkLights::Builder builder;
+                builder.add(SkLights::Light(SkColor3f::Make(0.2f, 0.3f, 0.4f),
+                                            SkVector3::Make(0.12f + (200.0f - x) * recipX,
+                                                            -0.08f + (200.0f - y) * recipY,
+                                                            1.0f)));
+                builder.add(SkLights::Light(SkColor3f::Make(0.4f, 0.3f, 0.2f),
+                                            SkVector3::Make(-0.12f + (200.0f - x) * recipX,
+                                                            0.12f + (200.0f - y) * recipY,
+                                                            1.0f)));
+                builder.add(SkLights::Light(SkColor3f::Make(0.4f, 0.4f, 0.4f)));
+                fLights = builder.finish();
+
+                fLightsChanged = true;
+            }
+
+            return true;
+        }
+
+        if (click->fState == Click::State::kUp_State) {
+            fSelectedRect = -1;
+            return true;
+        }
+
+        if (fSelectedRect > -1) {

[robertphillips, 2016/08/04 15:17:35]

Didn't we already store off/compute these above ?

[vjiaoblack, 2016/08/04 18:03:58]

Done.

+            SkScalar x = click->fCurr.fX;
+            SkScalar y = click->fCurr.fY;
+
+            SkScalar dx = x - click->fPrev.fX;
+            SkScalar dy = y - click->fPrev.fY;
+

[robertphillips, 2016/08/04 15:17:35]

fTestRects[fSelectedRect].offset(dx, dy); ?

[vjiaoblack, 2016/08/04 18:03:58]

Done.

+            fTestRects[fSelectedRect].fGeometry.fLeft += dx;
+            fTestRects[fSelectedRect].fGeometry.fRight += dx;
+            fTestRects[fSelectedRect].fGeometry.fTop += dy;
+            fTestRects[fSelectedRect].fGeometry.fBottom += dy;
+
+            fSceneChanged = true;
+
+            return true;
+        }
+
+        // assume last elements are highest
+        for (int i = kNumTestRects - 1; i >= 0; i--) {
+            if (fTestRects[i].fGeometry.contains(SkRect::MakeXYWH(x, y, 1, 1))) {
+                fSelectedRect = i;

[robertphillips, 2016/08/04 15:17:35]

fTestRects[i].offset(dx, dy); ?

[vjiaoblack, 2016/08/04 18:03:58]

Done.

+                fTestRects[i].fGeometry.fLeft += dx;
+                fTestRects[i].fGeometry.fRight += dx;
+                fTestRects[i].fGeometry.fTop += dy;
+                fTestRects[i].fGeometry.fBottom += dy;
+
+                fSceneChanged = true;
+
+                break;
+            }
+        }
+
+        return true;
+    }
+
+private:
+    static constexpr int kNumTestRects = 3;
+
+    static const int kWidth = 400;
+    static const int kHeight = 400;
+
+    struct {
+        SkRect  fGeometry;
+        int     fDepth;
+        SkColor fColor;
+    } fTestRects[kNumTestRects];
+
+    int fSelectedRect;
+    bool fMoveLight;
+
+    sk_sp<SkImage>   fPovDepthMap;
+    sk_sp<SkImage>   fDiffuseMap;
+    sk_sp<SkPicture> fPicture;
+
+    bool fSceneChanged;
+    bool fLightsChanged;
+
+    sk_sp<SkLights> fLights;
+
+    typedef SampleView INHERITED;
+};
+
+//////////////////////////////////////////////////////////////////////////////
+static SkView* MyFactory() { return new ShadowingView; }
+static SkViewRegister reg(MyFactory);
+
+#endif