blob: a6ba883582e202bd2b4c2e11eec021de99b677bd [file] [log] [blame]
Brian Osman088913a2019-12-19 15:44:56 -05001/*
2 * Copyright 2019 Google LLC
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
Brian Osman62419612020-07-22 10:19:02 -04008#include "include/core/SkBitmap.h"
Brian Osmanf72dedd2020-01-08 13:19:58 -05009#include "include/core/SkCanvas.h"
Brian Osman92aac1e2020-08-05 16:48:58 -040010#include "include/core/SkColorFilter.h"
Brian Osman269b21c2020-08-06 12:15:53 -040011#include "include/core/SkData.h"
Brian Osmanf72dedd2020-01-08 13:19:58 -050012#include "include/core/SkPaint.h"
13#include "include/core/SkSurface.h"
Brian Osmanee426f22020-01-02 11:55:24 -050014#include "include/effects/SkRuntimeEffect.h"
Robert Phillips6d344c32020-07-06 10:56:46 -040015#include "include/gpu/GrDirectContext.h"
Brian Salomon5392c942021-03-30 16:14:37 -040016#include "src/core/SkColorSpacePriv.h"
Brian Osman4f009822021-04-28 09:41:06 -040017#include "src/core/SkRuntimeEffectPriv.h"
Brian Osmand9bde072020-04-15 14:18:13 -040018#include "src/core/SkTLazy.h"
Brian Osman62419612020-07-22 10:19:02 -040019#include "src/gpu/GrColor.h"
Brian Osman4d571112021-04-27 09:10:10 -040020#include "src/gpu/GrFragmentProcessor.h"
Brian Osman088913a2019-12-19 15:44:56 -050021#include "tests/Test.h"
22
Brian Osmanf72dedd2020-01-08 13:19:58 -050023#include <algorithm>
Brian Osman8e2ef022020-09-30 13:26:43 -040024#include <thread>
Brian Osmanf72dedd2020-01-08 13:19:58 -050025
John Stiles7ce17512021-01-12 18:39:02 -050026void test_invalid_effect(skiatest::Reporter* r, const char* src, const char* expected) {
Brian Osman56ed7da2021-04-21 15:57:27 -040027 auto [effect, errorText] = SkRuntimeEffect::MakeForShader(SkString(src));
John Stiles7ce17512021-01-12 18:39:02 -050028 REPORTER_ASSERT(r, !effect);
29 REPORTER_ASSERT(r, errorText.contains(expected),
30 "Expected error message to contain \"%s\". Actual message: \"%s\"",
31 expected, errorText.c_str());
32};
Brian Osman088913a2019-12-19 15:44:56 -050033
Brian Osman56ed7da2021-04-21 15:57:27 -040034#define EMPTY_MAIN "half4 main(float2 p) { return half4(0); }"
Brian Osman24c18522020-11-10 16:36:01 -050035
John Stiles7ce17512021-01-12 18:39:02 -050036DEF_TEST(SkRuntimeEffectInvalid_FPOnly, r) {
Brian Osman088913a2019-12-19 15:44:56 -050037 // Features that are only allowed in .fp files (key, in uniform, ctype, when, tracked).
38 // Ensure that these fail, and the error messages contain the relevant keyword.
John Stiles7ce17512021-01-12 18:39:02 -050039 test_invalid_effect(r, "layout(key) in bool Input;" EMPTY_MAIN, "key");
40 test_invalid_effect(r, "in uniform float Input;" EMPTY_MAIN, "in uniform");
41 test_invalid_effect(r, "layout(ctype=SkRect) float4 Input;" EMPTY_MAIN, "ctype");
42 test_invalid_effect(r, "in bool Flag; "
43 "layout(when=Flag) uniform float Input;" EMPTY_MAIN, "when");
44 test_invalid_effect(r, "layout(tracked) uniform float Input;" EMPTY_MAIN, "tracked");
45}
Brian Osman088913a2019-12-19 15:44:56 -050046
John Stiles7ce17512021-01-12 18:39:02 -050047DEF_TEST(SkRuntimeEffectInvalid_LimitedUniformTypes, r) {
Brian Osmand18967c2021-04-01 09:56:07 -040048 // Runtime SkSL supports a limited set of uniform types. No bool, for example:
John Stiles7ce17512021-01-12 18:39:02 -050049 test_invalid_effect(r, "uniform bool b;" EMPTY_MAIN, "uniform");
John Stiles7ce17512021-01-12 18:39:02 -050050}
Brian Osman088913a2019-12-19 15:44:56 -050051
John Stiles7ce17512021-01-12 18:39:02 -050052DEF_TEST(SkRuntimeEffectInvalid_NoInVariables, r) {
Brian Osmana4b91692020-08-10 14:26:16 -040053 // 'in' variables aren't allowed at all:
John Stiles7ce17512021-01-12 18:39:02 -050054 test_invalid_effect(r, "in bool b;" EMPTY_MAIN, "'in'");
55 test_invalid_effect(r, "in float f;" EMPTY_MAIN, "'in'");
56 test_invalid_effect(r, "in float2 v;" EMPTY_MAIN, "'in'");
57 test_invalid_effect(r, "in half3x3 m;" EMPTY_MAIN, "'in'");
58}
Brian Osman8783b782020-01-06 11:13:45 -050059
John Stiles7ce17512021-01-12 18:39:02 -050060DEF_TEST(SkRuntimeEffectInvalid_UndefinedFunction, r) {
Brian Osman56ed7da2021-04-21 15:57:27 -040061 test_invalid_effect(r, "half4 missing(); half4 main(float2 p) { return missing(); }",
John Stiles7ce17512021-01-12 18:39:02 -050062 "undefined function");
63}
Brian Osman182c92e2020-07-20 15:18:33 -040064
John Stiles7ce17512021-01-12 18:39:02 -050065DEF_TEST(SkRuntimeEffectInvalid_UndefinedMain, r) {
Brian Osman182c92e2020-07-20 15:18:33 -040066 // Shouldn't be possible to create an SkRuntimeEffect without "main"
John Stiles7ce17512021-01-12 18:39:02 -050067 test_invalid_effect(r, "", "main");
68}
Brian Osman82329002020-07-21 09:39:27 -040069
John Stiles7ce17512021-01-12 18:39:02 -050070DEF_TEST(SkRuntimeEffectInvalid_SkCapsDisallowed, r) {
Brian Osmanb06301e2020-11-06 11:45:36 -050071 // sk_Caps is an internal system. It should not be visible to runtime effects
Brian Osman56ed7da2021-04-21 15:57:27 -040072 test_invalid_effect(
73 r,
74 "half4 main(float2 p) { return sk_Caps.integerSupport ? half4(1) : half4(0); }",
75 "unknown identifier 'sk_Caps'");
John Stiles7ce17512021-01-12 18:39:02 -050076}
Brian Osmanb06301e2020-11-06 11:45:36 -050077
John Stiles65d7ab22021-04-28 15:14:09 -040078DEF_TEST(SkRuntimeEffectCanDisableES2Restrictions, r) {
79 auto test_valid_es3 = [](skiatest::Reporter* r, const char* sksl) {
80 SkRuntimeEffect::Options opt;
81 opt.enforceES2Restrictions = false;
82 auto [effect, errorText] = SkRuntimeEffect::MakeForShader(SkString(sksl), opt);
83 REPORTER_ASSERT(r, effect, "%s", errorText.c_str());
84 };
85
86 test_invalid_effect(r, "float f[2] = float[2](0, 1);" EMPTY_MAIN, "construction of array type");
87 test_valid_es3 (r, "float f[2] = float[2](0, 1);" EMPTY_MAIN);
88}
89
Brian Osmanaf4e2332021-04-20 12:00:10 -040090DEF_TEST(SkRuntimeEffectForColorFilter, r) {
91 // Tests that the color filter factory rejects or accepts certain SkSL constructs
92 auto test_valid = [r](const char* sksl) {
93 auto [effect, errorText] = SkRuntimeEffect::MakeForColorFilter(SkString(sksl));
John Stiles65d7ab22021-04-28 15:14:09 -040094 REPORTER_ASSERT(r, effect, "%s", errorText.c_str());
Brian Osmanaf4e2332021-04-20 12:00:10 -040095 };
96
97 auto test_invalid = [r](const char* sksl, const char* expected) {
98 auto [effect, errorText] = SkRuntimeEffect::MakeForColorFilter(SkString(sksl));
99 REPORTER_ASSERT(r, !effect);
100 REPORTER_ASSERT(r,
101 errorText.contains(expected),
102 "Expected error message to contain \"%s\". Actual message: \"%s\"",
103 expected,
104 errorText.c_str());
105 };
106
107 // Color filters must use the 'half4 main(half4)' signature. Either color can be float4/vec4
108 test_valid("half4 main(half4 c) { return c; }");
109 test_valid("float4 main(half4 c) { return c; }");
110 test_valid("half4 main(float4 c) { return c; }");
111 test_valid("float4 main(float4 c) { return c; }");
112 test_valid("vec4 main(half4 c) { return c; }");
113 test_valid("half4 main(vec4 c) { return c; }");
114 test_valid("vec4 main(vec4 c) { return c; }");
115
116 // Invalid return types
117 test_invalid("void main(half4 c) {}", "'main' must return");
118 test_invalid("half3 main(half4 c) { return c.rgb; }", "'main' must return");
119
120 // Invalid argument types (some are valid as shaders, but not color filters)
121 test_invalid("half4 main() { return half4(1); }", "'main' parameter");
122 test_invalid("half4 main(float2 p) { return half4(1); }", "'main' parameter");
123 test_invalid("half4 main(float2 p, half4 c) { return c; }", "'main' parameter");
124
125 // sk_FragCoord should not be available
126 test_invalid("half4 main(half4 c) { return sk_FragCoord.xy01; }", "unknown identifier");
127
128 // Sampling a child shader requires that we pass explicit coords
129 test_valid("uniform shader child;"
130 "half4 main(half4 c) { return sample(child, c.rg); }");
131
132 test_invalid(
133 "uniform shader child;"
134 "half4 main(half4 c) { return sample(child); }",
135 "expected 2 arguments");
136 test_invalid(
137 "uniform shader child;"
138 "half4 main(half4 c) { return sample(child, float3x3(1)); }",
139 "expected 'float2'");
140}
141
142DEF_TEST(SkRuntimeEffectForShader, r) {
143 // Tests that the shader factory rejects or accepts certain SkSL constructs
144 auto test_valid = [r](const char* sksl) {
145 auto [effect, errorText] = SkRuntimeEffect::MakeForShader(SkString(sksl));
John Stiles65d7ab22021-04-28 15:14:09 -0400146 REPORTER_ASSERT(r, effect, "%s", errorText.c_str());
Brian Osmanaf4e2332021-04-20 12:00:10 -0400147 };
148
149 auto test_invalid = [r](const char* sksl, const char* expected) {
150 auto [effect, errorText] = SkRuntimeEffect::MakeForShader(SkString(sksl));
151 REPORTER_ASSERT(r, !effect);
152 REPORTER_ASSERT(r,
153 errorText.contains(expected),
154 "Expected error message to contain \"%s\". Actual message: \"%s\"",
155 expected,
156 errorText.c_str());
157 };
158
159 // Shaders must use either the 'half4 main(float2)' or 'half4 main(float2, half4)' signature
160 // Either color can be half4/float4/vec4, but the coords must be float2/vec2
161 test_valid("half4 main(float2 p) { return p.xyxy; }");
162 test_valid("float4 main(float2 p) { return p.xyxy; }");
163 test_valid("vec4 main(float2 p) { return p.xyxy; }");
164 test_valid("half4 main(vec2 p) { return p.xyxy; }");
165 test_valid("vec4 main(vec2 p) { return p.xyxy; }");
166 test_valid("half4 main(float2 p, half4 c) { return c; }");
167 test_valid("half4 main(float2 p, float4 c) { return c; }");
168 test_valid("half4 main(float2 p, vec4 c) { return c; }");
169 test_valid("float4 main(float2 p, half4 c) { return c; }");
170 test_valid("vec4 main(float2 p, half4 c) { return c; }");
171 test_valid("vec4 main(vec2 p, vec4 c) { return c; }");
172
173 // Invalid return types
174 test_invalid("void main(float2 p) {}", "'main' must return");
175 test_invalid("half3 main(float2 p) { return p.xy1; }", "'main' must return");
176
177 // Invalid argument types (some are valid as color filters, but not shaders)
178 test_invalid("half4 main() { return half4(1); }", "'main' parameter");
179 test_invalid("half4 main(half4 c) { return c; }", "'main' parameter");
180
181 // sk_FragCoord should be available
182 test_valid("half4 main(float2 p) { return sk_FragCoord.xy01; }");
183
184 // Sampling a child shader requires that we pass explicit coords
185 test_valid("uniform shader child;"
186 "half4 main(float2 p) { return sample(child, p); }");
187
188 test_invalid(
189 "uniform shader child;"
190 "half4 main(float2 p) { return sample(child); }",
191 "expected 2 arguments");
192 test_invalid(
193 "uniform shader child;"
194 "half4 main(float2 p) { return sample(child, float3x3(1)); }",
195 "expected 'float2'");
196}
197
Brian Osmanf72dedd2020-01-08 13:19:58 -0500198class TestEffect {
199public:
Brian Osman62419612020-07-22 10:19:02 -0400200 TestEffect(skiatest::Reporter* r, sk_sp<SkSurface> surface)
201 : fReporter(r), fSurface(std::move(surface)) {}
202
Brian Osman33316412020-11-06 10:42:51 -0500203 void build(const char* src) {
Brian Osman56ed7da2021-04-21 15:57:27 -0400204 auto [effect, errorText] = SkRuntimeEffect::MakeForShader(SkString(src));
Brian Osmanf72dedd2020-01-08 13:19:58 -0500205 if (!effect) {
Brian Osman62419612020-07-22 10:19:02 -0400206 REPORT_FAILURE(fReporter, "effect",
Brian Osmanf72dedd2020-01-08 13:19:58 -0500207 SkStringPrintf("Effect didn't compile: %s", errorText.c_str()));
208 return;
209 }
Brian Osmand9bde072020-04-15 14:18:13 -0400210 fBuilder.init(std::move(effect));
Brian Osmanf72dedd2020-01-08 13:19:58 -0500211 }
212
Brian Osmana4b91692020-08-10 14:26:16 -0400213 SkRuntimeShaderBuilder::BuilderUniform uniform(const char* name) {
214 return fBuilder->uniform(name);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500215 }
Brian Osman62419612020-07-22 10:19:02 -0400216 SkRuntimeShaderBuilder::BuilderChild child(const char* name) {
217 return fBuilder->child(name);
218 }
Brian Osmanf72dedd2020-01-08 13:19:58 -0500219
Brian Osman62419612020-07-22 10:19:02 -0400220 using PreTestFn = std::function<void(SkCanvas*, SkPaint*)>;
221
222 void test(GrColor TL, GrColor TR, GrColor BL, GrColor BR,
223 PreTestFn preTestCallback = nullptr) {
Brian Osmand9bde072020-04-15 14:18:13 -0400224 auto shader = fBuilder->makeShader(nullptr, false);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500225 if (!shader) {
Brian Osman62419612020-07-22 10:19:02 -0400226 REPORT_FAILURE(fReporter, "shader", SkString("Effect didn't produce a shader"));
Brian Osmanf72dedd2020-01-08 13:19:58 -0500227 return;
228 }
229
Brian Osman62419612020-07-22 10:19:02 -0400230 SkCanvas* canvas = fSurface->getCanvas();
Brian Osmanf72dedd2020-01-08 13:19:58 -0500231 SkPaint paint;
232 paint.setShader(std::move(shader));
233 paint.setBlendMode(SkBlendMode::kSrc);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500234
Brian Osman62419612020-07-22 10:19:02 -0400235 canvas->save();
236 if (preTestCallback) {
237 preTestCallback(canvas, &paint);
238 }
239 canvas->drawPaint(paint);
240 canvas->restore();
241
242 GrColor actual[4];
243 SkImageInfo info = fSurface->imageInfo();
244 if (!fSurface->readPixels(info, actual, info.minRowBytes(), 0, 0)) {
245 REPORT_FAILURE(fReporter, "readPixels", SkString("readPixels failed"));
Brian Osmanf72dedd2020-01-08 13:19:58 -0500246 return;
247 }
248
Brian Osman62419612020-07-22 10:19:02 -0400249 GrColor expected[4] = {TL, TR, BL, BR};
John Stilesc1c3c6d2020-08-15 23:22:53 -0400250 if (0 != memcmp(actual, expected, sizeof(actual))) {
Brian Osman62419612020-07-22 10:19:02 -0400251 REPORT_FAILURE(fReporter, "Runtime effect didn't match expectations",
Brian Osmanf72dedd2020-01-08 13:19:58 -0500252 SkStringPrintf("\n"
253 "Expected: [ %08x %08x %08x %08x ]\n"
254 "Got : [ %08x %08x %08x %08x ]\n"
255 "SkSL:\n%s\n",
256 TL, TR, BL, BR, actual[0], actual[1], actual[2],
Brian Osmanb6bd0d22020-08-27 10:51:22 -0400257 actual[3], fBuilder->effect()->source().c_str()));
Brian Osmanf72dedd2020-01-08 13:19:58 -0500258 }
259 }
260
Brian Osman62419612020-07-22 10:19:02 -0400261 void test(GrColor expected, PreTestFn preTestCallback = nullptr) {
262 this->test(expected, expected, expected, expected, preTestCallback);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500263 }
264
265private:
Brian Osman62419612020-07-22 10:19:02 -0400266 skiatest::Reporter* fReporter;
267 sk_sp<SkSurface> fSurface;
Brian Osmand9bde072020-04-15 14:18:13 -0400268 SkTLazy<SkRuntimeShaderBuilder> fBuilder;
Brian Osmanf72dedd2020-01-08 13:19:58 -0500269};
270
Brian Osman62419612020-07-22 10:19:02 -0400271// Produces a 2x2 bitmap shader, with opaque colors:
272// [ Red, Green ]
273// [ Blue, White ]
274static sk_sp<SkShader> make_RGBW_shader() {
275 SkBitmap bmp;
276 bmp.allocPixels(SkImageInfo::Make(2, 2, kRGBA_8888_SkColorType, kPremul_SkAlphaType));
277 SkIRect topLeft = SkIRect::MakeWH(1, 1);
278 bmp.pixmap().erase(SK_ColorRED, topLeft);
279 bmp.pixmap().erase(SK_ColorGREEN, topLeft.makeOffset(1, 0));
280 bmp.pixmap().erase(SK_ColorBLUE, topLeft.makeOffset(0, 1));
281 bmp.pixmap().erase(SK_ColorWHITE, topLeft.makeOffset(1, 1));
Mike Reedb41bd152020-12-12 11:18:31 -0500282 return bmp.makeShader(SkSamplingOptions());
Brian Osman62419612020-07-22 10:19:02 -0400283}
284
Robert Phillipse94b4e12020-07-23 13:54:35 -0400285static void test_RuntimeEffect_Shaders(skiatest::Reporter* r, GrRecordingContext* rContext) {
Brian Osmanf72dedd2020-01-08 13:19:58 -0500286 SkImageInfo info = SkImageInfo::Make(2, 2, kRGBA_8888_SkColorType, kPremul_SkAlphaType);
Robert Phillipse94b4e12020-07-23 13:54:35 -0400287 sk_sp<SkSurface> surface = rContext
288 ? SkSurface::MakeRenderTarget(rContext, SkBudgeted::kNo, info)
289 : SkSurface::MakeRaster(info);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500290 REPORTER_ASSERT(r, surface);
Brian Osman62419612020-07-22 10:19:02 -0400291 TestEffect effect(r, surface);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500292
Brian Osman504032e2020-01-10 10:05:24 -0500293 using float4 = std::array<float, 4>;
Brian Osmand18967c2021-04-01 09:56:07 -0400294 using int4 = std::array<int, 4>;
Brian Osman504032e2020-01-10 10:05:24 -0500295
Brian Osman62419612020-07-22 10:19:02 -0400296 // Local coords
Brian Osman33316412020-11-06 10:42:51 -0500297 effect.build("half4 main(float2 p) { return half4(half2(p - 0.5), 0, 1); }");
Brian Osman62419612020-07-22 10:19:02 -0400298 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500299
Brian Osman62419612020-07-22 10:19:02 -0400300 // Use of a simple uniform. (Draw twice with two values to ensure it's updated).
Brian Osman56ed7da2021-04-21 15:57:27 -0400301 effect.build("uniform float4 gColor; half4 main(float2 p) { return half4(gColor); }");
Brian Osmana4b91692020-08-10 14:26:16 -0400302 effect.uniform("gColor") = float4{ 0.0f, 0.25f, 0.75f, 1.0f };
Brian Osman62419612020-07-22 10:19:02 -0400303 effect.test(0xFFBF4000);
Brian Osmana4b91692020-08-10 14:26:16 -0400304 effect.uniform("gColor") = float4{ 1.0f, 0.0f, 0.0f, 0.498f };
Brian Osman62419612020-07-22 10:19:02 -0400305 effect.test(0x7F00007F); // Tests that we clamp to valid premul
Michael Ludwig5e6b3cd2020-05-27 17:02:37 -0400306
Brian Osmand18967c2021-04-01 09:56:07 -0400307 // Same, with integer uniforms
Brian Osman56ed7da2021-04-21 15:57:27 -0400308 effect.build("uniform int4 gColor; half4 main(float2 p) { return half4(gColor) / 255.0; }");
Brian Osmand18967c2021-04-01 09:56:07 -0400309 effect.uniform("gColor") = int4{ 0x00, 0x40, 0xBF, 0xFF };
310 effect.test(0xFFBF4000);
311 effect.uniform("gColor") = int4{ 0xFF, 0x00, 0x00, 0x7F };
312 effect.test(0x7F00007F); // Tests that we clamp to valid premul
313
Brian Osman62419612020-07-22 10:19:02 -0400314 // Test sk_FragCoord (device coords). Rotate the canvas to be sure we're seeing device coords.
315 // Since the surface is 2x2, we should see (0,0), (1,0), (0,1), (1,1). Multiply by 0.498 to
316 // make sure we're not saturating unexpectedly.
Brian Osman56ed7da2021-04-21 15:57:27 -0400317 effect.build(
318 "half4 main(float2 p) { return half4(0.498 * (half2(sk_FragCoord.xy) - 0.5), 0, 1); }");
Brian Osman62419612020-07-22 10:19:02 -0400319 effect.test(0xFF000000, 0xFF00007F, 0xFF007F00, 0xFF007F7F,
320 [](SkCanvas* canvas, SkPaint*) { canvas->rotate(45.0f); });
Michael Ludwig22534f22020-05-27 17:25:33 -0400321
Brian Osman0acb5b52020-09-02 13:45:47 -0400322 // Runtime effects should use relaxed precision rules by default
Brian Osman33316412020-11-06 10:42:51 -0500323 effect.build("half4 main(float2 p) { return float4(p - 0.5, 0, 1); }");
Brian Osman0acb5b52020-09-02 13:45:47 -0400324 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
325
Brian Osman33316412020-11-06 10:42:51 -0500326 // ... and support *returning* float4 (aka vec4), not just half4
327 effect.build("float4 main(float2 p) { return float4(p - 0.5, 0, 1); }");
328 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
329 effect.build("vec4 main(float2 p) { return float4(p - 0.5, 0, 1); }");
Brian Osmanf1319c32020-10-13 09:34:23 -0400330 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
331
Brian Osmanb4ce9442020-11-11 09:18:02 -0500332 // Mutating coords should work. (skbug.com/10918)
333 effect.build("vec4 main(vec2 p) { p -= 0.5; return vec4(p, 0, 1); }");
334 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
335 effect.build("void moveCoords(inout vec2 p) { p -= 0.5; }"
336 "vec4 main(vec2 p) { moveCoords(p); return vec4(p, 0, 1); }");
337 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
338
Brian Osmanb5f0f522020-07-23 13:28:14 -0400339 //
340 // Sampling children
341 //
342
Brian Osman62419612020-07-22 10:19:02 -0400343 // Sampling a null child should return the paint color
Brian Osman33316412020-11-06 10:42:51 -0500344 effect.build("uniform shader child;"
Brian Osman56ed7da2021-04-21 15:57:27 -0400345 "half4 main(float2 p) { return sample(child, p); }");
Brian Osman62419612020-07-22 10:19:02 -0400346 effect.child("child") = nullptr;
347 effect.test(0xFF00FFFF,
348 [](SkCanvas*, SkPaint* paint) { paint->setColor4f({1.0f, 1.0f, 0.0f, 1.0f}); });
349
350 sk_sp<SkShader> rgbwShader = make_RGBW_shader();
351
Brian Osman56ed7da2021-04-21 15:57:27 -0400352 // Sampling a simple child at our coordinates
Brian Osman33316412020-11-06 10:42:51 -0500353 effect.build("uniform shader child;"
Brian Osman56ed7da2021-04-21 15:57:27 -0400354 "half4 main(float2 p) { return sample(child, p); }");
Brian Osman62419612020-07-22 10:19:02 -0400355 effect.child("child") = rgbwShader;
356 effect.test(0xFF0000FF, 0xFF00FF00, 0xFFFF0000, 0xFFFFFFFF);
357
358 // Sampling with explicit coordinates (reflecting about the diagonal)
Brian Osman33316412020-11-06 10:42:51 -0500359 effect.build("uniform shader child;"
360 "half4 main(float2 p) { return sample(child, p.yx); }");
Brian Osman62419612020-07-22 10:19:02 -0400361 effect.child("child") = rgbwShader;
362 effect.test(0xFF0000FF, 0xFFFF0000, 0xFF00FF00, 0xFFFFFFFF);
363
Brian Osmanb5f0f522020-07-23 13:28:14 -0400364 //
365 // Helper functions
366 //
367
368 // Test case for inlining in the pipeline-stage and fragment-shader passes (skbug.com/10526):
Brian Osman33316412020-11-06 10:42:51 -0500369 effect.build("float2 helper(float2 x) { return x + 1; }"
370 "half4 main(float2 p) { float2 v = helper(p); return half4(half2(v), 0, 1); }");
Brian Osmanb5f0f522020-07-23 13:28:14 -0400371 effect.test(0xFF00FFFF);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500372}
373
374DEF_TEST(SkRuntimeEffectSimple, r) {
375 test_RuntimeEffect_Shaders(r, nullptr);
376}
377
378DEF_GPUTEST_FOR_RENDERING_CONTEXTS(SkRuntimeEffectSimple_GPU, r, ctxInfo) {
Robert Phillips6d344c32020-07-06 10:56:46 -0400379 test_RuntimeEffect_Shaders(r, ctxInfo.directContext());
Brian Osmanf72dedd2020-01-08 13:19:58 -0500380}
Brian Osmanb6bd0d22020-08-27 10:51:22 -0400381
382DEF_TEST(SkRuntimeShaderBuilderReuse, r) {
383 const char* kSource = R"(
384 uniform half x;
Brian Osman56ed7da2021-04-21 15:57:27 -0400385 half4 main(float2 p) { return half4(x); }
Brian Osmanb6bd0d22020-08-27 10:51:22 -0400386 )";
387
Brian Osman56ed7da2021-04-21 15:57:27 -0400388 sk_sp<SkRuntimeEffect> effect = SkRuntimeEffect::MakeForShader(SkString(kSource)).effect;
Brian Osmanb6bd0d22020-08-27 10:51:22 -0400389 REPORTER_ASSERT(r, effect);
390
391 // Test passes if this sequence doesn't assert. skbug.com/10667
392 SkRuntimeShaderBuilder b(std::move(effect));
393 b.uniform("x") = 0.0f;
394 auto shader_0 = b.makeShader(nullptr, false);
395
396 b.uniform("x") = 1.0f;
397 auto shader_1 = b.makeShader(nullptr, true);
398}
Brian Osman8e2ef022020-09-30 13:26:43 -0400399
Derek Sollenberger9e1cedd2021-01-14 08:30:52 -0500400DEF_TEST(SkRuntimeShaderBuilderSetUniforms, r) {
401 const char* kSource = R"(
402 uniform half x;
403 uniform vec2 offset;
Brian Osman56ed7da2021-04-21 15:57:27 -0400404 half4 main(float2 p) { return half4(x); }
Derek Sollenberger9e1cedd2021-01-14 08:30:52 -0500405 )";
406
Brian Osman56ed7da2021-04-21 15:57:27 -0400407 sk_sp<SkRuntimeEffect> effect = SkRuntimeEffect::MakeForShader(SkString(kSource)).effect;
Derek Sollenberger9e1cedd2021-01-14 08:30:52 -0500408 REPORTER_ASSERT(r, effect);
409
410 SkRuntimeShaderBuilder b(std::move(effect));
411
412 // Test passes if this sequence doesn't assert.
413 float x = 1.0f;
414 REPORTER_ASSERT(r, b.uniform("x").set(&x, 1));
415
416 // add extra value to ensure that set doesn't try to use sizeof(array)
417 float origin[] = { 2.0f, 3.0f, 4.0f };
418 REPORTER_ASSERT(r, b.uniform("offset").set<float>(origin, 2));
419
420#ifndef SK_DEBUG
421 REPORTER_ASSERT(r, !b.uniform("offset").set<float>(origin, 1));
422 REPORTER_ASSERT(r, !b.uniform("offset").set<float>(origin, 3));
423#endif
424
425
426 auto shader = b.makeShader(nullptr, false);
427}
428
Brian Osman8e2ef022020-09-30 13:26:43 -0400429DEF_TEST(SkRuntimeEffectThreaded, r) {
430 // SkRuntimeEffect uses a single compiler instance, but it's mutex locked.
431 // This tests that we can safely use it from more than one thread, and also
432 // that programs don't refer to shared structures owned by the compiler.
433 // skbug.com/10589
Brian Osman56ed7da2021-04-21 15:57:27 -0400434 static constexpr char kSource[] = "half4 main(float2 p) { return sk_FragCoord.xyxy; }";
Brian Osman8e2ef022020-09-30 13:26:43 -0400435
436 std::thread threads[16];
437 for (auto& thread : threads) {
438 thread = std::thread([r]() {
Brian Osman56ed7da2021-04-21 15:57:27 -0400439 auto [effect, error] = SkRuntimeEffect::MakeForShader(SkString(kSource));
Brian Osman8e2ef022020-09-30 13:26:43 -0400440 REPORTER_ASSERT(r, effect);
441 });
442 }
443
444 for (auto& thread : threads) {
445 thread.join();
446 }
447}
Mike Klein827f8c02021-02-06 09:13:01 -0600448
449DEF_TEST(SkRuntimeColorFilterSingleColor, r) {
450 // Test runtime colorfilters support filterColor4f().
Brian Osman56ed7da2021-04-21 15:57:27 -0400451 auto [effect, err] =
452 SkRuntimeEffect::MakeForColorFilter(SkString{"half4 main(half4 c) { return c*c; }"});
Mike Klein827f8c02021-02-06 09:13:01 -0600453 REPORTER_ASSERT(r, effect);
454 REPORTER_ASSERT(r, err.isEmpty());
455
Brian Osman56ed7da2021-04-21 15:57:27 -0400456 sk_sp<SkColorFilter> cf = effect->makeColorFilter(SkData::MakeEmpty());
Mike Klein827f8c02021-02-06 09:13:01 -0600457 REPORTER_ASSERT(r, cf);
458
459 SkColor4f c = cf->filterColor4f({0.25, 0.5, 0.75, 1.0},
460 sk_srgb_singleton(), sk_srgb_singleton());
461 REPORTER_ASSERT(r, c.fR == 0.0625f);
462 REPORTER_ASSERT(r, c.fG == 0.25f);
463 REPORTER_ASSERT(r, c.fB == 0.5625f);
464 REPORTER_ASSERT(r, c.fA == 1.0f);
465}
Brian Osman8e756f32021-02-10 10:19:27 -0500466
467static void test_RuntimeEffectStructNameReuse(skiatest::Reporter* r, GrRecordingContext* rContext) {
468 // Test that two different runtime effects can reuse struct names in a single paint operation
Brian Osman56ed7da2021-04-21 15:57:27 -0400469 auto [childEffect, err] = SkRuntimeEffect::MakeForShader(SkString(
Brian Osman8e756f32021-02-10 10:19:27 -0500470 "uniform shader paint;"
471 "struct S { half4 rgba; };"
472 "void process(inout S s) { s.rgba.rgb *= 0.5; }"
Brian Osman56ed7da2021-04-21 15:57:27 -0400473 "half4 main(float2 p) { S s; s.rgba = sample(paint, p); process(s); return s.rgba; }"
Brian Osman8e756f32021-02-10 10:19:27 -0500474 ));
475 REPORTER_ASSERT(r, childEffect, "%s\n", err.c_str());
476 sk_sp<SkShader> nullChild = nullptr;
477 sk_sp<SkShader> child = childEffect->makeShader(/*uniforms=*/nullptr, &nullChild,
478 /*childCount=*/1, /*localMatrix=*/nullptr,
479 /*isOpaque=*/false);
480
481 SkImageInfo info = SkImageInfo::Make(2, 2, kRGBA_8888_SkColorType, kPremul_SkAlphaType);
482 sk_sp<SkSurface> surface = rContext
483 ? SkSurface::MakeRenderTarget(rContext, SkBudgeted::kNo, info)
484 : SkSurface::MakeRaster(info);
485 REPORTER_ASSERT(r, surface);
486
487 TestEffect effect(r, surface);
488 effect.build(
489 "uniform shader child;"
490 "struct S { float2 coord; };"
491 "void process(inout S s) { s.coord = s.coord.yx; }"
492 "half4 main(float2 p) { S s; s.coord = p; process(s); return sample(child, s.coord); "
493 "}");
494 effect.child("child") = child;
495 effect.test(0xFF00407F, [](SkCanvas*, SkPaint* paint) {
496 paint->setColor4f({0.99608f, 0.50196f, 0.0f, 1.0f});
497 });
498}
499
500DEF_TEST(SkRuntimeStructNameReuse, r) {
501 test_RuntimeEffectStructNameReuse(r, nullptr);
502}
503
504DEF_GPUTEST_FOR_RENDERING_CONTEXTS(SkRuntimeStructNameReuse_GPU, r, ctxInfo) {
505 test_RuntimeEffectStructNameReuse(r, ctxInfo.directContext());
506}
Mike Kleine0d9b862021-02-16 12:00:29 -0600507
508DEF_TEST(SkRuntimeColorFilterFlags, r) {
509 { // Here's a non-trivial filter that doesn't change alpha.
Brian Osman56ed7da2021-04-21 15:57:27 -0400510 auto [effect, err] = SkRuntimeEffect::MakeForColorFilter(SkString{
Brian Osmancdee1202021-04-14 09:36:49 -0400511 "half4 main(half4 color) { return color + half4(1,1,1,0); }"});
Mike Kleine0d9b862021-02-16 12:00:29 -0600512 REPORTER_ASSERT(r, effect && err.isEmpty());
Brian Osmancdee1202021-04-14 09:36:49 -0400513 sk_sp<SkColorFilter> filter = effect->makeColorFilter(SkData::MakeEmpty());
Mike Kleine0d9b862021-02-16 12:00:29 -0600514 REPORTER_ASSERT(r, filter && filter->isAlphaUnchanged());
515 }
516
517 { // Here's one that definitely changes alpha.
Brian Osman56ed7da2021-04-21 15:57:27 -0400518 auto [effect, err] = SkRuntimeEffect::MakeForColorFilter(SkString{
Brian Osmancdee1202021-04-14 09:36:49 -0400519 "half4 main(half4 color) { return color + half4(0,0,0,4); }"});
Mike Kleine0d9b862021-02-16 12:00:29 -0600520 REPORTER_ASSERT(r, effect && err.isEmpty());
Brian Osmancdee1202021-04-14 09:36:49 -0400521 sk_sp<SkColorFilter> filter = effect->makeColorFilter(SkData::MakeEmpty());
Mike Kleine0d9b862021-02-16 12:00:29 -0600522 REPORTER_ASSERT(r, filter && !filter->isAlphaUnchanged());
523 }
524}
Brian Osman4d571112021-04-27 09:10:10 -0400525
526DEF_TEST(SkRuntimeShaderSampleUsage, r) {
527 auto test = [&](const char* src, bool expectExplicit) {
528 auto [effect, err] =
529 SkRuntimeEffect::MakeForShader(SkStringPrintf("uniform shader child; %s", src));
530 REPORTER_ASSERT(r, effect);
531
532 auto child = GrFragmentProcessor::MakeColor({ 1, 1, 1, 1 });
533 auto fp = effect->makeFP(nullptr, &child, 1);
534 REPORTER_ASSERT(r, fp);
535
536 REPORTER_ASSERT(r, fp->childProcessor(0)->isSampledWithExplicitCoords() == expectExplicit);
537 };
538
539 // This test verifies that we detect calls to sample where the coords are the same as those
540 // passed to main. In those cases, it's safe to turn the "explicit" sampling into "passthrough"
541 // sampling. This optimization is implemented very conservatively.
542
543 // Cases where our optimization is valid, and works:
544
545 // Direct use of passed-in coords
546 test("half4 main(float2 xy) { return sample(child, xy); }", false);
547 // Sample with passed-in coords, read (but don't write) sample coords elsewhere
548 test("half4 main(float2 xy) { return sample(child, xy) + sin(xy.x); }", false);
549
550 // Cases where our optimization is not valid, and does not happen:
551
552 // Sampling with values completely unrelated to passed-in coords
553 test("half4 main(float2 xy) { return sample(child, float2(0, 0)); }", true);
554 // Use of expression involving passed in coords
555 test("half4 main(float2 xy) { return sample(child, xy * 0.5); }", true);
556 // Use of coords after modification
557 test("half4 main(float2 xy) { xy *= 2; return sample(child, xy); }", true);
558 // Use of coords after modification via out-param call
559 test("void adjust(inout float2 xy) { xy *= 2; }"
560 "half4 main(float2 xy) { adjust(xy); return sample(child, xy); }", true);
561
562 // There should (must) not be any false-positive cases. There are false-negatives.
563 // In all of these cases, our optimization would be valid, but does not happen:
564
565 // Direct use of passed-in coords, modified after use
566 test("half4 main(float2 xy) { half4 c = sample(child, xy); xy *= 2; return c; }", true);
567 // Passed-in coords copied to a temp variable
568 test("half4 main(float2 xy) { float2 p = xy; return sample(child, p); }", true);
569 // Use of coords passed to helper function
570 test("half4 helper(float2 xy) { return sample(child, xy); }"
571 "half4 main(float2 xy) { return helper(xy); }", true);
572}