epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2011 Google Inc. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
commit-bot@chromium.org | c3bd8af | 2014-02-13 17:14:46 +0000 | [diff] [blame] | 7 | |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 8 | #ifndef skiagm_DEFINED |
| 9 | #define skiagm_DEFINED |
| 10 | |
Hal Canary | 22be4c4 | 2018-06-12 12:37:31 -0400 | [diff] [blame] | 11 | #include "../tools/Registry.h" |
epoger@google.com | d4af56c | 2011-07-25 16:27:59 +0000 | [diff] [blame] | 12 | #include "SkBitmap.h" |
reed@android.com | dd0ac28 | 2009-06-20 02:38:16 +0000 | [diff] [blame] | 13 | #include "SkCanvas.h" |
Hal Canary | 22be4c4 | 2018-06-12 12:37:31 -0400 | [diff] [blame] | 14 | #include "SkClipOpPriv.h" |
| 15 | #include "SkMacros.h" |
Mike Reed | 81f60ec | 2018-05-15 10:09:52 -0400 | [diff] [blame] | 16 | #include "SkMetaData.h" |
reed@android.com | dd0ac28 | 2009-06-20 02:38:16 +0000 | [diff] [blame] | 17 | #include "SkPaint.h" |
reed@android.com | dd0ac28 | 2009-06-20 02:38:16 +0000 | [diff] [blame] | 18 | #include "SkSize.h" |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 19 | #include "SkString.h" |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 20 | |
reed | 76113a9 | 2015-02-02 12:55:02 -0800 | [diff] [blame] | 21 | class SkAnimTimer; |
bsalomon | 4ee6bd8 | 2015-05-27 13:23:23 -0700 | [diff] [blame] | 22 | struct GrContextOptions; |
mtklein@google.com | 62b50b7 | 2013-09-16 20:42:15 +0000 | [diff] [blame] | 23 | |
reed@google.com | 4117a24 | 2012-10-30 20:26:58 +0000 | [diff] [blame] | 24 | #define DEF_GM(code) \ |
sugoi@google.com | 0f0d9b7 | 2013-02-27 15:41:12 +0000 | [diff] [blame] | 25 | static skiagm::GM* SK_MACRO_APPEND_LINE(F_)(void*) { code; } \ |
reed@google.com | 4117a24 | 2012-10-30 20:26:58 +0000 | [diff] [blame] | 26 | static skiagm::GMRegistry SK_MACRO_APPEND_LINE(R_)(SK_MACRO_APPEND_LINE(F_)); |
| 27 | |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 28 | // A Simple GM is a rendering test that does not store state between rendering calls or make use of |
| 29 | // the onOnceBeforeDraw() virtual; it consists of: |
halcanary | 2a24338 | 2015-09-09 08:16:41 -0700 | [diff] [blame] | 30 | // * A name. |
| 31 | // * Prefered width and height. |
| 32 | // * Optionally, a background color (default is white). |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 33 | // * A standalone function pointer that implements its onDraw method. |
halcanary | 2a24338 | 2015-09-09 08:16:41 -0700 | [diff] [blame] | 34 | #define DEF_SIMPLE_GM(NAME, CANVAS, W, H) \ |
| 35 | DEF_SIMPLE_GM_BG_NAME(NAME, CANVAS, W, H, SK_ColorWHITE, SkString(#NAME)) |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 36 | #define DEF_SIMPLE_GM_BG(NAME, CANVAS, W, H, BGCOLOR) \ |
halcanary | 2a24338 | 2015-09-09 08:16:41 -0700 | [diff] [blame] | 37 | DEF_SIMPLE_GM_BG_NAME(NAME, CANVAS, W, H, BGCOLOR, SkString(#NAME)) |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 38 | #define DEF_SIMPLE_GM_BG_NAME(NAME, CANVAS, W, H, BGCOLOR, NAME_STR) \ |
| 39 | static void SK_MACRO_CONCAT(NAME, _GM)(SkCanvas * CANVAS); \ |
| 40 | DEF_GM(return new skiagm::SimpleGM(BGCOLOR, NAME_STR, SkISize::Make(W, H), \ |
| 41 | SK_MACRO_CONCAT(NAME, _GM));) \ |
halcanary | 385fe4d | 2015-08-26 13:07:48 -0700 | [diff] [blame] | 42 | void SK_MACRO_CONCAT(NAME, _GM)(SkCanvas * CANVAS) |
halcanary | 30b83d4 | 2014-10-26 05:23:53 -0700 | [diff] [blame] | 43 | |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 44 | // A Simple GpuGM makes direct GPU calls. Its onDraw hook that includes GPU objects as params, and |
| 45 | // is only invoked on GPU configs. Non-GPU configs automatically draw a GPU-only message and abort. |
| 46 | #define DEF_SIMPLE_GPU_GM(NAME, GR_CONTEXT, RENDER_TARGET_CONTEXT, CANVAS, W, H) \ |
| 47 | DEF_SIMPLE_GPU_GM_BG(NAME, GR_CONTEXT, RENDER_TARGET_CONTEXT, CANVAS, W, H, SK_ColorWHITE) |
| 48 | #define DEF_SIMPLE_GPU_GM_BG(NAME, GR_CONTEXT, RENDER_TARGET_CONTEXT, CANVAS, W, H, BGCOLOR)\ |
| 49 | static void SK_MACRO_CONCAT(NAME, _GM)(GrContext*, GrRenderTargetContext*, SkCanvas*); \ |
| 50 | DEF_GM(return new skiagm::SimpleGpuGM(BGCOLOR, SkString(#NAME), SkISize::Make(W, H), \ |
| 51 | SK_MACRO_CONCAT(NAME, _GM));) \ |
| 52 | void SK_MACRO_CONCAT(NAME, _GM)( \ |
| 53 | GrContext* GR_CONTEXT, GrRenderTargetContext* RENDER_TARGET_CONTEXT, SkCanvas* CANVAS) |
| 54 | |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 55 | namespace skiagm { |
rmistry@google.com | d6176b0 | 2012-08-23 18:14:13 +0000 | [diff] [blame] | 56 | |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 57 | class GM { |
| 58 | public: |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 59 | GM(SkColor backgroundColor = SK_ColorWHITE); |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 60 | virtual ~GM(); |
rmistry@google.com | d6176b0 | 2012-08-23 18:14:13 +0000 | [diff] [blame] | 61 | |
commit-bot@chromium.org | b21fac1 | 2014-02-07 21:13:11 +0000 | [diff] [blame] | 62 | enum Mode { |
| 63 | kGM_Mode, |
| 64 | kSample_Mode, |
| 65 | kBench_Mode, |
| 66 | }; |
| 67 | |
| 68 | void setMode(Mode mode) { fMode = mode; } |
| 69 | Mode getMode() const { return fMode; } |
| 70 | |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 71 | void draw(SkCanvas*); |
| 72 | void drawBackground(SkCanvas*); |
| 73 | void drawContent(SkCanvas*); |
rmistry@google.com | d6176b0 | 2012-08-23 18:14:13 +0000 | [diff] [blame] | 74 | |
mtklein | f4ba321 | 2015-01-28 15:32:24 -0800 | [diff] [blame] | 75 | SkISize getISize() { return this->onISize(); } |
commit-bot@chromium.org | 38aeb0f | 2014-02-26 23:01:57 +0000 | [diff] [blame] | 76 | const char* getName(); |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 77 | |
mtklein | cf5d9c9 | 2015-01-23 10:31:45 -0800 | [diff] [blame] | 78 | virtual bool runAsBench() const { return false; } |
| 79 | |
reed@google.com | 487b560 | 2013-02-01 15:01:24 +0000 | [diff] [blame] | 80 | SkScalar width() { |
| 81 | return SkIntToScalar(this->getISize().width()); |
| 82 | } |
| 83 | SkScalar height() { |
scroggo@google.com | ab02627 | 2013-04-12 22:14:03 +0000 | [diff] [blame] | 84 | return SkIntToScalar(this->getISize().height()); |
reed@google.com | 487b560 | 2013-02-01 15:01:24 +0000 | [diff] [blame] | 85 | } |
| 86 | |
reed@google.com | b4b49cc | 2011-12-06 16:15:42 +0000 | [diff] [blame] | 87 | SkColor getBGColor() const { return fBGColor; } |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 88 | void setBGColor(SkColor); |
reed@google.com | 30db599 | 2011-08-29 17:41:02 +0000 | [diff] [blame] | 89 | |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 90 | // helper: fill a rect in the specified color based on the GM's getISize bounds. |
reed@google.com | 2d6ef52 | 2012-01-03 17:20:38 +0000 | [diff] [blame] | 91 | void drawSizeBounds(SkCanvas*, SkColor); |
| 92 | |
reed@google.com | aef7361 | 2012-11-16 13:41:45 +0000 | [diff] [blame] | 93 | bool isCanvasDeferred() const { return fCanvasIsDeferred; } |
| 94 | void setCanvasIsDeferred(bool isDeferred) { |
| 95 | fCanvasIsDeferred = isDeferred; |
| 96 | } |
| 97 | |
reed | 76113a9 | 2015-02-02 12:55:02 -0800 | [diff] [blame] | 98 | bool animate(const SkAnimTimer&); |
robertphillips | 05a4cf5 | 2016-09-08 09:02:43 -0700 | [diff] [blame] | 99 | bool handleKey(SkUnichar uni) { |
| 100 | return this->onHandleKey(uni); |
| 101 | } |
reed | d9adfe6 | 2015-02-01 19:01:04 -0800 | [diff] [blame] | 102 | |
Mike Reed | 81f60ec | 2018-05-15 10:09:52 -0400 | [diff] [blame] | 103 | bool getControls(SkMetaData* controls) { return this->onGetControls(controls); } |
| 104 | void setControls(const SkMetaData& controls) { this->onSetControls(controls); } |
| 105 | |
bsalomon | 4ee6bd8 | 2015-05-27 13:23:23 -0700 | [diff] [blame] | 106 | virtual void modifyGrContextOptions(GrContextOptions* options) {} |
| 107 | |
bsalomon | b62da80 | 2015-01-31 07:51:14 -0800 | [diff] [blame] | 108 | /** draws a standard message that the GM is only intended to be used with the GPU.*/ |
halcanary | 2a24338 | 2015-09-09 08:16:41 -0700 | [diff] [blame] | 109 | static void DrawGpuOnlyMessage(SkCanvas*); |
| 110 | |
Chris Dalton | d7a5a1d | 2019-02-04 01:20:52 -0700 | [diff] [blame] | 111 | static void DrawFailureMessage(SkCanvas*, const char[], ...) SK_PRINTF_LIKE(2, 3); |
| 112 | |
halcanary | 2a24338 | 2015-09-09 08:16:41 -0700 | [diff] [blame] | 113 | protected: |
reed@google.com | 7775d66 | 2012-11-27 15:15:58 +0000 | [diff] [blame] | 114 | virtual void onOnceBeforeDraw() {} |
robertphillips@google.com | 8570b5c | 2012-03-20 17:40:58 +0000 | [diff] [blame] | 115 | virtual void onDraw(SkCanvas*) = 0; |
robertphillips@google.com | 8570b5c | 2012-03-20 17:40:58 +0000 | [diff] [blame] | 116 | virtual SkISize onISize() = 0; |
reed@android.com | 8015dd8 | 2009-06-21 00:49:18 +0000 | [diff] [blame] | 117 | virtual SkString onShortName() = 0; |
mtklein | 1c40292 | 2015-01-23 11:07:07 -0800 | [diff] [blame] | 118 | |
reed | 76113a9 | 2015-02-02 12:55:02 -0800 | [diff] [blame] | 119 | virtual bool onAnimate(const SkAnimTimer&) { return false; } |
robertphillips | 05a4cf5 | 2016-09-08 09:02:43 -0700 | [diff] [blame] | 120 | virtual bool onHandleKey(SkUnichar uni) { return false; } |
Mike Reed | 81f60ec | 2018-05-15 10:09:52 -0400 | [diff] [blame] | 121 | virtual bool onGetControls(SkMetaData*) { return false; } |
| 122 | virtual void onSetControls(const SkMetaData&) {} |
vandebo@chromium.org | 79d3cb4 | 2012-03-21 17:34:30 +0000 | [diff] [blame] | 123 | |
reed@android.com | 8015dd8 | 2009-06-21 00:49:18 +0000 | [diff] [blame] | 124 | private: |
commit-bot@chromium.org | b21fac1 | 2014-02-07 21:13:11 +0000 | [diff] [blame] | 125 | Mode fMode; |
reed@android.com | 8015dd8 | 2009-06-21 00:49:18 +0000 | [diff] [blame] | 126 | SkString fShortName; |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 127 | SkColor fBGColor; |
reed@google.com | aef7361 | 2012-11-16 13:41:45 +0000 | [diff] [blame] | 128 | bool fCanvasIsDeferred; // work-around problem in srcmode.cpp |
reed@google.com | 7775d66 | 2012-11-27 15:15:58 +0000 | [diff] [blame] | 129 | bool fHaveCalledOnceBeforeDraw; |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 130 | }; |
| 131 | |
Hal Canary | 972eba3 | 2018-07-30 17:07:07 -0400 | [diff] [blame] | 132 | typedef GM*(*GMFactory)(void*) ; |
| 133 | typedef sk_tools::Registry<GMFactory> GMRegistry; |
halcanary | f62c634 | 2015-01-12 15:27:46 -0800 | [diff] [blame] | 134 | |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 135 | // A GpuGM replaces the onDraw method with one that also accepts GPU objects alongside the |
| 136 | // SkCanvas. Its onDraw is only invoked on GPU configs; on non-GPU configs it will automatically |
| 137 | // draw a GPU-only message and abort. |
| 138 | class GpuGM : public GM { |
halcanary | f62c634 | 2015-01-12 15:27:46 -0800 | [diff] [blame] | 139 | public: |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 140 | GpuGM(SkColor backgroundColor = SK_ColorWHITE) : GM(backgroundColor) {} |
halcanary | f62c634 | 2015-01-12 15:27:46 -0800 | [diff] [blame] | 141 | private: |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 142 | void onDraw(SkCanvas*) final; |
| 143 | virtual void onDraw(GrContext*, GrRenderTargetContext*, SkCanvas*) = 0; |
halcanary | f62c634 | 2015-01-12 15:27:46 -0800 | [diff] [blame] | 144 | }; |
Chris Dalton | f5efa78 | 2019-02-05 17:42:14 -0700 | [diff] [blame^] | 145 | |
| 146 | // SimpleGM is intended for basic GMs that can define their entire implementation inside a |
| 147 | // single "draw" function pointer. |
| 148 | class SimpleGM : public GM { |
| 149 | public: |
| 150 | using DrawProc = void(*)(SkCanvas*); |
| 151 | SimpleGM(SkColor bgColor, const SkString& name, const SkISize& size, DrawProc drawProc) |
| 152 | : GM(bgColor), fName(name), fSize(size), fDrawProc(drawProc) {} |
| 153 | |
| 154 | private: |
| 155 | SkISize onISize() override { return fSize; } |
| 156 | SkString onShortName() override { return fName; } |
| 157 | void onDraw(SkCanvas* canvas) override { fDrawProc(canvas); } |
| 158 | |
| 159 | const SkString fName; |
| 160 | const SkISize fSize; |
| 161 | const DrawProc fDrawProc; |
| 162 | }; |
| 163 | |
| 164 | class SimpleGpuGM : public GpuGM { |
| 165 | public: |
| 166 | using DrawProc = void(*)(GrContext*, GrRenderTargetContext*, SkCanvas*); |
| 167 | SimpleGpuGM(SkColor bgColor, const SkString& name, const SkISize& size, DrawProc drawProc) |
| 168 | : GpuGM(bgColor), fName(name), fSize(size), fDrawProc(drawProc) {} |
| 169 | |
| 170 | private: |
| 171 | SkISize onISize() override { return fSize; } |
| 172 | SkString onShortName() override { return fName; } |
| 173 | void onDraw(GrContext* ctx, GrRenderTargetContext* rtc, SkCanvas* canvas) override { |
| 174 | fDrawProc(ctx, rtc, canvas); |
| 175 | } |
| 176 | |
| 177 | const SkString fName; |
| 178 | const SkISize fSize; |
| 179 | const DrawProc fDrawProc; |
| 180 | }; |
| 181 | |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 182 | } |
| 183 | |
Mike Klein | c9eace8 | 2018-10-31 10:49:38 -0400 | [diff] [blame] | 184 | void MarkGMGood(SkCanvas*, SkScalar x, SkScalar y); |
| 185 | void MarkGMBad (SkCanvas*, SkScalar x, SkScalar y); |
| 186 | |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 187 | #endif |