blob: bf28689236593b81cf450f29ff88fc197adc7c59 [file] [log] [blame]
epoger@google.comec3ed6a2011-07-28 14:26:00 +00001
2/*
3 * Copyright 2011 Google Inc.
4 *
5 * Use of this source code is governed by a BSD-style license that can be
6 * found in the LICENSE file.
7 */
reed@android.combd700c32009-01-05 03:34:50 +00008#ifndef SkBenchmark_DEFINED
9#define SkBenchmark_DEFINED
10
11#include "SkRefCnt.h"
12#include "SkPoint.h"
scroggo@google.com111fd112013-09-25 21:42:12 +000013#include "SkString.h"
reed@android.comf523e252009-01-26 23:15:37 +000014#include "SkTRegistry.h"
reed@android.combd700c32009-01-05 03:34:50 +000015
commit-bot@chromium.org6adce672014-02-03 14:48:17 +000016#define DEF_BENCH(code) \
17namespace { \
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +000018static SkBenchmark* SK_MACRO_APPEND_LINE(factory)(void*) { code; } \
19BenchRegistry SK_MACRO_APPEND_LINE(g_R_)(SK_MACRO_APPEND_LINE(factory)); \
commit-bot@chromium.org6adce672014-02-03 14:48:17 +000020}
reed@google.comb8b92ea2012-10-16 15:57:13 +000021
22/*
23 * With the above macros, you can register benches as follows (at the bottom
24 * of your .cpp)
25 *
mtklein@google.com410e6e82013-09-13 19:52:27 +000026 * DEF_BENCH(return new MyBenchmark(...))
27 * DEF_BENCH(return new MyBenchmark(...))
28 * DEF_BENCH(return new MyBenchmark(...))
reed@google.comb8b92ea2012-10-16 15:57:13 +000029 */
30
31
reed@android.combd700c32009-01-05 03:34:50 +000032class SkCanvas;
reed@android.com4bc19832009-01-19 20:08:35 +000033class SkPaint;
reed@android.combd700c32009-01-05 03:34:50 +000034
reed@android.com4e635f92009-10-19 17:39:46 +000035class SkTriState {
36public:
37 enum State {
38 kDefault,
39 kTrue,
40 kFalse
41 };
mtklein@google.comc2897432013-09-10 19:23:38 +000042 static const char* Name[];
reed@android.com4e635f92009-10-19 17:39:46 +000043};
44
reed@android.combd700c32009-01-05 03:34:50 +000045class SkBenchmark : public SkRefCnt {
46public:
robertphillips@google.com15e9d3e2012-06-21 20:25:03 +000047 SK_DECLARE_INST_COUNT(SkBenchmark)
48
mtklein@google.com410e6e82013-09-13 19:52:27 +000049 SkBenchmark();
reed@android.com4bc19832009-01-19 20:08:35 +000050
reed@android.combd700c32009-01-05 03:34:50 +000051 const char* getName();
52 SkIPoint getSize();
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +000053
commit-bot@chromium.org644629c2013-11-21 06:21:58 +000054 enum Backend {
55 kNonRendering_Backend,
56 kRaster_Backend,
57 kGPU_Backend,
58 kPDF_Backend,
59 };
60
61 // Call to determine whether the benchmark is intended for
62 // the rendering mode.
63 virtual bool isSuitableFor(Backend backend) {
64 return backend != kNonRendering_Backend;
65 }
66
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +000067 // Call before draw, allows the benchmark to do setup work outside of the
68 // timer. When a benchmark is repeatedly drawn, this should be called once
69 // before the initial draw.
70 void preDraw();
71
commit-bot@chromium.org33614712013-12-03 18:17:16 +000072 // Bench framework can tune loops to be large enough for stable timing.
73 void draw(const int loops, SkCanvas*);
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +000074
75 // Call after draw, allows the benchmark to do cleanup work outside of the
76 // timer. When a benchmark is repeatedly drawn, this is only called once
77 // after the last draw.
78 void postDraw();
79
reed@android.com4bc19832009-01-19 20:08:35 +000080 void setForceAlpha(int alpha) {
81 fForceAlpha = alpha;
82 }
rmistry@google.comfbfcd562012-08-23 18:09:54 +000083
reed@android.com4bc19832009-01-19 20:08:35 +000084 void setForceAA(bool aa) {
85 fForceAA = aa;
86 }
rmistry@google.comfbfcd562012-08-23 18:09:54 +000087
reed@android.com29348cb2009-08-04 18:17:15 +000088 void setForceFilter(bool filter) {
89 fForceFilter = filter;
90 }
rmistry@google.comfbfcd562012-08-23 18:09:54 +000091
reed@android.com4e635f92009-10-19 17:39:46 +000092 void setDither(SkTriState::State state) {
93 fDither = state;
94 }
reed@android.come9d00602009-09-02 21:12:42 +000095
reed@google.comef77ec22013-05-29 15:39:54 +000096 /** Assign masks for paint-flags. These will be applied when setupPaint()
97 * is called.
98 *
99 * Performs the following on the paint:
100 * uint32_t flags = paint.getFlags();
101 * flags &= ~clearMask;
102 * flags |= orMask;
103 * paint.setFlags(flags);
104 */
105 void setPaintMasks(uint32_t orMask, uint32_t clearMask) {
106 fOrMask = orMask;
107 fClearMask = clearMask;
108 }
109
scroggo@google.com111fd112013-09-25 21:42:12 +0000110 static void SetResourcePath(const char* resPath) { gResourcePath.set(resPath); }
111
112 static SkString& GetResourcePath() { return gResourcePath; }
113
reed@android.combd700c32009-01-05 03:34:50 +0000114protected:
reed@google.com0561a3c2012-11-15 19:52:20 +0000115 virtual void setupPaint(SkPaint* paint);
reed@android.com4bc19832009-01-19 20:08:35 +0000116
reed@android.combd700c32009-01-05 03:34:50 +0000117 virtual const char* onGetName() = 0;
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +0000118 virtual void onPreDraw() {}
commit-bot@chromium.org33614712013-12-03 18:17:16 +0000119 // Each bench should do its main work in a loop like this:
120 // for (int i = 0; i < loops; i++) { <work here> }
121 virtual void onDraw(const int loops, SkCanvas*) = 0;
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +0000122 virtual void onPostDraw() {}
reed@android.comf523e252009-01-26 23:15:37 +0000123
124 virtual SkIPoint onGetSize();
125
reed@android.com4bc19832009-01-19 20:08:35 +0000126private:
127 int fForceAlpha;
128 bool fForceAA;
reed@android.com29348cb2009-08-04 18:17:15 +0000129 bool fForceFilter;
reed@android.com4e635f92009-10-19 17:39:46 +0000130 SkTriState::State fDither;
reed@google.comef77ec22013-05-29 15:39:54 +0000131 uint32_t fOrMask, fClearMask;
scroggo@google.com111fd112013-09-25 21:42:12 +0000132 static SkString gResourcePath;
robertphillips@google.com15e9d3e2012-06-21 20:25:03 +0000133
134 typedef SkRefCnt INHERITED;
reed@android.combd700c32009-01-05 03:34:50 +0000135};
136
commit-bot@chromium.org38aeb0f2014-02-26 23:01:57 +0000137typedef SkTRegistry<SkBenchmark*(*)(void*)> BenchRegistry;
reed@android.comf523e252009-01-26 23:15:37 +0000138
reed@android.combd700c32009-01-05 03:34:50 +0000139#endif