blob: bf44d2cc9702f295e9bdf7f52f80c2c86256bf23 [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
reed@google.comb8b92ea2012-10-16 15:57:13 +000016#define DEF_BENCH(code) \
mtklein@google.com410e6e82013-09-13 19:52:27 +000017static SkBenchmark* SK_MACRO_APPEND_LINE(F_)() { code; } \
reed@google.comb8b92ea2012-10-16 15:57:13 +000018static BenchRegistry SK_MACRO_APPEND_LINE(R_)(SK_MACRO_APPEND_LINE(F_));
19
20/*
21 * With the above macros, you can register benches as follows (at the bottom
22 * of your .cpp)
23 *
mtklein@google.com410e6e82013-09-13 19:52:27 +000024 * DEF_BENCH(return new MyBenchmark(...))
25 * DEF_BENCH(return new MyBenchmark(...))
26 * DEF_BENCH(return new MyBenchmark(...))
reed@google.comb8b92ea2012-10-16 15:57:13 +000027 */
28
29
reed@android.combd700c32009-01-05 03:34:50 +000030class SkCanvas;
reed@android.com4bc19832009-01-19 20:08:35 +000031class SkPaint;
reed@android.combd700c32009-01-05 03:34:50 +000032
reed@android.com4e635f92009-10-19 17:39:46 +000033class SkTriState {
34public:
35 enum State {
36 kDefault,
37 kTrue,
38 kFalse
39 };
mtklein@google.comc2897432013-09-10 19:23:38 +000040 static const char* Name[];
reed@android.com4e635f92009-10-19 17:39:46 +000041};
42
reed@android.combd700c32009-01-05 03:34:50 +000043class SkBenchmark : public SkRefCnt {
44public:
robertphillips@google.com15e9d3e2012-06-21 20:25:03 +000045 SK_DECLARE_INST_COUNT(SkBenchmark)
46
mtklein@google.com410e6e82013-09-13 19:52:27 +000047 SkBenchmark();
reed@android.com4bc19832009-01-19 20:08:35 +000048
reed@android.combd700c32009-01-05 03:34:50 +000049 const char* getName();
50 SkIPoint getSize();
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +000051
commit-bot@chromium.org644629c2013-11-21 06:21:58 +000052 enum Backend {
53 kNonRendering_Backend,
54 kRaster_Backend,
55 kGPU_Backend,
56 kPDF_Backend,
57 };
58
59 // Call to determine whether the benchmark is intended for
60 // the rendering mode.
61 virtual bool isSuitableFor(Backend backend) {
62 return backend != kNonRendering_Backend;
63 }
64
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +000065 // Call before draw, allows the benchmark to do setup work outside of the
66 // timer. When a benchmark is repeatedly drawn, this should be called once
67 // before the initial draw.
68 void preDraw();
69
commit-bot@chromium.org33614712013-12-03 18:17:16 +000070 // Bench framework can tune loops to be large enough for stable timing.
71 void draw(const int loops, SkCanvas*);
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +000072
73 // Call after draw, allows the benchmark to do cleanup work outside of the
74 // timer. When a benchmark is repeatedly drawn, this is only called once
75 // after the last draw.
76 void postDraw();
77
reed@android.com4bc19832009-01-19 20:08:35 +000078 void setForceAlpha(int alpha) {
79 fForceAlpha = alpha;
80 }
rmistry@google.comfbfcd562012-08-23 18:09:54 +000081
reed@android.com4bc19832009-01-19 20:08:35 +000082 void setForceAA(bool aa) {
83 fForceAA = aa;
84 }
rmistry@google.comfbfcd562012-08-23 18:09:54 +000085
reed@android.com29348cb2009-08-04 18:17:15 +000086 void setForceFilter(bool filter) {
87 fForceFilter = filter;
88 }
rmistry@google.comfbfcd562012-08-23 18:09:54 +000089
reed@android.com4e635f92009-10-19 17:39:46 +000090 void setDither(SkTriState::State state) {
91 fDither = state;
92 }
reed@android.come9d00602009-09-02 21:12:42 +000093
reed@google.comef77ec22013-05-29 15:39:54 +000094 /** Assign masks for paint-flags. These will be applied when setupPaint()
95 * is called.
96 *
97 * Performs the following on the paint:
98 * uint32_t flags = paint.getFlags();
99 * flags &= ~clearMask;
100 * flags |= orMask;
101 * paint.setFlags(flags);
102 */
103 void setPaintMasks(uint32_t orMask, uint32_t clearMask) {
104 fOrMask = orMask;
105 fClearMask = clearMask;
106 }
107
scroggo@google.com111fd112013-09-25 21:42:12 +0000108 static void SetResourcePath(const char* resPath) { gResourcePath.set(resPath); }
109
110 static SkString& GetResourcePath() { return gResourcePath; }
111
reed@android.combd700c32009-01-05 03:34:50 +0000112protected:
reed@google.com0561a3c2012-11-15 19:52:20 +0000113 virtual void setupPaint(SkPaint* paint);
reed@android.com4bc19832009-01-19 20:08:35 +0000114
reed@android.combd700c32009-01-05 03:34:50 +0000115 virtual const char* onGetName() = 0;
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +0000116 virtual void onPreDraw() {}
commit-bot@chromium.org33614712013-12-03 18:17:16 +0000117 // Each bench should do its main work in a loop like this:
118 // for (int i = 0; i < loops; i++) { <work here> }
119 virtual void onDraw(const int loops, SkCanvas*) = 0;
bsalomon@google.com30e6d2c2012-08-13 14:03:31 +0000120 virtual void onPostDraw() {}
reed@android.comf523e252009-01-26 23:15:37 +0000121
122 virtual SkIPoint onGetSize();
123
reed@android.com4bc19832009-01-19 20:08:35 +0000124private:
125 int fForceAlpha;
126 bool fForceAA;
reed@android.com29348cb2009-08-04 18:17:15 +0000127 bool fForceFilter;
reed@android.com4e635f92009-10-19 17:39:46 +0000128 SkTriState::State fDither;
reed@google.comef77ec22013-05-29 15:39:54 +0000129 uint32_t fOrMask, fClearMask;
scroggo@google.com111fd112013-09-25 21:42:12 +0000130 static SkString gResourcePath;
robertphillips@google.com15e9d3e2012-06-21 20:25:03 +0000131
132 typedef SkRefCnt INHERITED;
reed@android.combd700c32009-01-05 03:34:50 +0000133};
134
mtklein@google.com410e6e82013-09-13 19:52:27 +0000135typedef SkTRegistry<SkBenchmark*(*)()> BenchRegistry;
reed@android.comf523e252009-01-26 23:15:37 +0000136
reed@android.combd700c32009-01-05 03:34:50 +0000137#endif