blob: bbd833b6bb513643ff337e0b82a838175b5617c5 [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@google.combdee9fc2011-02-22 20:17:43 +00008#include "Test.h"
bsalomon@google.coma4e13c82012-11-26 21:38:37 +00009#if SK_SUPPORT_GPU
10 #include "GrClipMaskManager.h"
11#endif
reed@google.combdee9fc2011-02-22 20:17:43 +000012#include "SkClipStack.h"
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000013#include "SkPath.h"
bsalomon@google.com51a62862012-11-26 21:19:43 +000014#include "SkRandom.h"
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000015#include "SkRect.h"
bsalomon@google.com51a62862012-11-26 21:19:43 +000016#include "SkRegion.h"
robertphillips@google.com80214e22012-07-20 15:33:18 +000017
18
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000019static void test_assign_and_comparison(skiatest::Reporter* reporter) {
20 SkClipStack s;
reed@google.comd9f2dea2011-10-12 14:43:27 +000021 bool doAA = false;
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000022
robertphillips@google.com80214e22012-07-20 15:33:18 +000023 REPORTER_ASSERT(reporter, 0 == s.getSaveCount());
24
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000025 // Build up a clip stack with a path, an empty clip, and a rect.
26 s.save();
robertphillips@google.com80214e22012-07-20 15:33:18 +000027 REPORTER_ASSERT(reporter, 1 == s.getSaveCount());
28
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000029 SkPath p;
30 p.moveTo(5, 6);
31 p.lineTo(7, 8);
32 p.lineTo(5, 9);
33 p.close();
reed@google.comd9f2dea2011-10-12 14:43:27 +000034 s.clipDevPath(p, SkRegion::kIntersect_Op, doAA);
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000035
36 s.save();
robertphillips@google.com80214e22012-07-20 15:33:18 +000037 REPORTER_ASSERT(reporter, 2 == s.getSaveCount());
38
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000039 SkRect r = SkRect::MakeLTRB(1, 2, 3, 4);
reed@google.comd9f2dea2011-10-12 14:43:27 +000040 s.clipDevRect(r, SkRegion::kIntersect_Op, doAA);
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000041 r = SkRect::MakeLTRB(10, 11, 12, 13);
reed@google.comd9f2dea2011-10-12 14:43:27 +000042 s.clipDevRect(r, SkRegion::kIntersect_Op, doAA);
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000043
44 s.save();
robertphillips@google.com80214e22012-07-20 15:33:18 +000045 REPORTER_ASSERT(reporter, 3 == s.getSaveCount());
46
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000047 r = SkRect::MakeLTRB(14, 15, 16, 17);
reed@google.comd9f2dea2011-10-12 14:43:27 +000048 s.clipDevRect(r, SkRegion::kUnion_Op, doAA);
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000049
50 // Test that assignment works.
51 SkClipStack copy = s;
52 REPORTER_ASSERT(reporter, s == copy);
53
54 // Test that different save levels triggers not equal.
55 s.restore();
robertphillips@google.com80214e22012-07-20 15:33:18 +000056 REPORTER_ASSERT(reporter, 2 == s.getSaveCount());
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000057 REPORTER_ASSERT(reporter, s != copy);
58
59 // Test that an equal, but not copied version is equal.
60 s.save();
robertphillips@google.com80214e22012-07-20 15:33:18 +000061 REPORTER_ASSERT(reporter, 3 == s.getSaveCount());
62
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000063 r = SkRect::MakeLTRB(14, 15, 16, 17);
reed@google.comd9f2dea2011-10-12 14:43:27 +000064 s.clipDevRect(r, SkRegion::kUnion_Op, doAA);
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000065 REPORTER_ASSERT(reporter, s == copy);
66
67 // Test that a different op on one level triggers not equal.
68 s.restore();
robertphillips@google.com80214e22012-07-20 15:33:18 +000069 REPORTER_ASSERT(reporter, 2 == s.getSaveCount());
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000070 s.save();
robertphillips@google.com80214e22012-07-20 15:33:18 +000071 REPORTER_ASSERT(reporter, 3 == s.getSaveCount());
72
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000073 r = SkRect::MakeLTRB(14, 15, 16, 17);
reed@google.comd9f2dea2011-10-12 14:43:27 +000074 s.clipDevRect(r, SkRegion::kIntersect_Op, doAA);
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000075 REPORTER_ASSERT(reporter, s != copy);
76
77 // Test that different state (clip type) triggers not equal.
tomhudson@google.com4c433722012-03-09 16:48:20 +000078 // NO LONGER VALID: if a path contains only a rect, we turn
79 // it into a bare rect for performance reasons (working
80 // around Chromium/JavaScript bad pattern).
81/*
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000082 s.restore();
83 s.save();
84 SkPath rp;
85 rp.addRect(r);
reed@google.comd9f2dea2011-10-12 14:43:27 +000086 s.clipDevPath(rp, SkRegion::kUnion_Op, doAA);
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000087 REPORTER_ASSERT(reporter, s != copy);
tomhudson@google.com4c433722012-03-09 16:48:20 +000088*/
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000089
90 // Test that different rects triggers not equal.
91 s.restore();
robertphillips@google.com80214e22012-07-20 15:33:18 +000092 REPORTER_ASSERT(reporter, 2 == s.getSaveCount());
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000093 s.save();
robertphillips@google.com80214e22012-07-20 15:33:18 +000094 REPORTER_ASSERT(reporter, 3 == s.getSaveCount());
95
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000096 r = SkRect::MakeLTRB(24, 25, 26, 27);
reed@google.comd9f2dea2011-10-12 14:43:27 +000097 s.clipDevRect(r, SkRegion::kUnion_Op, doAA);
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +000098 REPORTER_ASSERT(reporter, s != copy);
99
100 // Sanity check
101 s.restore();
robertphillips@google.com80214e22012-07-20 15:33:18 +0000102 REPORTER_ASSERT(reporter, 2 == s.getSaveCount());
103
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +0000104 copy.restore();
robertphillips@google.com80214e22012-07-20 15:33:18 +0000105 REPORTER_ASSERT(reporter, 2 == copy.getSaveCount());
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +0000106 REPORTER_ASSERT(reporter, s == copy);
107 s.restore();
robertphillips@google.com80214e22012-07-20 15:33:18 +0000108 REPORTER_ASSERT(reporter, 1 == s.getSaveCount());
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +0000109 copy.restore();
robertphillips@google.com80214e22012-07-20 15:33:18 +0000110 REPORTER_ASSERT(reporter, 1 == copy.getSaveCount());
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +0000111 REPORTER_ASSERT(reporter, s == copy);
112
113 // Test that different paths triggers not equal.
114 s.restore();
robertphillips@google.com80214e22012-07-20 15:33:18 +0000115 REPORTER_ASSERT(reporter, 0 == s.getSaveCount());
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +0000116 s.save();
robertphillips@google.com80214e22012-07-20 15:33:18 +0000117 REPORTER_ASSERT(reporter, 1 == s.getSaveCount());
118
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +0000119 p.addRect(r);
reed@google.comd9f2dea2011-10-12 14:43:27 +0000120 s.clipDevPath(p, SkRegion::kIntersect_Op, doAA);
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +0000121 REPORTER_ASSERT(reporter, s != copy);
122}
reed@google.combdee9fc2011-02-22 20:17:43 +0000123
124static void assert_count(skiatest::Reporter* reporter, const SkClipStack& stack,
125 int count) {
robertphillips@google.com80214e22012-07-20 15:33:18 +0000126 SkClipStack::B2TIter iter(stack);
reed@google.combdee9fc2011-02-22 20:17:43 +0000127 int counter = 0;
128 while (iter.next()) {
129 counter += 1;
130 }
131 REPORTER_ASSERT(reporter, count == counter);
132}
133
robertphillips@google.com08eacc12012-08-02 12:49:00 +0000134// Exercise the SkClipStack's bottom to top and bidirectional iterators
135// (including the skipToTopmost functionality)
robertphillips@google.com80214e22012-07-20 15:33:18 +0000136static void test_iterators(skiatest::Reporter* reporter) {
137 SkClipStack stack;
138
139 static const SkRect gRects[] = {
140 { 0, 0, 40, 40 },
141 { 60, 0, 100, 40 },
142 { 0, 60, 40, 100 },
143 { 60, 60, 100, 100 }
144 };
145
146 for (size_t i = 0; i < SK_ARRAY_COUNT(gRects); i++) {
147 // the union op will prevent these from being fused together
148 stack.clipDevRect(gRects[i], SkRegion::kUnion_Op, false);
149 }
150
151 assert_count(reporter, stack, 4);
152
153 // bottom to top iteration
154 {
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000155 const SkClipStack::Element* element = NULL;
robertphillips@google.com80214e22012-07-20 15:33:18 +0000156
157 SkClipStack::B2TIter iter(stack);
158 int i;
159
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000160 for (i = 0, element = iter.next(); element; ++i, element = iter.next()) {
161 REPORTER_ASSERT(reporter, SkClipStack::Element::kRect_Type == element->getType());
162 REPORTER_ASSERT(reporter, element->getRect() == gRects[i]);
robertphillips@google.com80214e22012-07-20 15:33:18 +0000163 }
164
165 SkASSERT(i == 4);
166 }
167
168 // top to bottom iteration
169 {
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000170 const SkClipStack::Element* element = NULL;
robertphillips@google.com80214e22012-07-20 15:33:18 +0000171
172 SkClipStack::Iter iter(stack, SkClipStack::Iter::kTop_IterStart);
173 int i;
174
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000175 for (i = 3, element = iter.prev(); element; --i, element = iter.prev()) {
176 REPORTER_ASSERT(reporter, SkClipStack::Element::kRect_Type == element->getType());
177 REPORTER_ASSERT(reporter, element->getRect() == gRects[i]);
robertphillips@google.com80214e22012-07-20 15:33:18 +0000178 }
179
180 SkASSERT(i == -1);
181 }
182
183 // skipToTopmost
184 {
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000185 const SkClipStack::Element* element = NULL;
robertphillips@google.com80214e22012-07-20 15:33:18 +0000186
187 SkClipStack::Iter iter(stack, SkClipStack::Iter::kBottom_IterStart);
188
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000189 element = iter.skipToTopmost(SkRegion::kUnion_Op);
190 REPORTER_ASSERT(reporter, SkClipStack::Element::kRect_Type == element->getType());
191 REPORTER_ASSERT(reporter, element->getRect() == gRects[3]);
robertphillips@google.com80214e22012-07-20 15:33:18 +0000192 }
193}
194
robertphillips@google.com08eacc12012-08-02 12:49:00 +0000195// Exercise the SkClipStack's getConservativeBounds computation
robertphillips@google.com4c2a2f72012-07-24 22:07:50 +0000196static void test_bounds(skiatest::Reporter* reporter, bool useRects) {
robertphillips@google.com607fe072012-07-24 13:54:00 +0000197
198 static const int gNumCases = 20;
199 static const SkRect gAnswerRectsBW[gNumCases] = {
200 // A op B
201 { 40, 40, 50, 50 },
202 { 10, 10, 50, 50 },
203 { 10, 10, 80, 80 },
204 { 10, 10, 80, 80 },
205 { 40, 40, 80, 80 },
206
207 // invA op B
208 { 40, 40, 80, 80 },
209 { 0, 0, 100, 100 },
210 { 0, 0, 100, 100 },
211 { 0, 0, 100, 100 },
212 { 40, 40, 50, 50 },
213
214 // A op invB
215 { 10, 10, 50, 50 },
216 { 40, 40, 50, 50 },
217 { 0, 0, 100, 100 },
218 { 0, 0, 100, 100 },
219 { 0, 0, 100, 100 },
220
221 // invA op invB
222 { 0, 0, 100, 100 },
223 { 40, 40, 80, 80 },
224 { 0, 0, 100, 100 },
225 { 10, 10, 80, 80 },
226 { 10, 10, 50, 50 },
227 };
228
229 static const SkRegion::Op gOps[] = {
230 SkRegion::kIntersect_Op,
231 SkRegion::kDifference_Op,
232 SkRegion::kUnion_Op,
233 SkRegion::kXOR_Op,
234 SkRegion::kReverseDifference_Op
235 };
236
237 SkRect rectA, rectB;
238
239 rectA.iset(10, 10, 50, 50);
240 rectB.iset(40, 40, 80, 80);
241
242 SkPath clipA, clipB;
243
244 clipA.addRoundRect(rectA, SkIntToScalar(5), SkIntToScalar(5));
245 clipB.addRoundRect(rectB, SkIntToScalar(5), SkIntToScalar(5));
246
247 SkClipStack stack;
robertphillips@google.com7b112892012-07-31 15:18:21 +0000248 SkRect devClipBound;
robertphillips@google.com4c2a2f72012-07-24 22:07:50 +0000249 bool isIntersectionOfRects = false;
robertphillips@google.com607fe072012-07-24 13:54:00 +0000250
251 int testCase = 0;
robertphillips@google.com4c2a2f72012-07-24 22:07:50 +0000252 int numBitTests = useRects ? 1 : 4;
253 for (int invBits = 0; invBits < numBitTests; ++invBits) {
robertphillips@google.com607fe072012-07-24 13:54:00 +0000254 for (size_t op = 0; op < SK_ARRAY_COUNT(gOps); ++op) {
255
256 stack.save();
257 bool doInvA = SkToBool(invBits & 1);
258 bool doInvB = SkToBool(invBits & 2);
259
260 clipA.setFillType(doInvA ? SkPath::kInverseEvenOdd_FillType :
261 SkPath::kEvenOdd_FillType);
262 clipB.setFillType(doInvB ? SkPath::kInverseEvenOdd_FillType :
263 SkPath::kEvenOdd_FillType);
264
robertphillips@google.com4c2a2f72012-07-24 22:07:50 +0000265 if (useRects) {
266 stack.clipDevRect(rectA, SkRegion::kIntersect_Op, false);
267 stack.clipDevRect(rectB, gOps[op], false);
268 } else {
269 stack.clipDevPath(clipA, SkRegion::kIntersect_Op, false);
270 stack.clipDevPath(clipB, gOps[op], false);
271 }
robertphillips@google.com607fe072012-07-24 13:54:00 +0000272
robertphillips@google.comcc6493b2012-07-26 18:39:13 +0000273 REPORTER_ASSERT(reporter, !stack.isWideOpen());
274
robertphillips@google.com7b112892012-07-31 15:18:21 +0000275 stack.getConservativeBounds(0, 0, 100, 100, &devClipBound,
robertphillips@google.com4c2a2f72012-07-24 22:07:50 +0000276 &isIntersectionOfRects);
277
278 if (useRects) {
rmistry@google.comd6176b02012-08-23 18:14:13 +0000279 REPORTER_ASSERT(reporter, isIntersectionOfRects ==
robertphillips@google.com4c2a2f72012-07-24 22:07:50 +0000280 (gOps[op] == SkRegion::kIntersect_Op));
281 } else {
282 REPORTER_ASSERT(reporter, !isIntersectionOfRects);
283 }
robertphillips@google.com607fe072012-07-24 13:54:00 +0000284
285 SkASSERT(testCase < gNumCases);
robertphillips@google.com7b112892012-07-31 15:18:21 +0000286 REPORTER_ASSERT(reporter, devClipBound == gAnswerRectsBW[testCase]);
robertphillips@google.com607fe072012-07-24 13:54:00 +0000287 ++testCase;
288
289 stack.restore();
290 }
291 }
292}
293
robertphillips@google.comcc6493b2012-07-26 18:39:13 +0000294// Test out 'isWideOpen' entry point
295static void test_isWideOpen(skiatest::Reporter* reporter) {
296
297 SkRect rectA, rectB;
298
299 rectA.iset(10, 10, 40, 40);
300 rectB.iset(50, 50, 80, 80);
301
302 // Stack should initially be wide open
303 {
304 SkClipStack stack;
305
306 REPORTER_ASSERT(reporter, stack.isWideOpen());
307 }
308
309 // Test out case where the user specifies a union that includes everything
310 {
311 SkClipStack stack;
312
313 SkPath clipA, clipB;
314
315 clipA.addRoundRect(rectA, SkIntToScalar(5), SkIntToScalar(5));
316 clipA.setFillType(SkPath::kInverseEvenOdd_FillType);
317
318 clipB.addRoundRect(rectB, SkIntToScalar(5), SkIntToScalar(5));
319 clipB.setFillType(SkPath::kInverseEvenOdd_FillType);
320
321 stack.clipDevPath(clipA, SkRegion::kReplace_Op, false);
322 stack.clipDevPath(clipB, SkRegion::kUnion_Op, false);
323
324 REPORTER_ASSERT(reporter, stack.isWideOpen());
325 }
326
327 // Test out union w/ a wide open clip
328 {
329 SkClipStack stack;
330
331 stack.clipDevRect(rectA, SkRegion::kUnion_Op, false);
332
333 REPORTER_ASSERT(reporter, stack.isWideOpen());
334 }
335
336 // Test out empty difference from a wide open clip
337 {
338 SkClipStack stack;
339
340 SkRect emptyRect;
341 emptyRect.setEmpty();
342
343 stack.clipDevRect(emptyRect, SkRegion::kDifference_Op, false);
344
345 REPORTER_ASSERT(reporter, stack.isWideOpen());
346 }
347
348 // Test out return to wide open
349 {
350 SkClipStack stack;
351
352 stack.save();
353
354 stack.clipDevRect(rectA, SkRegion::kReplace_Op, false);
355
356 REPORTER_ASSERT(reporter, !stack.isWideOpen());
357
358 stack.restore();
359
360 REPORTER_ASSERT(reporter, stack.isWideOpen());
361 }
362}
363
bsalomon@google.com100abf42012-09-05 17:40:04 +0000364static int count(const SkClipStack& stack) {
robertphillips@google.com08eacc12012-08-02 12:49:00 +0000365
366 SkClipStack::Iter iter(stack, SkClipStack::Iter::kTop_IterStart);
367
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000368 const SkClipStack::Element* element = NULL;
robertphillips@google.com08eacc12012-08-02 12:49:00 +0000369 int count = 0;
370
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000371 for (element = iter.prev(); element; element = iter.prev(), ++count) {
robertphillips@google.com08eacc12012-08-02 12:49:00 +0000372 ;
373 }
374
375 return count;
376}
377
378// Test out SkClipStack's merging of rect clips. In particular exercise
379// merging of aa vs. bw rects.
380static void test_rect_merging(skiatest::Reporter* reporter) {
381
382 SkRect overlapLeft = SkRect::MakeLTRB(10, 10, 50, 50);
383 SkRect overlapRight = SkRect::MakeLTRB(40, 40, 80, 80);
384
385 SkRect nestedParent = SkRect::MakeLTRB(10, 10, 90, 90);
386 SkRect nestedChild = SkRect::MakeLTRB(40, 40, 60, 60);
387
388 SkRect bound;
389 SkClipStack::BoundsType type;
390 bool isIntersectionOfRects;
391
392 // all bw overlapping - should merge
393 {
394 SkClipStack stack;
395
396 stack.clipDevRect(overlapLeft, SkRegion::kReplace_Op, false);
397
398 stack.clipDevRect(overlapRight, SkRegion::kIntersect_Op, false);
399
400 REPORTER_ASSERT(reporter, 1 == count(stack));
401
402 stack.getBounds(&bound, &type, &isIntersectionOfRects);
403
404 REPORTER_ASSERT(reporter, isIntersectionOfRects);
405 }
406
407 // all aa overlapping - should merge
408 {
409 SkClipStack stack;
410
411 stack.clipDevRect(overlapLeft, SkRegion::kReplace_Op, true);
412
413 stack.clipDevRect(overlapRight, SkRegion::kIntersect_Op, true);
414
415 REPORTER_ASSERT(reporter, 1 == count(stack));
416
417 stack.getBounds(&bound, &type, &isIntersectionOfRects);
418
419 REPORTER_ASSERT(reporter, isIntersectionOfRects);
420 }
421
422 // mixed overlapping - should _not_ merge
423 {
424 SkClipStack stack;
425
426 stack.clipDevRect(overlapLeft, SkRegion::kReplace_Op, true);
427
428 stack.clipDevRect(overlapRight, SkRegion::kIntersect_Op, false);
429
430 REPORTER_ASSERT(reporter, 2 == count(stack));
431
432 stack.getBounds(&bound, &type, &isIntersectionOfRects);
433
434 REPORTER_ASSERT(reporter, !isIntersectionOfRects);
435 }
436
437 // mixed nested (bw inside aa) - should merge
438 {
439 SkClipStack stack;
440
441 stack.clipDevRect(nestedParent, SkRegion::kReplace_Op, true);
442
443 stack.clipDevRect(nestedChild, SkRegion::kIntersect_Op, false);
444
445 REPORTER_ASSERT(reporter, 1 == count(stack));
446
447 stack.getBounds(&bound, &type, &isIntersectionOfRects);
448
449 REPORTER_ASSERT(reporter, isIntersectionOfRects);
450 }
451
452 // mixed nested (aa inside bw) - should merge
453 {
454 SkClipStack stack;
455
456 stack.clipDevRect(nestedParent, SkRegion::kReplace_Op, false);
457
458 stack.clipDevRect(nestedChild, SkRegion::kIntersect_Op, true);
459
460 REPORTER_ASSERT(reporter, 1 == count(stack));
461
462 stack.getBounds(&bound, &type, &isIntersectionOfRects);
463
464 REPORTER_ASSERT(reporter, isIntersectionOfRects);
465 }
466
467 // reverse nested (aa inside bw) - should _not_ merge
468 {
469 SkClipStack stack;
470
471 stack.clipDevRect(nestedChild, SkRegion::kReplace_Op, false);
472
473 stack.clipDevRect(nestedParent, SkRegion::kIntersect_Op, true);
474
475 REPORTER_ASSERT(reporter, 2 == count(stack));
476
477 stack.getBounds(&bound, &type, &isIntersectionOfRects);
478
479 REPORTER_ASSERT(reporter, !isIntersectionOfRects);
480 }
481}
robertphillips@google.comcc6493b2012-07-26 18:39:13 +0000482
bsalomon@google.com51a62862012-11-26 21:19:43 +0000483///////////////////////////////////////////////////////////////////////////////////////////////////
484
bsalomon@google.coma4e13c82012-11-26 21:38:37 +0000485#if SK_SUPPORT_GPU
bsalomon@google.com705e8402012-11-27 15:43:57 +0000486// Functions that add a shape to the clip stack. The shape is computed from a rectangle.
487// AA is always disabled since the clip stack reducer can cause changes in aa rasterization of the
488// stack. A fractional edge repeated in different elements may be rasterized fewer times using the
489// reduced stack.
490typedef void (*AddElementFunc) (const SkRect& rect,
491 bool invert,
492 SkRegion::Op op,
493 SkClipStack* stack);
bsalomon@google.coma4e13c82012-11-26 21:38:37 +0000494
bsalomon@google.com705e8402012-11-27 15:43:57 +0000495static void add_round_rect(const SkRect& rect, bool invert, SkRegion::Op op, SkClipStack* stack) {
bsalomon@google.com51a62862012-11-26 21:19:43 +0000496 SkPath path;
497 SkScalar rx = rect.width() / 10;
bsalomon@google.com705e8402012-11-27 15:43:57 +0000498 SkScalar ry = rect.height() / 20;
bsalomon@google.com51a62862012-11-26 21:19:43 +0000499 path.addRoundRect(rect, rx, ry);
bsalomon@google.com705e8402012-11-27 15:43:57 +0000500 if (invert) {
501 path.setFillType(SkPath::kInverseWinding_FillType);
502 }
503 stack->clipDevPath(path, op, false);
bsalomon@google.com51a62862012-11-26 21:19:43 +0000504};
505
bsalomon@google.com705e8402012-11-27 15:43:57 +0000506static void add_rect(const SkRect& rect, bool invert, SkRegion::Op op, SkClipStack* stack) {
507 if (invert) {
508 SkPath path;
509 path.addRect(rect);
510 path.setFillType(SkPath::kInverseWinding_FillType);
511 stack->clipDevPath(path, op, false);
512 } else {
513 stack->clipDevRect(rect, op, false);
514 }
bsalomon@google.com51a62862012-11-26 21:19:43 +0000515};
516
bsalomon@google.com705e8402012-11-27 15:43:57 +0000517static void add_oval(const SkRect& rect, bool invert, SkRegion::Op op, SkClipStack* stack) {
bsalomon@google.com51a62862012-11-26 21:19:43 +0000518 SkPath path;
519 path.addOval(rect);
bsalomon@google.com705e8402012-11-27 15:43:57 +0000520 if (invert) {
521 path.setFillType(SkPath::kInverseWinding_FillType);
522 }
523 stack->clipDevPath(path, op, false);
bsalomon@google.com51a62862012-11-26 21:19:43 +0000524};
525
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000526static void add_elem_to_stack(const SkClipStack::Element& element, SkClipStack* stack) {
527 switch (element.getType()) {
528 case SkClipStack::Element::kRect_Type:
529 stack->clipDevRect(element.getRect(), element.getOp(), element.isAA());
530 break;
531 case SkClipStack::Element::kPath_Type:
532 stack->clipDevPath(element.getPath(), element.getOp(), element.isAA());
533 break;
534 case SkClipStack::Element::kEmpty_Type:
535 SkDEBUGFAIL("Why did the reducer produce an explicit empty.");
536 stack->clipEmpty();
537 break;
bsalomon@google.com51a62862012-11-26 21:19:43 +0000538 }
539}
540
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000541static void add_elem_to_region(const SkClipStack::Element& element,
bsalomon@google.com51a62862012-11-26 21:19:43 +0000542 const SkIRect& bounds,
543 SkRegion* region) {
544 SkRegion elemRegion;
545 SkRegion boundsRgn(bounds);
546
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000547 switch (element.getType()) {
548 case SkClipStack::Element::kRect_Type: {
549 SkPath path;
550 path.addRect(element.getRect());
551 elemRegion.setPath(path, boundsRgn);
552 break;
553 }
554 case SkClipStack::Element::kPath_Type:
555 elemRegion.setPath(element.getPath(), boundsRgn);
556 break;
557 case SkClipStack::Element::kEmpty_Type:
558 //
559 region->setEmpty();
560 return;
bsalomon@google.com51a62862012-11-26 21:19:43 +0000561 }
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000562 region->op(elemRegion, element.getOp());
bsalomon@google.com51a62862012-11-26 21:19:43 +0000563}
564
565// This can assist with debugging the clip stack reduction code when the test below fails.
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000566static void print_clip(const SkClipStack::Element& element) {
bsalomon@google.com51a62862012-11-26 21:19:43 +0000567 static const char* kOpStrs[] = {
568 "DF",
569 "IS",
570 "UN",
571 "XR",
572 "RD",
573 "RP",
574 };
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000575 if (SkClipStack::Element::kEmpty_Type != element.getType()) {
576 const SkRect& bounds = element.getBounds();
577 bool isRect = SkClipStack::Element::kRect_Type == element.getType();
bsalomon@google.com705e8402012-11-27 15:43:57 +0000578 SkDebugf("%s %s %s [%f %f] x [%f %f]\n",
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000579 kOpStrs[element.getOp()],
580 (isRect ? "R" : "P"),
581 (element.isInverseFilled() ? "I" : " "),
bsalomon@google.com51a62862012-11-26 21:19:43 +0000582 bounds.fLeft, bounds.fRight, bounds.fTop, bounds.fBottom);
583 } else {
584 SkDebugf("EM\n");
585 }
586}
587
588static void test_reduced_clip_stack(skiatest::Reporter* reporter) {
589 // We construct random clip stacks, reduce them, and then rasterize both versions to verify that
skia.committer@gmail.com8ccf5902012-11-27 02:01:19 +0000590 // they are equal.
bsalomon@google.com51a62862012-11-26 21:19:43 +0000591
592 // All the clip elements will be contained within these bounds.
593 static const SkRect kBounds = SkRect::MakeWH(100, 100);
594
595 enum {
596 kNumTests = 200,
597 kMinElemsPerTest = 1,
598 kMaxElemsPerTest = 50,
599 };
600
601 // min/max size of a clip element as a fraction of kBounds.
602 static const SkScalar kMinElemSizeFrac = SK_Scalar1 / 5;
603 static const SkScalar kMaxElemSizeFrac = SK_Scalar1;
604
605 static const SkRegion::Op kOps[] = {
606 SkRegion::kDifference_Op,
607 SkRegion::kIntersect_Op,
608 SkRegion::kUnion_Op,
609 SkRegion::kXOR_Op,
610 SkRegion::kReverseDifference_Op,
611 SkRegion::kReplace_Op,
612 };
613
614 // Replace operations short-circuit the optimizer. We want to make sure that we test this code
615 // path a little bit but we don't want it to prevent us from testing many longer traversals in
616 // the optimizer.
617 static const int kReplaceDiv = 4 * kMaxElemsPerTest;
618
bsalomon@google.com705e8402012-11-27 15:43:57 +0000619 // We want to test inverse fills. However, they are quite rare in practice so don't over do it.
620 static const SkScalar kFractionInverted = SK_Scalar1 / kMaxElemsPerTest;
621
bsalomon@google.com51a62862012-11-26 21:19:43 +0000622 static const AddElementFunc kElementFuncs[] = {
623 add_rect,
624 add_round_rect,
625 add_oval,
626 };
627
628 SkRandom r;
629
630 for (int i = 0; i < kNumTests; ++i) {
631 // Randomly generate a clip stack.
632 SkClipStack stack;
633 int numElems = r.nextRangeU(kMinElemsPerTest, kMaxElemsPerTest);
634 for (int e = 0; e < numElems; ++e) {
635 SkRegion::Op op = kOps[r.nextULessThan(SK_ARRAY_COUNT(kOps))];
636 if (op == SkRegion::kReplace_Op) {
637 if (r.nextU() % kReplaceDiv) {
638 --e;
639 continue;
640 }
641 }
skia.committer@gmail.com8ccf5902012-11-27 02:01:19 +0000642
bsalomon@google.com51a62862012-11-26 21:19:43 +0000643 // saves can change the clip stack behavior when an element is added.
644 bool doSave = r.nextBool();
skia.committer@gmail.com8ccf5902012-11-27 02:01:19 +0000645
bsalomon@google.com51a62862012-11-26 21:19:43 +0000646 SkSize size = SkSize::Make(
647 SkScalarFloorToScalar(SkScalarMul(kBounds.width(), r.nextRangeScalar(kMinElemSizeFrac, kMaxElemSizeFrac))),
648 SkScalarFloorToScalar(SkScalarMul(kBounds.height(), r.nextRangeScalar(kMinElemSizeFrac, kMaxElemSizeFrac))));
649
650 SkPoint xy = {SkScalarFloorToScalar(r.nextRangeScalar(kBounds.fLeft, kBounds.fRight - size.fWidth)),
651 SkScalarFloorToScalar(r.nextRangeScalar(kBounds.fTop, kBounds.fBottom - size.fHeight))};
652
653 SkRect rect = SkRect::MakeXYWH(xy.fX, xy.fY, size.fWidth, size.fHeight);
654
bsalomon@google.com705e8402012-11-27 15:43:57 +0000655 bool invert = r.nextBiasedBool(kFractionInverted);
656 kElementFuncs[r.nextULessThan(SK_ARRAY_COUNT(kElementFuncs))](rect, invert, op, &stack);
bsalomon@google.com51a62862012-11-26 21:19:43 +0000657 if (doSave) {
658 stack.save();
659 }
660 }
661
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000662 typedef GrReducedClip::ElementList ElementList;
bsalomon@google.com51a62862012-11-26 21:19:43 +0000663 // Get the reduced version of the stack.
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000664 ElementList reducedClips;
bsalomon@google.com51a62862012-11-26 21:19:43 +0000665 SkRect resultBounds;
666 bool bounded;
667 GrReducedClip::InitialState initial;
668 GrReducedClip::GrReduceClipStack(stack, &reducedClips, &resultBounds, &bounded, &initial);
669
670 // Build a new clip stack based on the reduced clip elements
671 SkClipStack reducedStack;
672 if (GrReducedClip::kAllOut_InitialState == initial) {
673 // whether the result is bounded or not, the whole plane should start outside the clip.
674 reducedStack.clipEmpty();
675 }
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000676 for (ElementList::Iter iter = reducedClips.headIter(); NULL != iter.get(); iter.next()) {
677 add_elem_to_stack(*iter.get(), &reducedStack);
bsalomon@google.com51a62862012-11-26 21:19:43 +0000678 }
679 if (bounded) {
680 // GrReduceClipStack() assumes that there is an implicit clip to the bounds
681 reducedStack.clipDevRect(resultBounds, SkRegion::kIntersect_Op, true);
682 }
683
684 // convert both the original stack and reduced stack to SkRegions and see if they're equal
685 SkRect inflatedBounds = kBounds;
686 inflatedBounds.outset(kBounds.width() / 2, kBounds.height() / 2);
687 SkIRect inflatedIBounds;
688 inflatedBounds.roundOut(&inflatedIBounds);
689
690 SkRegion region;
691 SkRegion reducedRegion;
692
693 region.setRect(inflatedIBounds);
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000694 const SkClipStack::Element* element;
bsalomon@google.com51a62862012-11-26 21:19:43 +0000695 SkClipStack::Iter iter(stack, SkClipStack::Iter::kBottom_IterStart);
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000696 while ((element = iter.next())) {
697 add_elem_to_region(*element, inflatedIBounds, &region);
bsalomon@google.com51a62862012-11-26 21:19:43 +0000698 }
699
700 reducedRegion.setRect(inflatedIBounds);
701 iter.reset(reducedStack, SkClipStack::Iter::kBottom_IterStart);
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000702 while ((element = iter.next())) {
703 add_elem_to_region(*element, inflatedIBounds, &reducedRegion);
bsalomon@google.com51a62862012-11-26 21:19:43 +0000704 }
705
706 REPORTER_ASSERT(reporter, region == reducedRegion);
707 }
708}
709
bsalomon@google.coma4e13c82012-11-26 21:38:37 +0000710#endif
bsalomon@google.com51a62862012-11-26 21:19:43 +0000711///////////////////////////////////////////////////////////////////////////////////////////////////
712
reed@google.combdee9fc2011-02-22 20:17:43 +0000713static void TestClipStack(skiatest::Reporter* reporter) {
714 SkClipStack stack;
715
robertphillips@google.com80214e22012-07-20 15:33:18 +0000716 REPORTER_ASSERT(reporter, 0 == stack.getSaveCount());
reed@google.combdee9fc2011-02-22 20:17:43 +0000717 assert_count(reporter, stack, 0);
718
719 static const SkIRect gRects[] = {
720 { 0, 0, 100, 100 },
721 { 25, 25, 125, 125 },
722 { 0, 0, 1000, 1000 },
723 { 0, 0, 75, 75 }
724 };
725 for (size_t i = 0; i < SK_ARRAY_COUNT(gRects); i++) {
reed@google.comd9f2dea2011-10-12 14:43:27 +0000726 stack.clipDevRect(gRects[i], SkRegion::kIntersect_Op);
reed@google.combdee9fc2011-02-22 20:17:43 +0000727 }
728
729 // all of the above rects should have been intersected, leaving only 1 rect
robertphillips@google.com80214e22012-07-20 15:33:18 +0000730 SkClipStack::B2TIter iter(stack);
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000731 const SkClipStack::Element* element = iter.next();
epoger@google.com2047f002011-05-17 17:36:59 +0000732 SkRect answer;
733 answer.iset(25, 25, 75, 75);
reed@google.combdee9fc2011-02-22 20:17:43 +0000734
bsalomon@google.com8182fa02012-12-04 14:06:06 +0000735 REPORTER_ASSERT(reporter, NULL != element);
736 REPORTER_ASSERT(reporter, SkClipStack::Element::kRect_Type == element->getType());
737 REPORTER_ASSERT(reporter, SkRegion::kIntersect_Op == element->getOp());
738 REPORTER_ASSERT(reporter, element->getRect() == answer);
reed@google.combdee9fc2011-02-22 20:17:43 +0000739 // now check that we only had one in our iterator
740 REPORTER_ASSERT(reporter, !iter.next());
741
742 stack.reset();
robertphillips@google.com80214e22012-07-20 15:33:18 +0000743 REPORTER_ASSERT(reporter, 0 == stack.getSaveCount());
reed@google.combdee9fc2011-02-22 20:17:43 +0000744 assert_count(reporter, stack, 0);
vandebo@chromium.org1e1c36f2011-05-03 16:26:09 +0000745
746 test_assign_and_comparison(reporter);
robertphillips@google.com80214e22012-07-20 15:33:18 +0000747 test_iterators(reporter);
robertphillips@google.com08eacc12012-08-02 12:49:00 +0000748 test_bounds(reporter, true); // once with rects
749 test_bounds(reporter, false); // once with paths
robertphillips@google.comcc6493b2012-07-26 18:39:13 +0000750 test_isWideOpen(reporter);
robertphillips@google.com08eacc12012-08-02 12:49:00 +0000751 test_rect_merging(reporter);
bsalomon@google.come7b3d292012-11-26 21:42:32 +0000752#if SK_SUPPORT_GPU
bsalomon@google.comedb26fd2012-11-28 14:42:41 +0000753 test_reduced_clip_stack(reporter);
bsalomon@google.come7b3d292012-11-26 21:42:32 +0000754#endif
reed@google.combdee9fc2011-02-22 20:17:43 +0000755}
756
757#include "TestClassDef.h"
758DEFINE_TESTCLASS("ClipStack", TestClipStackClass, TestClipStack)