bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +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 | */ |
| 7 | |
Mike Klein | c0bd9f9 | 2019-04-23 12:05:21 -0500 | [diff] [blame] | 8 | #include "gm/gm.h" |
Tyler Denniston | 45f94f8 | 2020-02-04 16:09:08 -0500 | [diff] [blame] | 9 | #include "gm/verifiers/gmverifier.h" |
Ben Wagner | 7fde8e1 | 2019-05-01 17:28:53 -0400 | [diff] [blame] | 10 | #include "include/core/SkBitmap.h" |
| 11 | #include "include/core/SkBlendMode.h" |
| 12 | #include "include/core/SkCanvas.h" |
| 13 | #include "include/core/SkFilterQuality.h" |
| 14 | #include "include/core/SkFont.h" |
| 15 | #include "include/core/SkFontTypes.h" |
| 16 | #include "include/core/SkMatrix.h" |
| 17 | #include "include/core/SkPaint.h" |
| 18 | #include "include/core/SkRect.h" |
Mike Klein | c0bd9f9 | 2019-04-23 12:05:21 -0500 | [diff] [blame] | 19 | #include "include/core/SkShader.h" |
Ben Wagner | 7fde8e1 | 2019-05-01 17:28:53 -0400 | [diff] [blame] | 20 | #include "include/core/SkTileMode.h" |
| 21 | #include "include/core/SkTypeface.h" |
Robert Phillips | b7bfbc2 | 2020-07-01 12:55:01 -0400 | [diff] [blame] | 22 | #include "include/gpu/GrRecordingContext.h" |
Mike Klein | c0bd9f9 | 2019-04-23 12:05:21 -0500 | [diff] [blame] | 23 | #include "src/core/SkTraceEvent.h" |
| 24 | #include "tools/ToolUtils.h" |
Ben Wagner | 7fde8e1 | 2019-05-01 17:28:53 -0400 | [diff] [blame] | 25 | |
| 26 | #include <stdarg.h> |
| 27 | |
| 28 | class GrRenderTargetContext; |
| 29 | |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 30 | using namespace skiagm; |
| 31 | |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 32 | constexpr char GM::kErrorMsg_DrawSkippedGpuOnly[]; |
| 33 | |
| 34 | static void draw_failure_message(SkCanvas* canvas, const char format[], ...) { |
| 35 | SkString failureMsg; |
| 36 | |
| 37 | va_list argp; |
| 38 | va_start(argp, format); |
| 39 | failureMsg.appendVAList(format, argp); |
| 40 | va_end(argp); |
| 41 | |
| 42 | constexpr SkScalar kOffset = 5.0f; |
| 43 | canvas->drawColor(SkColorSetRGB(200,0,0)); |
| 44 | SkFont font; |
| 45 | SkRect bounds; |
Ben Wagner | 51e15a6 | 2019-05-07 15:38:46 -0400 | [diff] [blame] | 46 | font.measureText(failureMsg.c_str(), failureMsg.size(), SkTextEncoding::kUTF8, &bounds); |
Hal Canary | 0a7b393 | 2019-05-02 11:31:28 -0400 | [diff] [blame] | 47 | SkPaint textPaint(SkColors::kWhite); |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 48 | canvas->drawString(failureMsg, kOffset, bounds.height() + kOffset, font, textPaint); |
| 49 | } |
| 50 | |
| 51 | static void draw_gpu_only_message(SkCanvas* canvas) { |
| 52 | SkBitmap bmp; |
| 53 | bmp.allocN32Pixels(128, 64); |
| 54 | SkCanvas bmpCanvas(bmp); |
| 55 | bmpCanvas.drawColor(SK_ColorWHITE); |
Mike Klein | ea3f014 | 2019-03-20 11:12:10 -0500 | [diff] [blame] | 56 | SkFont font(ToolUtils::create_portable_typeface(), 20); |
Hal Canary | 0a7b393 | 2019-05-02 11:31:28 -0400 | [diff] [blame] | 57 | SkPaint paint(SkColors::kRed); |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 58 | bmpCanvas.drawString("GPU Only", 20, 40, font, paint); |
| 59 | SkMatrix localM; |
| 60 | localM.setRotate(35.f); |
| 61 | localM.postTranslate(10.f, 0.f); |
Mike Reed | 50acf8f | 2019-04-08 13:20:23 -0400 | [diff] [blame] | 62 | paint.setShader(bmp.makeShader(SkTileMode::kMirror, SkTileMode::kMirror, &localM)); |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 63 | paint.setFilterQuality(kMedium_SkFilterQuality); |
| 64 | canvas->drawPaint(paint); |
| 65 | } |
| 66 | |
Robert Phillips | d26d25e | 2020-06-25 13:26:22 -0400 | [diff] [blame] | 67 | static void handle_gm_failure(SkCanvas* canvas, DrawResult result, const SkString& errorMsg) { |
| 68 | if (DrawResult::kFail == result) { |
| 69 | draw_failure_message(canvas, "DRAW FAILED: %s", errorMsg.c_str()); |
| 70 | } else if (SkString(GM::kErrorMsg_DrawSkippedGpuOnly) == errorMsg) { |
| 71 | draw_gpu_only_message(canvas); |
| 72 | } else { |
| 73 | draw_failure_message(canvas, "DRAW SKIPPED: %s", errorMsg.c_str()); |
| 74 | } |
| 75 | } |
| 76 | |
Chris Dalton | 3a77837 | 2019-02-07 15:23:36 -0700 | [diff] [blame] | 77 | GM::GM(SkColor bgColor) { |
commit-bot@chromium.org | b21fac1 | 2014-02-07 21:13:11 +0000 | [diff] [blame] | 78 | fMode = kGM_Mode; |
Chris Dalton | 3a77837 | 2019-02-07 15:23:36 -0700 | [diff] [blame] | 79 | fBGColor = bgColor; |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 80 | } |
tfarina | 880914c | 2014-06-09 12:05:34 -0700 | [diff] [blame] | 81 | |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 82 | GM::~GM() {} |
| 83 | |
Robert Phillips | b87b39b | 2020-07-01 14:45:24 -0400 | [diff] [blame] | 84 | DrawResult GM::gpuSetup(GrDirectContext* context, SkCanvas* canvas, SkString* errorMsg) { |
Robert Phillips | 889d613 | 2020-06-16 11:11:33 -0400 | [diff] [blame] | 85 | TRACE_EVENT1("GM", TRACE_FUNC, "name", TRACE_STR_COPY(this->getName())); |
Robert Phillips | e922953 | 2020-06-26 10:10:49 -0400 | [diff] [blame] | 86 | if (!fGpuSetup) { |
| 87 | // When drawn in viewer, gpuSetup will be called multiple times with the same |
| 88 | // GrContext. |
| 89 | fGpuSetup = true; |
| 90 | fGpuSetupResult = this->onGpuSetup(context, errorMsg); |
Robert Phillips | d26d25e | 2020-06-25 13:26:22 -0400 | [diff] [blame] | 91 | } |
Robert Phillips | e922953 | 2020-06-26 10:10:49 -0400 | [diff] [blame] | 92 | if (DrawResult::kOk != fGpuSetupResult) { |
| 93 | handle_gm_failure(canvas, fGpuSetupResult, *errorMsg); |
| 94 | } |
| 95 | |
| 96 | return fGpuSetupResult; |
Robert Phillips | 889d613 | 2020-06-16 11:11:33 -0400 | [diff] [blame] | 97 | } |
| 98 | |
Robert Phillips | b795bea | 2020-06-25 12:38:53 -0400 | [diff] [blame] | 99 | void GM::gpuTeardown() { |
| 100 | this->onGpuTeardown(); |
Robert Phillips | e922953 | 2020-06-26 10:10:49 -0400 | [diff] [blame] | 101 | |
| 102 | // After 'gpuTeardown' a GM can be reused with a different GrContext. Reset the flag |
| 103 | // so 'onGpuSetup' will be called. |
| 104 | fGpuSetup = false; |
Robert Phillips | b795bea | 2020-06-25 12:38:53 -0400 | [diff] [blame] | 105 | } |
| 106 | |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 107 | DrawResult GM::draw(SkCanvas* canvas, SkString* errorMsg) { |
Mike Klein | b323a5e | 2017-07-24 15:21:31 -0400 | [diff] [blame] | 108 | TRACE_EVENT1("GM", TRACE_FUNC, "name", TRACE_STR_COPY(this->getName())); |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 109 | this->drawBackground(canvas); |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 110 | return this->drawContent(canvas, errorMsg); |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 111 | } |
| 112 | |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 113 | DrawResult GM::drawContent(SkCanvas* canvas, SkString* errorMsg) { |
Mike Klein | b323a5e | 2017-07-24 15:21:31 -0400 | [diff] [blame] | 114 | TRACE_EVENT0("GM", TRACE_FUNC); |
Robert Phillips | 83b749a | 2020-06-25 11:41:19 -0400 | [diff] [blame] | 115 | this->onceBeforeDraw(); |
Mike Reed | 36c4fb3 | 2018-12-18 11:48:01 -0500 | [diff] [blame] | 116 | SkAutoCanvasRestore acr(canvas, true); |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 117 | DrawResult drawResult = this->onDraw(canvas, errorMsg); |
| 118 | if (DrawResult::kOk != drawResult) { |
Robert Phillips | d26d25e | 2020-06-25 13:26:22 -0400 | [diff] [blame] | 119 | handle_gm_failure(canvas, drawResult, *errorMsg); |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 120 | } |
| 121 | return drawResult; |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | void GM::drawBackground(SkCanvas* canvas) { |
Mike Klein | b323a5e | 2017-07-24 15:21:31 -0400 | [diff] [blame] | 125 | TRACE_EVENT0("GM", TRACE_FUNC); |
Robert Phillips | 83b749a | 2020-06-25 11:41:19 -0400 | [diff] [blame] | 126 | this->onceBeforeDraw(); |
Chris Dalton | 21ca370 | 2019-02-01 12:15:42 -0700 | [diff] [blame] | 127 | canvas->drawColor(fBGColor, SkBlendMode::kSrc); |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 128 | } |
| 129 | |
Mike Klein | 9707e90 | 2019-02-07 16:18:22 -0500 | [diff] [blame] | 130 | DrawResult GM::onDraw(SkCanvas* canvas, SkString* errorMsg) { |
| 131 | this->onDraw(canvas); |
| 132 | return DrawResult::kOk; |
| 133 | } |
| 134 | void GM::onDraw(SkCanvas*) { SK_ABORT("Not implemented."); } |
| 135 | |
| 136 | |
| 137 | SkISize SimpleGM::onISize() { return fSize; } |
| 138 | SkString SimpleGM::onShortName() { return fName; } |
| 139 | DrawResult SimpleGM::onDraw(SkCanvas* canvas, SkString* errorMsg) { |
| 140 | return fDrawProc(canvas, errorMsg); |
| 141 | } |
| 142 | |
| 143 | SkISize SimpleGpuGM::onISize() { return fSize; } |
| 144 | SkString SimpleGpuGM::onShortName() { return fName; } |
Robert Phillips | 95c250c | 2020-06-29 15:36:12 -0400 | [diff] [blame] | 145 | DrawResult SimpleGpuGM::onDraw(GrRecordingContext* ctx, GrRenderTargetContext* rtc, |
| 146 | SkCanvas* canvas, SkString* errorMsg) { |
Mike Klein | 9707e90 | 2019-02-07 16:18:22 -0500 | [diff] [blame] | 147 | return fDrawProc(ctx, rtc, canvas, errorMsg); |
| 148 | } |
| 149 | |
commit-bot@chromium.org | 38aeb0f | 2014-02-26 23:01:57 +0000 | [diff] [blame] | 150 | const char* GM::getName() { |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 151 | if (fShortName.size() == 0) { |
| 152 | fShortName = this->onShortName(); |
| 153 | } |
| 154 | return fShortName.c_str(); |
| 155 | } |
| 156 | |
| 157 | void GM::setBGColor(SkColor color) { |
| 158 | fBGColor = color; |
| 159 | } |
| 160 | |
Hal Canary | 4124807 | 2019-07-11 16:32:53 -0400 | [diff] [blame] | 161 | bool GM::animate(double nanos) { return this->onAnimate(nanos); } |
reed | d9adfe6 | 2015-02-01 19:01:04 -0800 | [diff] [blame] | 162 | |
Mike Klein | 9707e90 | 2019-02-07 16:18:22 -0500 | [diff] [blame] | 163 | bool GM::runAsBench() const { return false; } |
| 164 | void GM::modifyGrContextOptions(GrContextOptions* options) {} |
| 165 | |
Tyler Denniston | 45f94f8 | 2020-02-04 16:09:08 -0500 | [diff] [blame] | 166 | std::unique_ptr<verifiers::VerifierList> GM::getVerifiers() const { |
| 167 | // No verifiers by default. |
| 168 | return nullptr; |
| 169 | } |
| 170 | |
Mike Klein | 9707e90 | 2019-02-07 16:18:22 -0500 | [diff] [blame] | 171 | void GM::onOnceBeforeDraw() {} |
| 172 | |
Hal Canary | 4124807 | 2019-07-11 16:32:53 -0400 | [diff] [blame] | 173 | bool GM::onAnimate(double /*nanos*/) { return false; } |
Hal Canary | c74a550 | 2019-07-08 14:55:15 -0400 | [diff] [blame] | 174 | |
| 175 | bool GM::onChar(SkUnichar uni) { return false; } |
| 176 | |
Mike Klein | 9707e90 | 2019-02-07 16:18:22 -0500 | [diff] [blame] | 177 | bool GM::onGetControls(SkMetaData*) { return false; } |
Hal Canary | c74a550 | 2019-07-08 14:55:15 -0400 | [diff] [blame] | 178 | |
Mike Klein | 9707e90 | 2019-02-07 16:18:22 -0500 | [diff] [blame] | 179 | void GM::onSetControls(const SkMetaData&) {} |
| 180 | |
reed | d9adfe6 | 2015-02-01 19:01:04 -0800 | [diff] [blame] | 181 | ///////////////////////////////////////////////////////////////////////////////////////////// |
| 182 | |
reed@google.com | 2d6ef52 | 2012-01-03 17:20:38 +0000 | [diff] [blame] | 183 | void GM::drawSizeBounds(SkCanvas* canvas, SkColor color) { |
Hal Canary | 0a7b393 | 2019-05-02 11:31:28 -0400 | [diff] [blame] | 184 | canvas->drawRect(SkRect::Make(this->getISize()), SkPaint(SkColor4f::FromColor(color))); |
reed@google.com | 2d6ef52 | 2012-01-03 17:20:38 +0000 | [diff] [blame] | 185 | } |
| 186 | |
bsalomon@google.com | 48dd1a2 | 2011-10-31 14:18:20 +0000 | [diff] [blame] | 187 | // need to explicitly declare this, or we get some weird infinite loop llist |
tfarina | bcbc178 | 2014-06-18 14:32:48 -0700 | [diff] [blame] | 188 | template GMRegistry* GMRegistry::gHead; |
halcanary | f62c634 | 2015-01-12 15:27:46 -0800 | [diff] [blame] | 189 | |
Robert Phillips | 95c250c | 2020-06-29 15:36:12 -0400 | [diff] [blame] | 190 | DrawResult GpuGM::onDraw(GrRecordingContext* ctx, GrRenderTargetContext* rtc, SkCanvas* canvas, |
Robert Phillips | 889d613 | 2020-06-16 11:11:33 -0400 | [diff] [blame] | 191 | SkString* errorMsg) { |
Mike Klein | 9707e90 | 2019-02-07 16:18:22 -0500 | [diff] [blame] | 192 | this->onDraw(ctx, rtc, canvas); |
| 193 | return DrawResult::kOk; |
| 194 | } |
Robert Phillips | 95c250c | 2020-06-29 15:36:12 -0400 | [diff] [blame] | 195 | void GpuGM::onDraw(GrRecordingContext*, GrRenderTargetContext*, SkCanvas*) { |
Mike Klein | 9707e90 | 2019-02-07 16:18:22 -0500 | [diff] [blame] | 196 | SK_ABORT("Not implemented."); |
| 197 | } |
| 198 | |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 199 | DrawResult GpuGM::onDraw(SkCanvas* canvas, SkString* errorMsg) { |
Robert Phillips | 95c250c | 2020-06-29 15:36:12 -0400 | [diff] [blame] | 200 | |
| 201 | auto ctx = canvas->recordingContext(); |
Chris Dalton | 3a77837 | 2019-02-07 15:23:36 -0700 | [diff] [blame] | 202 | GrRenderTargetContext* rtc = canvas->internal_private_accessTopLayerRenderTargetContext(); |
| 203 | if (!ctx || !rtc) { |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 204 | *errorMsg = kErrorMsg_DrawSkippedGpuOnly; |
| 205 | return DrawResult::kSkip; |
Chris Dalton | 3a77837 | 2019-02-07 15:23:36 -0700 | [diff] [blame] | 206 | } |
Robert Phillips | 9eb0002 | 2020-06-30 15:30:12 -0400 | [diff] [blame] | 207 | if (ctx->abandoned()) { |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 208 | *errorMsg = "GrContext abandoned."; |
Mike Klein | 290690c | 2019-04-02 18:11:57 -0400 | [diff] [blame] | 209 | return DrawResult::kSkip; |
Chris Dalton | 3a77837 | 2019-02-07 15:23:36 -0700 | [diff] [blame] | 210 | } |
Chris Dalton | 50e24d7 | 2019-02-07 16:20:09 -0700 | [diff] [blame] | 211 | return this->onDraw(ctx, rtc, canvas, errorMsg); |
halcanary | f62c634 | 2015-01-12 15:27:46 -0800 | [diff] [blame] | 212 | } |
Mike Klein | c9eace8 | 2018-10-31 10:49:38 -0400 | [diff] [blame] | 213 | |
| 214 | template <typename Fn> |
| 215 | static void mark(SkCanvas* canvas, SkScalar x, SkScalar y, Fn&& fn) { |
| 216 | SkPaint alpha; |
| 217 | alpha.setAlpha(0x50); |
| 218 | canvas->saveLayer(nullptr, &alpha); |
| 219 | canvas->translate(x,y); |
| 220 | canvas->scale(2,2); |
| 221 | fn(); |
| 222 | canvas->restore(); |
| 223 | } |
| 224 | |
| 225 | void MarkGMGood(SkCanvas* canvas, SkScalar x, SkScalar y) { |
| 226 | mark(canvas, x,y, [&]{ |
Mike Klein | c9eace8 | 2018-10-31 10:49:38 -0400 | [diff] [blame] | 227 | // A green circle. |
Hal Canary | 0a7b393 | 2019-05-02 11:31:28 -0400 | [diff] [blame] | 228 | canvas->drawCircle(0, 0, 12, SkPaint(SkColor4f::FromColor(SkColorSetRGB(27, 158, 119)))); |
Mike Klein | c9eace8 | 2018-10-31 10:49:38 -0400 | [diff] [blame] | 229 | |
| 230 | // Cut out a check mark. |
Hal Canary | 0a7b393 | 2019-05-02 11:31:28 -0400 | [diff] [blame] | 231 | SkPaint paint(SkColors::kTransparent); |
Mike Klein | c9eace8 | 2018-10-31 10:49:38 -0400 | [diff] [blame] | 232 | paint.setBlendMode(SkBlendMode::kSrc); |
Mike Klein | c9eace8 | 2018-10-31 10:49:38 -0400 | [diff] [blame] | 233 | paint.setStrokeWidth(2); |
| 234 | paint.setStyle(SkPaint::kStroke_Style); |
| 235 | canvas->drawLine(-6, 0, |
| 236 | -1, 5, paint); |
| 237 | canvas->drawLine(-1, +5, |
| 238 | +7, -5, paint); |
| 239 | }); |
| 240 | } |
| 241 | |
| 242 | void MarkGMBad(SkCanvas* canvas, SkScalar x, SkScalar y) { |
| 243 | mark(canvas, x,y, [&] { |
Mike Klein | c9eace8 | 2018-10-31 10:49:38 -0400 | [diff] [blame] | 244 | // A red circle. |
Hal Canary | 0a7b393 | 2019-05-02 11:31:28 -0400 | [diff] [blame] | 245 | canvas->drawCircle(0,0, 12, SkPaint(SkColor4f::FromColor(SkColorSetRGB(231, 41, 138)))); |
Mike Klein | c9eace8 | 2018-10-31 10:49:38 -0400 | [diff] [blame] | 246 | |
| 247 | // Cut out an 'X'. |
Hal Canary | 0a7b393 | 2019-05-02 11:31:28 -0400 | [diff] [blame] | 248 | SkPaint paint(SkColors::kTransparent); |
Mike Klein | c9eace8 | 2018-10-31 10:49:38 -0400 | [diff] [blame] | 249 | paint.setBlendMode(SkBlendMode::kSrc); |
Mike Klein | c9eace8 | 2018-10-31 10:49:38 -0400 | [diff] [blame] | 250 | paint.setStrokeWidth(2); |
| 251 | paint.setStyle(SkPaint::kStroke_Style); |
| 252 | canvas->drawLine(-5,-5, |
| 253 | +5,+5, paint); |
| 254 | canvas->drawLine(+5,-5, |
| 255 | -5,+5, paint); |
| 256 | }); |
| 257 | } |