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 | |
epoger@google.com | d4af56c | 2011-07-25 16:27:59 +0000 | [diff] [blame] | 11 | #include "SkBitmap.h" |
reed@android.com | dd0ac28 | 2009-06-20 02:38:16 +0000 | [diff] [blame] | 12 | #include "SkCanvas.h" |
| 13 | #include "SkPaint.h" |
reed@android.com | dd0ac28 | 2009-06-20 02:38:16 +0000 | [diff] [blame] | 14 | #include "SkSize.h" |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 15 | #include "SkString.h" |
Mike Reed | ab273fa | 2017-01-11 13:58:55 -0500 | [diff] [blame] | 16 | #include "../tools/Registry.h" |
caryclark | 5fb6bd4 | 2014-06-23 11:25:00 -0700 | [diff] [blame] | 17 | #include "sk_tool_utils.h" |
Mike Reed | ebfce6d | 2016-12-12 10:02:12 -0500 | [diff] [blame] | 18 | #include "SkClipOpPriv.h" |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 19 | |
reed | 76113a9 | 2015-02-02 12:55:02 -0800 | [diff] [blame] | 20 | class SkAnimTimer; |
bsalomon | 4ee6bd8 | 2015-05-27 13:23:23 -0700 | [diff] [blame] | 21 | struct GrContextOptions; |
mtklein@google.com | 62b50b7 | 2013-09-16 20:42:15 +0000 | [diff] [blame] | 22 | |
reed@google.com | 4117a24 | 2012-10-30 20:26:58 +0000 | [diff] [blame] | 23 | #define DEF_GM(code) \ |
sugoi@google.com | 0f0d9b7 | 2013-02-27 15:41:12 +0000 | [diff] [blame] | 24 | static skiagm::GM* SK_MACRO_APPEND_LINE(F_)(void*) { code; } \ |
reed@google.com | 4117a24 | 2012-10-30 20:26:58 +0000 | [diff] [blame] | 25 | static skiagm::GMRegistry SK_MACRO_APPEND_LINE(R_)(SK_MACRO_APPEND_LINE(F_)); |
| 26 | |
halcanary | 2a24338 | 2015-09-09 08:16:41 -0700 | [diff] [blame] | 27 | // a Simple GM is a rendering test that does not store state between |
| 28 | // rendering calls or make use of the onOnceBeforeDraw() virtual; it |
| 29 | // consists of: |
| 30 | // * A single void(*)(SkCanvas*) function. |
| 31 | // * A name. |
| 32 | // * Prefered width and height. |
| 33 | // * Optionally, a background color (default is white). |
| 34 | #define DEF_SIMPLE_GM(NAME, CANVAS, W, H) \ |
| 35 | DEF_SIMPLE_GM_BG_NAME(NAME, CANVAS, W, H, SK_ColorWHITE, SkString(#NAME)) |
| 36 | #define DEF_SIMPLE_GM_BG(NAME, CANVAS, W, H, BGCOLOR)\ |
| 37 | DEF_SIMPLE_GM_BG_NAME(NAME, CANVAS, W, H, BGCOLOR, SkString(#NAME)) |
mtklein | 2843c42 | 2016-06-09 12:20:25 -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(NAME_STR, SK_MACRO_CONCAT(NAME, _GM), \ |
| 41 | SkISize::Make(W, H), BGCOLOR);) \ |
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 | |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 44 | namespace skiagm { |
rmistry@google.com | d6176b0 | 2012-08-23 18:14:13 +0000 | [diff] [blame] | 45 | |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 46 | class GM { |
| 47 | public: |
| 48 | GM(); |
| 49 | virtual ~GM(); |
rmistry@google.com | d6176b0 | 2012-08-23 18:14:13 +0000 | [diff] [blame] | 50 | |
commit-bot@chromium.org | b21fac1 | 2014-02-07 21:13:11 +0000 | [diff] [blame] | 51 | enum Mode { |
| 52 | kGM_Mode, |
| 53 | kSample_Mode, |
| 54 | kBench_Mode, |
| 55 | }; |
| 56 | |
| 57 | void setMode(Mode mode) { fMode = mode; } |
| 58 | Mode getMode() const { return fMode; } |
| 59 | |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 60 | void draw(SkCanvas*); |
| 61 | void drawBackground(SkCanvas*); |
| 62 | void drawContent(SkCanvas*); |
rmistry@google.com | d6176b0 | 2012-08-23 18:14:13 +0000 | [diff] [blame] | 63 | |
mtklein | f4ba321 | 2015-01-28 15:32:24 -0800 | [diff] [blame] | 64 | SkISize getISize() { return this->onISize(); } |
commit-bot@chromium.org | 38aeb0f | 2014-02-26 23:01:57 +0000 | [diff] [blame] | 65 | const char* getName(); |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 66 | |
mtklein | cf5d9c9 | 2015-01-23 10:31:45 -0800 | [diff] [blame] | 67 | virtual bool runAsBench() const { return false; } |
| 68 | |
reed@google.com | 487b560 | 2013-02-01 15:01:24 +0000 | [diff] [blame] | 69 | SkScalar width() { |
| 70 | return SkIntToScalar(this->getISize().width()); |
| 71 | } |
| 72 | SkScalar height() { |
scroggo@google.com | ab02627 | 2013-04-12 22:14:03 +0000 | [diff] [blame] | 73 | return SkIntToScalar(this->getISize().height()); |
reed@google.com | 487b560 | 2013-02-01 15:01:24 +0000 | [diff] [blame] | 74 | } |
| 75 | |
vandebo@chromium.org | 79d3cb4 | 2012-03-21 17:34:30 +0000 | [diff] [blame] | 76 | // TODO(vandebo) Instead of exposing this, we should run all the GMs |
| 77 | // with and without an initial transform. |
| 78 | // Most GMs will return the identity matrix, but some PDFs tests |
| 79 | // require setting the initial transform. |
| 80 | SkMatrix getInitialTransform() const { |
commit-bot@chromium.org | f4f9df4 | 2013-09-26 20:44:24 +0000 | [diff] [blame] | 81 | SkMatrix matrix = fStarterMatrix; |
| 82 | matrix.preConcat(this->onGetInitialTransform()); |
| 83 | return matrix; |
vandebo@chromium.org | 79d3cb4 | 2012-03-21 17:34:30 +0000 | [diff] [blame] | 84 | } |
| 85 | |
reed@google.com | b4b49cc | 2011-12-06 16:15:42 +0000 | [diff] [blame] | 86 | SkColor getBGColor() const { return fBGColor; } |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 87 | void setBGColor(SkColor); |
reed@google.com | 30db599 | 2011-08-29 17:41:02 +0000 | [diff] [blame] | 88 | |
reed@google.com | 2d6ef52 | 2012-01-03 17:20:38 +0000 | [diff] [blame] | 89 | // helper: fill a rect in the specified color based on the |
| 90 | // GM's getISize bounds. |
| 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 | |
commit-bot@chromium.org | b21fac1 | 2014-02-07 21:13:11 +0000 | [diff] [blame] | 98 | const SkMatrix& getStarterMatrix() { return fStarterMatrix; } |
| 99 | void setStarterMatrix(const SkMatrix& matrix) { |
| 100 | fStarterMatrix = matrix; |
| 101 | } |
commit-bot@chromium.org | f4f9df4 | 2013-09-26 20:44:24 +0000 | [diff] [blame] | 102 | |
reed | 76113a9 | 2015-02-02 12:55:02 -0800 | [diff] [blame] | 103 | bool animate(const SkAnimTimer&); |
robertphillips | 05a4cf5 | 2016-09-08 09:02:43 -0700 | [diff] [blame] | 104 | bool handleKey(SkUnichar uni) { |
| 105 | return this->onHandleKey(uni); |
| 106 | } |
reed | d9adfe6 | 2015-02-01 19:01:04 -0800 | [diff] [blame] | 107 | |
bsalomon | 4ee6bd8 | 2015-05-27 13:23:23 -0700 | [diff] [blame] | 108 | virtual void modifyGrContextOptions(GrContextOptions* options) {} |
| 109 | |
bsalomon | b62da80 | 2015-01-31 07:51:14 -0800 | [diff] [blame] | 110 | /** 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] | 111 | static void DrawGpuOnlyMessage(SkCanvas*); |
| 112 | |
| 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; |
| 116 | virtual void onDrawBackground(SkCanvas*); |
| 117 | virtual SkISize onISize() = 0; |
reed@android.com | 8015dd8 | 2009-06-21 00:49:18 +0000 | [diff] [blame] | 118 | virtual SkString onShortName() = 0; |
mtklein | 1c40292 | 2015-01-23 11:07:07 -0800 | [diff] [blame] | 119 | |
reed | 76113a9 | 2015-02-02 12:55:02 -0800 | [diff] [blame] | 120 | virtual bool onAnimate(const SkAnimTimer&) { return false; } |
robertphillips | 05a4cf5 | 2016-09-08 09:02:43 -0700 | [diff] [blame] | 121 | virtual bool onHandleKey(SkUnichar uni) { return false; } |
vandebo@chromium.org | 79d3cb4 | 2012-03-21 17:34:30 +0000 | [diff] [blame] | 122 | virtual SkMatrix onGetInitialTransform() const { return SkMatrix::I(); } |
| 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; |
commit-bot@chromium.org | f4f9df4 | 2013-09-26 20:44:24 +0000 | [diff] [blame] | 130 | SkMatrix fStarterMatrix; |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 131 | }; |
| 132 | |
Mike Reed | ab273fa | 2017-01-11 13:58:55 -0500 | [diff] [blame] | 133 | typedef sk_tools::Registry<GM*(*)(void*)> GMRegistry; |
halcanary | f62c634 | 2015-01-12 15:27:46 -0800 | [diff] [blame] | 134 | |
| 135 | class SimpleGM : public skiagm::GM { |
| 136 | public: |
| 137 | SimpleGM(const SkString& name, |
| 138 | void (*drawProc)(SkCanvas*), |
halcanary | 2a24338 | 2015-09-09 08:16:41 -0700 | [diff] [blame] | 139 | const SkISize& size, |
| 140 | SkColor backgroundColor) |
| 141 | : fName(name), fDrawProc(drawProc), fSize(size) { |
| 142 | if (backgroundColor != SK_ColorWHITE) { |
| 143 | this->setBGColor(backgroundColor); |
| 144 | } |
| 145 | } |
halcanary | f62c634 | 2015-01-12 15:27:46 -0800 | [diff] [blame] | 146 | protected: |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 147 | void onDraw(SkCanvas* canvas) override; |
| 148 | SkISize onISize() override; |
| 149 | SkString onShortName() override; |
halcanary | f62c634 | 2015-01-12 15:27:46 -0800 | [diff] [blame] | 150 | private: |
| 151 | SkString fName; |
| 152 | void (*fDrawProc)(SkCanvas*); |
| 153 | SkISize fSize; |
| 154 | }; |
reed@android.com | 00dae86 | 2009-06-10 15:38:48 +0000 | [diff] [blame] | 155 | } |
| 156 | |
| 157 | #endif |