blob: 47d54496a388e4ff40f28f0d7ffa8b13d92c8048 [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
Brian Osman92aac1e2020-08-05 16:48:58 -040078DEF_TEST(SkRuntimeEffectInvalidColorFilters, r) {
79 auto test = [r](const char* sksl) {
Brian Osman4f009822021-04-28 09:41:06 -040080 auto effect = SkMakeCachedRuntimeEffect(sksl);
Brian Osman92aac1e2020-08-05 16:48:58 -040081 REPORTER_ASSERT(r, effect);
Brian Osman269b21c2020-08-06 12:15:53 -040082
Brian Osmana4b91692020-08-10 14:26:16 -040083 sk_sp<SkData> uniforms = SkData::MakeUninitialized(effect->uniformSize());
Brian Osman269b21c2020-08-06 12:15:53 -040084
Brian Osmana4b91692020-08-10 14:26:16 -040085 REPORTER_ASSERT(r, effect->makeShader(uniforms, nullptr, 0, nullptr, false));
86 REPORTER_ASSERT(r, !effect->makeColorFilter(uniforms));
Brian Osman92aac1e2020-08-05 16:48:58 -040087 };
88
89 // Runtime effects that use sample coords or sk_FragCoord are valid shaders,
90 // but not valid color filters
Brian Osman767f4442020-08-13 16:59:48 -040091 test("half4 main(float2 p) { return half2(p).xy01; }");
92 test("half4 main(float2 p) { return half2(sk_FragCoord.xy).xy01; }");
Brian Osman92aac1e2020-08-05 16:48:58 -040093}
94
Brian Osmanaf4e2332021-04-20 12:00:10 -040095DEF_TEST(SkRuntimeEffectForColorFilter, r) {
96 // Tests that the color filter factory rejects or accepts certain SkSL constructs
97 auto test_valid = [r](const char* sksl) {
98 auto [effect, errorText] = SkRuntimeEffect::MakeForColorFilter(SkString(sksl));
99 REPORTER_ASSERT(r, effect, errorText.c_str());
100 };
101
102 auto test_invalid = [r](const char* sksl, const char* expected) {
103 auto [effect, errorText] = SkRuntimeEffect::MakeForColorFilter(SkString(sksl));
104 REPORTER_ASSERT(r, !effect);
105 REPORTER_ASSERT(r,
106 errorText.contains(expected),
107 "Expected error message to contain \"%s\". Actual message: \"%s\"",
108 expected,
109 errorText.c_str());
110 };
111
112 // Color filters must use the 'half4 main(half4)' signature. Either color can be float4/vec4
113 test_valid("half4 main(half4 c) { return c; }");
114 test_valid("float4 main(half4 c) { return c; }");
115 test_valid("half4 main(float4 c) { return c; }");
116 test_valid("float4 main(float4 c) { return c; }");
117 test_valid("vec4 main(half4 c) { return c; }");
118 test_valid("half4 main(vec4 c) { return c; }");
119 test_valid("vec4 main(vec4 c) { return c; }");
120
121 // Invalid return types
122 test_invalid("void main(half4 c) {}", "'main' must return");
123 test_invalid("half3 main(half4 c) { return c.rgb; }", "'main' must return");
124
125 // Invalid argument types (some are valid as shaders, but not color filters)
126 test_invalid("half4 main() { return half4(1); }", "'main' parameter");
127 test_invalid("half4 main(float2 p) { return half4(1); }", "'main' parameter");
128 test_invalid("half4 main(float2 p, half4 c) { return c; }", "'main' parameter");
129
130 // sk_FragCoord should not be available
131 test_invalid("half4 main(half4 c) { return sk_FragCoord.xy01; }", "unknown identifier");
132
133 // Sampling a child shader requires that we pass explicit coords
134 test_valid("uniform shader child;"
135 "half4 main(half4 c) { return sample(child, c.rg); }");
136
137 test_invalid(
138 "uniform shader child;"
139 "half4 main(half4 c) { return sample(child); }",
140 "expected 2 arguments");
141 test_invalid(
142 "uniform shader child;"
143 "half4 main(half4 c) { return sample(child, float3x3(1)); }",
144 "expected 'float2'");
145}
146
147DEF_TEST(SkRuntimeEffectForShader, r) {
148 // Tests that the shader factory rejects or accepts certain SkSL constructs
149 auto test_valid = [r](const char* sksl) {
150 auto [effect, errorText] = SkRuntimeEffect::MakeForShader(SkString(sksl));
151 REPORTER_ASSERT(r, effect, errorText.c_str());
152 };
153
154 auto test_invalid = [r](const char* sksl, const char* expected) {
155 auto [effect, errorText] = SkRuntimeEffect::MakeForShader(SkString(sksl));
156 REPORTER_ASSERT(r, !effect);
157 REPORTER_ASSERT(r,
158 errorText.contains(expected),
159 "Expected error message to contain \"%s\". Actual message: \"%s\"",
160 expected,
161 errorText.c_str());
162 };
163
164 // Shaders must use either the 'half4 main(float2)' or 'half4 main(float2, half4)' signature
165 // Either color can be half4/float4/vec4, but the coords must be float2/vec2
166 test_valid("half4 main(float2 p) { return p.xyxy; }");
167 test_valid("float4 main(float2 p) { return p.xyxy; }");
168 test_valid("vec4 main(float2 p) { return p.xyxy; }");
169 test_valid("half4 main(vec2 p) { return p.xyxy; }");
170 test_valid("vec4 main(vec2 p) { return p.xyxy; }");
171 test_valid("half4 main(float2 p, half4 c) { return c; }");
172 test_valid("half4 main(float2 p, float4 c) { return c; }");
173 test_valid("half4 main(float2 p, vec4 c) { return c; }");
174 test_valid("float4 main(float2 p, half4 c) { return c; }");
175 test_valid("vec4 main(float2 p, half4 c) { return c; }");
176 test_valid("vec4 main(vec2 p, vec4 c) { return c; }");
177
178 // Invalid return types
179 test_invalid("void main(float2 p) {}", "'main' must return");
180 test_invalid("half3 main(float2 p) { return p.xy1; }", "'main' must return");
181
182 // Invalid argument types (some are valid as color filters, but not shaders)
183 test_invalid("half4 main() { return half4(1); }", "'main' parameter");
184 test_invalid("half4 main(half4 c) { return c; }", "'main' parameter");
185
186 // sk_FragCoord should be available
187 test_valid("half4 main(float2 p) { return sk_FragCoord.xy01; }");
188
189 // Sampling a child shader requires that we pass explicit coords
190 test_valid("uniform shader child;"
191 "half4 main(float2 p) { return sample(child, p); }");
192
193 test_invalid(
194 "uniform shader child;"
195 "half4 main(float2 p) { return sample(child); }",
196 "expected 2 arguments");
197 test_invalid(
198 "uniform shader child;"
199 "half4 main(float2 p) { return sample(child, float3x3(1)); }",
200 "expected 'float2'");
201}
202
Brian Osmanf72dedd2020-01-08 13:19:58 -0500203class TestEffect {
204public:
Brian Osman62419612020-07-22 10:19:02 -0400205 TestEffect(skiatest::Reporter* r, sk_sp<SkSurface> surface)
206 : fReporter(r), fSurface(std::move(surface)) {}
207
Brian Osman33316412020-11-06 10:42:51 -0500208 void build(const char* src) {
Brian Osman56ed7da2021-04-21 15:57:27 -0400209 auto [effect, errorText] = SkRuntimeEffect::MakeForShader(SkString(src));
Brian Osmanf72dedd2020-01-08 13:19:58 -0500210 if (!effect) {
Brian Osman62419612020-07-22 10:19:02 -0400211 REPORT_FAILURE(fReporter, "effect",
Brian Osmanf72dedd2020-01-08 13:19:58 -0500212 SkStringPrintf("Effect didn't compile: %s", errorText.c_str()));
213 return;
214 }
Brian Osmand9bde072020-04-15 14:18:13 -0400215 fBuilder.init(std::move(effect));
Brian Osmanf72dedd2020-01-08 13:19:58 -0500216 }
217
Brian Osmana4b91692020-08-10 14:26:16 -0400218 SkRuntimeShaderBuilder::BuilderUniform uniform(const char* name) {
219 return fBuilder->uniform(name);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500220 }
Brian Osman62419612020-07-22 10:19:02 -0400221 SkRuntimeShaderBuilder::BuilderChild child(const char* name) {
222 return fBuilder->child(name);
223 }
Brian Osmanf72dedd2020-01-08 13:19:58 -0500224
Brian Osman62419612020-07-22 10:19:02 -0400225 using PreTestFn = std::function<void(SkCanvas*, SkPaint*)>;
226
227 void test(GrColor TL, GrColor TR, GrColor BL, GrColor BR,
228 PreTestFn preTestCallback = nullptr) {
Brian Osmand9bde072020-04-15 14:18:13 -0400229 auto shader = fBuilder->makeShader(nullptr, false);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500230 if (!shader) {
Brian Osman62419612020-07-22 10:19:02 -0400231 REPORT_FAILURE(fReporter, "shader", SkString("Effect didn't produce a shader"));
Brian Osmanf72dedd2020-01-08 13:19:58 -0500232 return;
233 }
234
Brian Osman62419612020-07-22 10:19:02 -0400235 SkCanvas* canvas = fSurface->getCanvas();
Brian Osmanf72dedd2020-01-08 13:19:58 -0500236 SkPaint paint;
237 paint.setShader(std::move(shader));
238 paint.setBlendMode(SkBlendMode::kSrc);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500239
Brian Osman62419612020-07-22 10:19:02 -0400240 canvas->save();
241 if (preTestCallback) {
242 preTestCallback(canvas, &paint);
243 }
244 canvas->drawPaint(paint);
245 canvas->restore();
246
247 GrColor actual[4];
248 SkImageInfo info = fSurface->imageInfo();
249 if (!fSurface->readPixels(info, actual, info.minRowBytes(), 0, 0)) {
250 REPORT_FAILURE(fReporter, "readPixels", SkString("readPixels failed"));
Brian Osmanf72dedd2020-01-08 13:19:58 -0500251 return;
252 }
253
Brian Osman62419612020-07-22 10:19:02 -0400254 GrColor expected[4] = {TL, TR, BL, BR};
John Stilesc1c3c6d2020-08-15 23:22:53 -0400255 if (0 != memcmp(actual, expected, sizeof(actual))) {
Brian Osman62419612020-07-22 10:19:02 -0400256 REPORT_FAILURE(fReporter, "Runtime effect didn't match expectations",
Brian Osmanf72dedd2020-01-08 13:19:58 -0500257 SkStringPrintf("\n"
258 "Expected: [ %08x %08x %08x %08x ]\n"
259 "Got : [ %08x %08x %08x %08x ]\n"
260 "SkSL:\n%s\n",
261 TL, TR, BL, BR, actual[0], actual[1], actual[2],
Brian Osmanb6bd0d22020-08-27 10:51:22 -0400262 actual[3], fBuilder->effect()->source().c_str()));
Brian Osmanf72dedd2020-01-08 13:19:58 -0500263 }
264 }
265
Brian Osman62419612020-07-22 10:19:02 -0400266 void test(GrColor expected, PreTestFn preTestCallback = nullptr) {
267 this->test(expected, expected, expected, expected, preTestCallback);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500268 }
269
270private:
Brian Osman62419612020-07-22 10:19:02 -0400271 skiatest::Reporter* fReporter;
272 sk_sp<SkSurface> fSurface;
Brian Osmand9bde072020-04-15 14:18:13 -0400273 SkTLazy<SkRuntimeShaderBuilder> fBuilder;
Brian Osmanf72dedd2020-01-08 13:19:58 -0500274};
275
Brian Osman62419612020-07-22 10:19:02 -0400276// Produces a 2x2 bitmap shader, with opaque colors:
277// [ Red, Green ]
278// [ Blue, White ]
279static sk_sp<SkShader> make_RGBW_shader() {
280 SkBitmap bmp;
281 bmp.allocPixels(SkImageInfo::Make(2, 2, kRGBA_8888_SkColorType, kPremul_SkAlphaType));
282 SkIRect topLeft = SkIRect::MakeWH(1, 1);
283 bmp.pixmap().erase(SK_ColorRED, topLeft);
284 bmp.pixmap().erase(SK_ColorGREEN, topLeft.makeOffset(1, 0));
285 bmp.pixmap().erase(SK_ColorBLUE, topLeft.makeOffset(0, 1));
286 bmp.pixmap().erase(SK_ColorWHITE, topLeft.makeOffset(1, 1));
Mike Reedb41bd152020-12-12 11:18:31 -0500287 return bmp.makeShader(SkSamplingOptions());
Brian Osman62419612020-07-22 10:19:02 -0400288}
289
Robert Phillipse94b4e12020-07-23 13:54:35 -0400290static void test_RuntimeEffect_Shaders(skiatest::Reporter* r, GrRecordingContext* rContext) {
Brian Osmanf72dedd2020-01-08 13:19:58 -0500291 SkImageInfo info = SkImageInfo::Make(2, 2, kRGBA_8888_SkColorType, kPremul_SkAlphaType);
Robert Phillipse94b4e12020-07-23 13:54:35 -0400292 sk_sp<SkSurface> surface = rContext
293 ? SkSurface::MakeRenderTarget(rContext, SkBudgeted::kNo, info)
294 : SkSurface::MakeRaster(info);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500295 REPORTER_ASSERT(r, surface);
Brian Osman62419612020-07-22 10:19:02 -0400296 TestEffect effect(r, surface);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500297
Brian Osman504032e2020-01-10 10:05:24 -0500298 using float4 = std::array<float, 4>;
Brian Osmand18967c2021-04-01 09:56:07 -0400299 using int4 = std::array<int, 4>;
Brian Osman504032e2020-01-10 10:05:24 -0500300
Brian Osman62419612020-07-22 10:19:02 -0400301 // Local coords
Brian Osman33316412020-11-06 10:42:51 -0500302 effect.build("half4 main(float2 p) { return half4(half2(p - 0.5), 0, 1); }");
Brian Osman62419612020-07-22 10:19:02 -0400303 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500304
Brian Osman62419612020-07-22 10:19:02 -0400305 // Use of a simple uniform. (Draw twice with two values to ensure it's updated).
Brian Osman56ed7da2021-04-21 15:57:27 -0400306 effect.build("uniform float4 gColor; half4 main(float2 p) { return half4(gColor); }");
Brian Osmana4b91692020-08-10 14:26:16 -0400307 effect.uniform("gColor") = float4{ 0.0f, 0.25f, 0.75f, 1.0f };
Brian Osman62419612020-07-22 10:19:02 -0400308 effect.test(0xFFBF4000);
Brian Osmana4b91692020-08-10 14:26:16 -0400309 effect.uniform("gColor") = float4{ 1.0f, 0.0f, 0.0f, 0.498f };
Brian Osman62419612020-07-22 10:19:02 -0400310 effect.test(0x7F00007F); // Tests that we clamp to valid premul
Michael Ludwig5e6b3cd2020-05-27 17:02:37 -0400311
Brian Osmand18967c2021-04-01 09:56:07 -0400312 // Same, with integer uniforms
Brian Osman56ed7da2021-04-21 15:57:27 -0400313 effect.build("uniform int4 gColor; half4 main(float2 p) { return half4(gColor) / 255.0; }");
Brian Osmand18967c2021-04-01 09:56:07 -0400314 effect.uniform("gColor") = int4{ 0x00, 0x40, 0xBF, 0xFF };
315 effect.test(0xFFBF4000);
316 effect.uniform("gColor") = int4{ 0xFF, 0x00, 0x00, 0x7F };
317 effect.test(0x7F00007F); // Tests that we clamp to valid premul
318
Brian Osman62419612020-07-22 10:19:02 -0400319 // Test sk_FragCoord (device coords). Rotate the canvas to be sure we're seeing device coords.
320 // Since the surface is 2x2, we should see (0,0), (1,0), (0,1), (1,1). Multiply by 0.498 to
321 // make sure we're not saturating unexpectedly.
Brian Osman56ed7da2021-04-21 15:57:27 -0400322 effect.build(
323 "half4 main(float2 p) { return half4(0.498 * (half2(sk_FragCoord.xy) - 0.5), 0, 1); }");
Brian Osman62419612020-07-22 10:19:02 -0400324 effect.test(0xFF000000, 0xFF00007F, 0xFF007F00, 0xFF007F7F,
325 [](SkCanvas* canvas, SkPaint*) { canvas->rotate(45.0f); });
Michael Ludwig22534f22020-05-27 17:25:33 -0400326
Brian Osman0acb5b52020-09-02 13:45:47 -0400327 // Runtime effects should use relaxed precision rules by default
Brian Osman33316412020-11-06 10:42:51 -0500328 effect.build("half4 main(float2 p) { return float4(p - 0.5, 0, 1); }");
Brian Osman0acb5b52020-09-02 13:45:47 -0400329 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
330
Brian Osman33316412020-11-06 10:42:51 -0500331 // ... and support *returning* float4 (aka vec4), not just half4
332 effect.build("float4 main(float2 p) { return float4(p - 0.5, 0, 1); }");
333 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
334 effect.build("vec4 main(float2 p) { return float4(p - 0.5, 0, 1); }");
Brian Osmanf1319c32020-10-13 09:34:23 -0400335 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
336
Brian Osmanb4ce9442020-11-11 09:18:02 -0500337 // Mutating coords should work. (skbug.com/10918)
338 effect.build("vec4 main(vec2 p) { p -= 0.5; return vec4(p, 0, 1); }");
339 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
340 effect.build("void moveCoords(inout vec2 p) { p -= 0.5; }"
341 "vec4 main(vec2 p) { moveCoords(p); return vec4(p, 0, 1); }");
342 effect.test(0xFF000000, 0xFF0000FF, 0xFF00FF00, 0xFF00FFFF);
343
Brian Osmanb5f0f522020-07-23 13:28:14 -0400344 //
345 // Sampling children
346 //
347
Brian Osman62419612020-07-22 10:19:02 -0400348 // Sampling a null child should return the paint color
Brian Osman33316412020-11-06 10:42:51 -0500349 effect.build("uniform shader child;"
Brian Osman56ed7da2021-04-21 15:57:27 -0400350 "half4 main(float2 p) { return sample(child, p); }");
Brian Osman62419612020-07-22 10:19:02 -0400351 effect.child("child") = nullptr;
352 effect.test(0xFF00FFFF,
353 [](SkCanvas*, SkPaint* paint) { paint->setColor4f({1.0f, 1.0f, 0.0f, 1.0f}); });
354
355 sk_sp<SkShader> rgbwShader = make_RGBW_shader();
356
Brian Osman56ed7da2021-04-21 15:57:27 -0400357 // Sampling a simple child at our coordinates
Brian Osman33316412020-11-06 10:42:51 -0500358 effect.build("uniform shader child;"
Brian Osman56ed7da2021-04-21 15:57:27 -0400359 "half4 main(float2 p) { return sample(child, p); }");
Brian Osman62419612020-07-22 10:19:02 -0400360 effect.child("child") = rgbwShader;
361 effect.test(0xFF0000FF, 0xFF00FF00, 0xFFFF0000, 0xFFFFFFFF);
362
363 // Sampling with explicit coordinates (reflecting about the diagonal)
Brian Osman33316412020-11-06 10:42:51 -0500364 effect.build("uniform shader child;"
365 "half4 main(float2 p) { return sample(child, p.yx); }");
Brian Osman62419612020-07-22 10:19:02 -0400366 effect.child("child") = rgbwShader;
367 effect.test(0xFF0000FF, 0xFFFF0000, 0xFF00FF00, 0xFFFFFFFF);
368
Brian Osmanb5f0f522020-07-23 13:28:14 -0400369 //
370 // Helper functions
371 //
372
373 // Test case for inlining in the pipeline-stage and fragment-shader passes (skbug.com/10526):
Brian Osman33316412020-11-06 10:42:51 -0500374 effect.build("float2 helper(float2 x) { return x + 1; }"
375 "half4 main(float2 p) { float2 v = helper(p); return half4(half2(v), 0, 1); }");
Brian Osmanb5f0f522020-07-23 13:28:14 -0400376 effect.test(0xFF00FFFF);
Brian Osmanf72dedd2020-01-08 13:19:58 -0500377}
378
379DEF_TEST(SkRuntimeEffectSimple, r) {
380 test_RuntimeEffect_Shaders(r, nullptr);
381}
382
383DEF_GPUTEST_FOR_RENDERING_CONTEXTS(SkRuntimeEffectSimple_GPU, r, ctxInfo) {
Robert Phillips6d344c32020-07-06 10:56:46 -0400384 test_RuntimeEffect_Shaders(r, ctxInfo.directContext());
Brian Osmanf72dedd2020-01-08 13:19:58 -0500385}
Brian Osmanb6bd0d22020-08-27 10:51:22 -0400386
387DEF_TEST(SkRuntimeShaderBuilderReuse, r) {
388 const char* kSource = R"(
389 uniform half x;
Brian Osman56ed7da2021-04-21 15:57:27 -0400390 half4 main(float2 p) { return half4(x); }
Brian Osmanb6bd0d22020-08-27 10:51:22 -0400391 )";
392
Brian Osman56ed7da2021-04-21 15:57:27 -0400393 sk_sp<SkRuntimeEffect> effect = SkRuntimeEffect::MakeForShader(SkString(kSource)).effect;
Brian Osmanb6bd0d22020-08-27 10:51:22 -0400394 REPORTER_ASSERT(r, effect);
395
396 // Test passes if this sequence doesn't assert. skbug.com/10667
397 SkRuntimeShaderBuilder b(std::move(effect));
398 b.uniform("x") = 0.0f;
399 auto shader_0 = b.makeShader(nullptr, false);
400
401 b.uniform("x") = 1.0f;
402 auto shader_1 = b.makeShader(nullptr, true);
403}
Brian Osman8e2ef022020-09-30 13:26:43 -0400404
Derek Sollenberger9e1cedd2021-01-14 08:30:52 -0500405DEF_TEST(SkRuntimeShaderBuilderSetUniforms, r) {
406 const char* kSource = R"(
407 uniform half x;
408 uniform vec2 offset;
Brian Osman56ed7da2021-04-21 15:57:27 -0400409 half4 main(float2 p) { return half4(x); }
Derek Sollenberger9e1cedd2021-01-14 08:30:52 -0500410 )";
411
Brian Osman56ed7da2021-04-21 15:57:27 -0400412 sk_sp<SkRuntimeEffect> effect = SkRuntimeEffect::MakeForShader(SkString(kSource)).effect;
Derek Sollenberger9e1cedd2021-01-14 08:30:52 -0500413 REPORTER_ASSERT(r, effect);
414
415 SkRuntimeShaderBuilder b(std::move(effect));
416
417 // Test passes if this sequence doesn't assert.
418 float x = 1.0f;
419 REPORTER_ASSERT(r, b.uniform("x").set(&x, 1));
420
421 // add extra value to ensure that set doesn't try to use sizeof(array)
422 float origin[] = { 2.0f, 3.0f, 4.0f };
423 REPORTER_ASSERT(r, b.uniform("offset").set<float>(origin, 2));
424
425#ifndef SK_DEBUG
426 REPORTER_ASSERT(r, !b.uniform("offset").set<float>(origin, 1));
427 REPORTER_ASSERT(r, !b.uniform("offset").set<float>(origin, 3));
428#endif
429
430
431 auto shader = b.makeShader(nullptr, false);
432}
433
Brian Osman8e2ef022020-09-30 13:26:43 -0400434DEF_TEST(SkRuntimeEffectThreaded, r) {
435 // SkRuntimeEffect uses a single compiler instance, but it's mutex locked.
436 // This tests that we can safely use it from more than one thread, and also
437 // that programs don't refer to shared structures owned by the compiler.
438 // skbug.com/10589
Brian Osman56ed7da2021-04-21 15:57:27 -0400439 static constexpr char kSource[] = "half4 main(float2 p) { return sk_FragCoord.xyxy; }";
Brian Osman8e2ef022020-09-30 13:26:43 -0400440
441 std::thread threads[16];
442 for (auto& thread : threads) {
443 thread = std::thread([r]() {
Brian Osman56ed7da2021-04-21 15:57:27 -0400444 auto [effect, error] = SkRuntimeEffect::MakeForShader(SkString(kSource));
Brian Osman8e2ef022020-09-30 13:26:43 -0400445 REPORTER_ASSERT(r, effect);
446 });
447 }
448
449 for (auto& thread : threads) {
450 thread.join();
451 }
452}
Mike Klein827f8c02021-02-06 09:13:01 -0600453
454DEF_TEST(SkRuntimeColorFilterSingleColor, r) {
455 // Test runtime colorfilters support filterColor4f().
Brian Osman56ed7da2021-04-21 15:57:27 -0400456 auto [effect, err] =
457 SkRuntimeEffect::MakeForColorFilter(SkString{"half4 main(half4 c) { return c*c; }"});
Mike Klein827f8c02021-02-06 09:13:01 -0600458 REPORTER_ASSERT(r, effect);
459 REPORTER_ASSERT(r, err.isEmpty());
460
Brian Osman56ed7da2021-04-21 15:57:27 -0400461 sk_sp<SkColorFilter> cf = effect->makeColorFilter(SkData::MakeEmpty());
Mike Klein827f8c02021-02-06 09:13:01 -0600462 REPORTER_ASSERT(r, cf);
463
464 SkColor4f c = cf->filterColor4f({0.25, 0.5, 0.75, 1.0},
465 sk_srgb_singleton(), sk_srgb_singleton());
466 REPORTER_ASSERT(r, c.fR == 0.0625f);
467 REPORTER_ASSERT(r, c.fG == 0.25f);
468 REPORTER_ASSERT(r, c.fB == 0.5625f);
469 REPORTER_ASSERT(r, c.fA == 1.0f);
470}
Brian Osman8e756f32021-02-10 10:19:27 -0500471
472static void test_RuntimeEffectStructNameReuse(skiatest::Reporter* r, GrRecordingContext* rContext) {
473 // Test that two different runtime effects can reuse struct names in a single paint operation
Brian Osman56ed7da2021-04-21 15:57:27 -0400474 auto [childEffect, err] = SkRuntimeEffect::MakeForShader(SkString(
Brian Osman8e756f32021-02-10 10:19:27 -0500475 "uniform shader paint;"
476 "struct S { half4 rgba; };"
477 "void process(inout S s) { s.rgba.rgb *= 0.5; }"
Brian Osman56ed7da2021-04-21 15:57:27 -0400478 "half4 main(float2 p) { S s; s.rgba = sample(paint, p); process(s); return s.rgba; }"
Brian Osman8e756f32021-02-10 10:19:27 -0500479 ));
480 REPORTER_ASSERT(r, childEffect, "%s\n", err.c_str());
481 sk_sp<SkShader> nullChild = nullptr;
482 sk_sp<SkShader> child = childEffect->makeShader(/*uniforms=*/nullptr, &nullChild,
483 /*childCount=*/1, /*localMatrix=*/nullptr,
484 /*isOpaque=*/false);
485
486 SkImageInfo info = SkImageInfo::Make(2, 2, kRGBA_8888_SkColorType, kPremul_SkAlphaType);
487 sk_sp<SkSurface> surface = rContext
488 ? SkSurface::MakeRenderTarget(rContext, SkBudgeted::kNo, info)
489 : SkSurface::MakeRaster(info);
490 REPORTER_ASSERT(r, surface);
491
492 TestEffect effect(r, surface);
493 effect.build(
494 "uniform shader child;"
495 "struct S { float2 coord; };"
496 "void process(inout S s) { s.coord = s.coord.yx; }"
497 "half4 main(float2 p) { S s; s.coord = p; process(s); return sample(child, s.coord); "
498 "}");
499 effect.child("child") = child;
500 effect.test(0xFF00407F, [](SkCanvas*, SkPaint* paint) {
501 paint->setColor4f({0.99608f, 0.50196f, 0.0f, 1.0f});
502 });
503}
504
505DEF_TEST(SkRuntimeStructNameReuse, r) {
506 test_RuntimeEffectStructNameReuse(r, nullptr);
507}
508
509DEF_GPUTEST_FOR_RENDERING_CONTEXTS(SkRuntimeStructNameReuse_GPU, r, ctxInfo) {
510 test_RuntimeEffectStructNameReuse(r, ctxInfo.directContext());
511}
Mike Kleine0d9b862021-02-16 12:00:29 -0600512
513DEF_TEST(SkRuntimeColorFilterFlags, r) {
514 { // Here's a non-trivial filter that doesn't change alpha.
Brian Osman56ed7da2021-04-21 15:57:27 -0400515 auto [effect, err] = SkRuntimeEffect::MakeForColorFilter(SkString{
Brian Osmancdee1202021-04-14 09:36:49 -0400516 "half4 main(half4 color) { return color + half4(1,1,1,0); }"});
Mike Kleine0d9b862021-02-16 12:00:29 -0600517 REPORTER_ASSERT(r, effect && err.isEmpty());
Brian Osmancdee1202021-04-14 09:36:49 -0400518 sk_sp<SkColorFilter> filter = effect->makeColorFilter(SkData::MakeEmpty());
Mike Kleine0d9b862021-02-16 12:00:29 -0600519 REPORTER_ASSERT(r, filter && filter->isAlphaUnchanged());
520 }
521
522 { // Here's one that definitely changes alpha.
Brian Osman56ed7da2021-04-21 15:57:27 -0400523 auto [effect, err] = SkRuntimeEffect::MakeForColorFilter(SkString{
Brian Osmancdee1202021-04-14 09:36:49 -0400524 "half4 main(half4 color) { return color + half4(0,0,0,4); }"});
Mike Kleine0d9b862021-02-16 12:00:29 -0600525 REPORTER_ASSERT(r, effect && err.isEmpty());
Brian Osmancdee1202021-04-14 09:36:49 -0400526 sk_sp<SkColorFilter> filter = effect->makeColorFilter(SkData::MakeEmpty());
Mike Kleine0d9b862021-02-16 12:00:29 -0600527 REPORTER_ASSERT(r, filter && !filter->isAlphaUnchanged());
528 }
529}
Brian Osman4d571112021-04-27 09:10:10 -0400530
531DEF_TEST(SkRuntimeShaderSampleUsage, r) {
532 auto test = [&](const char* src, bool expectExplicit) {
533 auto [effect, err] =
534 SkRuntimeEffect::MakeForShader(SkStringPrintf("uniform shader child; %s", src));
535 REPORTER_ASSERT(r, effect);
536
537 auto child = GrFragmentProcessor::MakeColor({ 1, 1, 1, 1 });
538 auto fp = effect->makeFP(nullptr, &child, 1);
539 REPORTER_ASSERT(r, fp);
540
541 REPORTER_ASSERT(r, fp->childProcessor(0)->isSampledWithExplicitCoords() == expectExplicit);
542 };
543
544 // This test verifies that we detect calls to sample where the coords are the same as those
545 // passed to main. In those cases, it's safe to turn the "explicit" sampling into "passthrough"
546 // sampling. This optimization is implemented very conservatively.
547
548 // Cases where our optimization is valid, and works:
549
550 // Direct use of passed-in coords
551 test("half4 main(float2 xy) { return sample(child, xy); }", false);
552 // Sample with passed-in coords, read (but don't write) sample coords elsewhere
553 test("half4 main(float2 xy) { return sample(child, xy) + sin(xy.x); }", false);
554
555 // Cases where our optimization is not valid, and does not happen:
556
557 // Sampling with values completely unrelated to passed-in coords
558 test("half4 main(float2 xy) { return sample(child, float2(0, 0)); }", true);
559 // Use of expression involving passed in coords
560 test("half4 main(float2 xy) { return sample(child, xy * 0.5); }", true);
561 // Use of coords after modification
562 test("half4 main(float2 xy) { xy *= 2; return sample(child, xy); }", true);
563 // Use of coords after modification via out-param call
564 test("void adjust(inout float2 xy) { xy *= 2; }"
565 "half4 main(float2 xy) { adjust(xy); return sample(child, xy); }", true);
566
567 // There should (must) not be any false-positive cases. There are false-negatives.
568 // In all of these cases, our optimization would be valid, but does not happen:
569
570 // Direct use of passed-in coords, modified after use
571 test("half4 main(float2 xy) { half4 c = sample(child, xy); xy *= 2; return c; }", true);
572 // Passed-in coords copied to a temp variable
573 test("half4 main(float2 xy) { float2 p = xy; return sample(child, p); }", true);
574 // Use of coords passed to helper function
575 test("half4 helper(float2 xy) { return sample(child, xy); }"
576 "half4 main(float2 xy) { return helper(xy); }", true);
577}