blob: e263528f90c7827e4e5ad6b188a95b7ad341091e [file] [log] [blame]
epoger@google.comec3ed6a2011-07-28 14:26:00 +00001/*
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.orgc3bd8af2014-02-13 17:14:46 +00007
reed@android.com00dae862009-06-10 15:38:48 +00008#ifndef skiagm_DEFINED
9#define skiagm_DEFINED
10
epoger@google.comd4af56c2011-07-25 16:27:59 +000011#include "SkBitmap.h"
reed@android.comdd0ac282009-06-20 02:38:16 +000012#include "SkCanvas.h"
13#include "SkPaint.h"
reed@android.comdd0ac282009-06-20 02:38:16 +000014#include "SkSize.h"
reed@android.com00dae862009-06-10 15:38:48 +000015#include "SkString.h"
16#include "SkTRegistry.h"
caryclark5fb6bd42014-06-23 11:25:00 -070017#include "sk_tool_utils.h"
reed@android.com00dae862009-06-10 15:38:48 +000018
reed76113a92015-02-02 12:55:02 -080019class SkAnimTimer;
20
mtklein@google.com62b50b72013-09-16 20:42:15 +000021#if SK_SUPPORT_GPU
22#include "GrContext.h"
23#endif
24
reed@google.com4117a242012-10-30 20:26:58 +000025#define DEF_GM(code) \
sugoi@google.com0f0d9b72013-02-27 15:41:12 +000026 static skiagm::GM* SK_MACRO_APPEND_LINE(F_)(void*) { code; } \
reed@google.com4117a242012-10-30 20:26:58 +000027 static skiagm::GMRegistry SK_MACRO_APPEND_LINE(R_)(SK_MACRO_APPEND_LINE(F_));
28
halcanary30b83d42014-10-26 05:23:53 -070029// See colorwheel.cpp for example usage.
halcanaryf62c6342015-01-12 15:27:46 -080030#define DEF_SIMPLE_GM(NAME, CANVAS, W, H) \
31 static void SK_MACRO_CONCAT(NAME, _GM)(SkCanvas* CANVAS); \
32 DEF_GM( return SkNEW_ARGS(skiagm::SimpleGM, \
33 (SkString(#NAME), \
34 SK_MACRO_CONCAT(NAME, _GM), \
35 SkISize::Make(W, H))); ) \
36 void SK_MACRO_CONCAT(NAME, _GM)(SkCanvas* CANVAS)
halcanary30b83d42014-10-26 05:23:53 -070037
reed@android.com00dae862009-06-10 15:38:48 +000038namespace skiagm {
rmistry@google.comd6176b02012-08-23 18:14:13 +000039
reed@android.com00dae862009-06-10 15:38:48 +000040 class GM {
41 public:
42 GM();
43 virtual ~GM();
rmistry@google.comd6176b02012-08-23 18:14:13 +000044
commit-bot@chromium.orgb21fac12014-02-07 21:13:11 +000045 enum Mode {
46 kGM_Mode,
47 kSample_Mode,
48 kBench_Mode,
49 };
50
51 void setMode(Mode mode) { fMode = mode; }
52 Mode getMode() const { return fMode; }
53
bsalomon@google.com48dd1a22011-10-31 14:18:20 +000054 void draw(SkCanvas*);
55 void drawBackground(SkCanvas*);
56 void drawContent(SkCanvas*);
rmistry@google.comd6176b02012-08-23 18:14:13 +000057
mtkleinf4ba3212015-01-28 15:32:24 -080058 SkISize getISize() { return this->onISize(); }
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +000059 const char* getName();
reed@android.com00dae862009-06-10 15:38:48 +000060
mtkleincf5d9c92015-01-23 10:31:45 -080061 virtual bool runAsBench() const { return false; }
62
reed@google.com487b5602013-02-01 15:01:24 +000063 SkScalar width() {
64 return SkIntToScalar(this->getISize().width());
65 }
66 SkScalar height() {
scroggo@google.comab026272013-04-12 22:14:03 +000067 return SkIntToScalar(this->getISize().height());
reed@google.com487b5602013-02-01 15:01:24 +000068 }
69
vandebo@chromium.org79d3cb42012-03-21 17:34:30 +000070 // TODO(vandebo) Instead of exposing this, we should run all the GMs
71 // with and without an initial transform.
72 // Most GMs will return the identity matrix, but some PDFs tests
73 // require setting the initial transform.
74 SkMatrix getInitialTransform() const {
commit-bot@chromium.orgf4f9df42013-09-26 20:44:24 +000075 SkMatrix matrix = fStarterMatrix;
76 matrix.preConcat(this->onGetInitialTransform());
77 return matrix;
vandebo@chromium.org79d3cb42012-03-21 17:34:30 +000078 }
79
reed@google.comb4b49cc2011-12-06 16:15:42 +000080 SkColor getBGColor() const { return fBGColor; }
bsalomon@google.com48dd1a22011-10-31 14:18:20 +000081 void setBGColor(SkColor);
reed@google.com30db5992011-08-29 17:41:02 +000082
reed@google.com2d6ef522012-01-03 17:20:38 +000083 // helper: fill a rect in the specified color based on the
84 // GM's getISize bounds.
85 void drawSizeBounds(SkCanvas*, SkColor);
86
reed@google.comaef73612012-11-16 13:41:45 +000087 bool isCanvasDeferred() const { return fCanvasIsDeferred; }
88 void setCanvasIsDeferred(bool isDeferred) {
89 fCanvasIsDeferred = isDeferred;
90 }
91
commit-bot@chromium.orgb21fac12014-02-07 21:13:11 +000092 const SkMatrix& getStarterMatrix() { return fStarterMatrix; }
93 void setStarterMatrix(const SkMatrix& matrix) {
94 fStarterMatrix = matrix;
95 }
commit-bot@chromium.orgf4f9df42013-09-26 20:44:24 +000096
reed76113a92015-02-02 12:55:02 -080097 bool animate(const SkAnimTimer&);
reedd9adfe62015-02-01 19:01:04 -080098
robertphillips@google.com8570b5c2012-03-20 17:40:58 +000099 protected:
bsalomonb62da802015-01-31 07:51:14 -0800100 /** draws a standard message that the GM is only intended to be used with the GPU.*/
Brian Salomon0b737c52015-01-31 14:29:16 -0500101 void drawGpuOnlyMessage(SkCanvas*);
reed@google.com7775d662012-11-27 15:15:58 +0000102 virtual void onOnceBeforeDraw() {}
robertphillips@google.com8570b5c2012-03-20 17:40:58 +0000103 virtual void onDraw(SkCanvas*) = 0;
104 virtual void onDrawBackground(SkCanvas*);
105 virtual SkISize onISize() = 0;
reed@android.com8015dd82009-06-21 00:49:18 +0000106 virtual SkString onShortName() = 0;
mtklein1c402922015-01-23 11:07:07 -0800107
reed76113a92015-02-02 12:55:02 -0800108 virtual bool onAnimate(const SkAnimTimer&) { return false; }
vandebo@chromium.org79d3cb42012-03-21 17:34:30 +0000109 virtual SkMatrix onGetInitialTransform() const { return SkMatrix::I(); }
110
reed@android.com8015dd82009-06-21 00:49:18 +0000111 private:
commit-bot@chromium.orgb21fac12014-02-07 21:13:11 +0000112 Mode fMode;
reed@android.com8015dd82009-06-21 00:49:18 +0000113 SkString fShortName;
bsalomon@google.com48dd1a22011-10-31 14:18:20 +0000114 SkColor fBGColor;
reed@google.comaef73612012-11-16 13:41:45 +0000115 bool fCanvasIsDeferred; // work-around problem in srcmode.cpp
reed@google.com7775d662012-11-27 15:15:58 +0000116 bool fHaveCalledOnceBeforeDraw;
commit-bot@chromium.orgf4f9df42013-09-26 20:44:24 +0000117 SkMatrix fStarterMatrix;
reed@android.com00dae862009-06-10 15:38:48 +0000118 };
119
mtklein@google.combd6343b2013-09-04 17:20:18 +0000120 typedef SkTRegistry<GM*(*)(void*)> GMRegistry;
halcanaryf62c6342015-01-12 15:27:46 -0800121
122 class SimpleGM : public skiagm::GM {
123 public:
124 SimpleGM(const SkString& name,
125 void (*drawProc)(SkCanvas*),
126 const SkISize& size)
127 : fName(name), fDrawProc(drawProc), fSize(size) {}
128 protected:
129 void onDraw(SkCanvas* canvas) SK_OVERRIDE;
130 SkISize onISize() SK_OVERRIDE;
131 SkString onShortName() SK_OVERRIDE;
132 private:
133 SkString fName;
134 void (*fDrawProc)(SkCanvas*);
135 SkISize fSize;
136 };
reed@android.com00dae862009-06-10 15:38:48 +0000137}
138
139#endif