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