frust-engine 0.6.2

Sparse-strip GPU render pipeline for Frust: compiles a scene display list into strips and records the draw passes on wgpu.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
//! Retained pages, host-side: what a compiler with retention on records for a
//! `PushRetained`/`DrawRetained`, what the retained-page store decides for it
//! (admit, evict, refuse, serve, list), and what the scheduler makes of the
//! store's answers.
//!
//! No GPU is involved. The store is generic over its texture and view types,
//! so it is driven here against a counting fake allocator — the same shape the
//! intermediate pool's own tests use — and a page is a decision plus a counted
//! allocation. The pixels a retained page composites are pinned on hardware by
//! `frust-render`'s `gpu_smoke` and `frust-testing`'s `retained_parity` golden.
//!
//! The claims under test are the store's whole contract: a body is admitted
//! only when a page can hold what it really drew, a `DrawRetained` is served
//! from a page with the same linear transform at a whole-pixel offset and at
//! any alpha, one that cannot be served refuses the frame with
//! [`EngineError::RetainedKeyMissing`] and empties the store, the budget is
//! kept by evicting least recently used pages and never one the frame uses, a
//! refused frame leaves the store as it was, and a retained page never counts
//! toward the scheduler's live-page bound.

use std::cell::Cell;

use frust_engine::cache::images::AtlasTier;
use frust_engine::cache::retained::{
    RetainedBudget, RetainedDecision, RetainedPages, RetainedPlan, RetainedRefusal,
};
use frust_engine::compile::CompiledFrame;
use frust_engine::schedule::{
    MAX_LIVE_PAGES, PageConfig, RetainedLayers, RetainedRole, Round, RoundOp, RoundTarget, Schedule,
};
use frust_engine::{EngineDraw, EngineError, RetainedKind, SceneCompiler};
use frust_gpu::{DownlevelProfile, TextureAllocator, TextureDesc, TierCaps};
use frust_scene::{Scene, SceneBuilder};
use kurbo::{Affine, Rect};
use peniko::Brush;
use peniko::color::palette::css::{BLUE, RED};
use vello_common::color::palette::css::RED as RAW_RED;
use vello_common::geometry::RectU16;
use vello_common::paint::Paint;
use vello_common::record::{CommandRecorder, LayerProps};
use vello_common::strip::Strip;
use vello_common::tile::Tile;

/// Viewport every compiled case uses. Not square, so a swapped axis cannot
/// pass by symmetry.
const VIEWPORT: (u16, u16) = (128, 96);

/// A body's rectangle in its own space: 32x24, placed by the transform below.
const BODY: Rect = Rect::new(0.0, 0.0, 32.0, 24.0);

/// Bytes one page of [`BODY`] costs at 1x, recorded below full opacity —
/// where the body is clipped to its rectangle, so the page is exactly it.
/// (At full opacity the page takes the body's strip bounds, which run a tile
/// past a fill ending on a tile edge.)
const BODY_BYTES: u64 = 32 * 24 * 4;

/// An alpha below full opacity, so a recorded body's page is exactly its
/// rectangle.
const HALF: f32 = 0.5;

fn caps() -> TierCaps {
    TierCaps::fake(DownlevelProfile::Full)
}

/// A texture allocator that hands out numbered fakes and counts them.
#[derive(Default)]
struct FakeAllocator {
    allocated: Cell<u32>,
}

impl TextureAllocator for FakeAllocator {
    type Texture = (u32, u32);
    type View = u32;

    fn allocate_texture(&self, desc: &TextureDesc) -> ((u32, u32), u32) {
        let id = self.allocated.get() + 1;
        self.allocated.set(id);
        ((desc.width, desc.height), id)
    }
}

type FakePages = RetainedPages<(u32, u32), u32>;

fn store(budget: u64) -> FakePages {
    RetainedPages::new(RetainedBudget { bytes: budget }, 8192)
}

fn scene_of(record: impl FnOnce(&mut SceneBuilder<'_>)) -> Scene {
    let mut scene = Scene::new();
    let mut builder = SceneBuilder::new(&mut scene);
    record(&mut builder);
    scene
}

fn retaining_compiler() -> SceneCompiler {
    let mut compiler = SceneCompiler::new(VIEWPORT.0, VIEWPORT.1);
    compiler.set_retained_layers(true);
    compiler
}

fn compile_retained(scene: &Scene) -> CompiledFrame {
    retaining_compiler()
        .compile(scene, Affine::IDENTITY, VIEWPORT)
        .expect("an in-range scene compiles")
}

/// A `PushRetained` of [`BODY`] under `at`, filled solid.
fn record_body(builder: &mut SceneBuilder<'_>, key: u64, at: Affine, alpha: f32) {
    builder.push_transform(at);
    builder.push_retained(key, BODY, alpha, 1.0);
    builder.fill_rect(BODY, Brush::Solid(RED));
    builder.pop_retained();
    builder.pop_transform();
}

/// A `DrawRetained` of [`BODY`] under `at`.
fn draw_body(builder: &mut SceneBuilder<'_>, key: u64, at: Affine, alpha: f32, scale: f64) {
    builder.push_transform(at);
    builder.draw_retained(key, BODY, alpha, scale);
    builder.pop_transform();
}

/// Plan `frame` against `pages` and commit it as if every admitted body
/// rendered.
fn run(pages: &mut FakePages, allocator: &FakeAllocator, mut frame: CompiledFrame) -> RetainedPlan {
    let plan = pages
        .plan(&frame.retained, &mut frame.recorder.layers)
        .expect("the frame's draws are all served");
    let rendered = vec![true; frame.retained.len()];
    pages.commit(
        allocator,
        &frame.retained,
        &frame.retained_superseded,
        &plan,
        &rendered,
    );
    plan
}

fn keys(pages: &FakePages) -> Vec<u64> {
    let mut keys: Vec<u64> = pages.entries().map(|entry| entry.key).collect();
    keys.sort_unstable();
    keys
}

fn retainable(frame: &CompiledFrame) -> Vec<bool> {
    frame
        .retained
        .iter()
        .filter_map(|bracket| match bracket.kind {
            RetainedKind::Record { retainable, .. } => Some(retainable),
            RetainedKind::Draw { .. } => None,
        })
        .collect()
}

// ---------------------------------------------------------------------
// What the compiler records
// ---------------------------------------------------------------------

#[test]
fn a_compiler_without_a_store_lowers_inline_and_refuses_a_draw_by_its_key() {
    let mut compiler = SceneCompiler::new(VIEWPORT.0, VIEWPORT.1);
    assert!(!compiler.retained_layers_enabled());

    let frame = compiler
        .compile(
            &scene_of(|builder| record_body(builder, 3, Affine::translate((8.0, 8.0)), 1.0)),
            Affine::IDENTITY,
            VIEWPORT,
        )
        .expect("a bracket compiles");
    assert!(frame.retained.is_empty());
    assert!(
        frame.recorder.layers.is_empty(),
        "a full-opacity bracket lowers to nothing at all without a store"
    );

    let refused = compiler.compile(
        &scene_of(|builder| draw_body(builder, 9, Affine::IDENTITY, 1.0, 1.0)),
        Affine::IDENTITY,
        VIEWPORT,
    );
    assert!(
        matches!(refused, Err(EngineError::RetainedKeyMissing { key: 9 })),
        "a DrawRetained reaching a compiler that retains nothing is the dedicated error: {refused:?}"
    );
}

#[test]
fn with_retention_on_every_outermost_bracket_is_a_layer_listed_for_the_store() {
    let frame = compile_retained(&scene_of(|builder| {
        record_body(builder, 1, Affine::translate((8.0, 8.0)), 1.0);
        builder.push_transform(Affine::translate((48.0, 40.0)) * Affine::scale(2.0));
        builder.push_retained(2, Rect::new(0.0, 0.0, 16.0, 12.0), 0.5, 1.0);
        // Nested: only the outermost bracket is honoured.
        builder.push_retained(3, Rect::new(0.0, 0.0, 4.0, 4.0), 0.25, 1.0);
        builder.fill_rect(Rect::new(0.0, 0.0, 16.0, 12.0), Brush::Solid(BLUE));
        builder.pop_retained();
        builder.pop_retained();
        builder.pop_transform();
    }));

    let recorded: Vec<(u64, f32, (u32, u32), f32)> = frame
        .retained
        .iter()
        .map(|bracket| {
            (
                bracket.key,
                bracket.opacity,
                bracket.extent_px,
                bracket.placement.scale(),
            )
        })
        .collect();
    assert_eq!(
        recorded,
        vec![(1, 1.0, (32, 24), 1.0), (2, 0.5, (32, 24), 2.0)],
        "one entry per outermost bracket, its extent and scale as rasterized"
    );
    assert_eq!(
        frame.recorder.layers.len(),
        2,
        "each body is a layer of its own"
    );
    assert_eq!(retainable(&frame), vec![true, true]);
    match frame.retained[0].kind {
        RetainedKind::Record { rect, .. } => {
            assert_eq!(
                rect,
                RectU16::new(8, 8, 40, 32),
                "the rectangle, rounded out to tiles"
            );
        }
        RetainedKind::Draw { .. } => panic!("a PushRetained is a record"),
    }
}

#[test]
fn a_full_opacity_retained_body_draws_exactly_the_inline_coverage() {
    let scene = scene_of(|builder| {
        builder.fill_rect(Rect::new(0.0, 0.0, 128.0, 96.0), Brush::Solid(BLUE));
        builder.push_transform(Affine::translate((10.5, 7.25)));
        builder.push_retained(5, BODY, 1.0, 0.75);
        builder.fill_rect(Rect::new(2.0, 2.0, 30.0, 20.0), Brush::Solid(RED));
        builder.pop_retained();
        builder.pop_transform();
    });
    let inline = SceneCompiler::new(VIEWPORT.0, VIEWPORT.1)
        .compile(&scene, Affine::IDENTITY, VIEWPORT)
        .expect("compiles");
    let retained = compile_retained(&scene);

    assert_eq!(retained.strip_buf(), inline.strip_buf());
    assert_eq!(retained.alphas(), inline.alphas());
    let depths = |frame: &CompiledFrame| -> Vec<u32> {
        frame
            .draws()
            .iter()
            .map(|draw: &EngineDraw| draw.depth)
            .collect()
    };
    assert_eq!(depths(&retained), depths(&inline));
}

#[test]
fn a_draw_retained_is_an_empty_layer_at_its_painter_order_slot() {
    let frame = compile_retained(&scene_of(|builder| {
        builder.fill_rect(Rect::new(0.0, 0.0, 8.0, 8.0), Brush::Solid(RED));
        draw_body(builder, 4, Affine::translate((16.0, 16.0)), 0.5, 1.0);
        builder.fill_rect(Rect::new(0.0, 0.0, 8.0, 8.0), Brush::Solid(BLUE));
    }));

    assert_eq!(frame.recorder.layers.len(), 1);
    assert!(
        frame.recorder.layers[0].nodes.is_empty(),
        "the layer draws nothing itself"
    );
    let draw_depths: Vec<u32> = frame.draws().iter().map(|draw| draw.depth).collect();
    assert_eq!(draw_depths, vec![0, 2]);
    match frame.retained[0].kind {
        RetainedKind::Draw {
            depth,
            window,
            masked,
        } => {
            assert_eq!(
                depth, 1,
                "the composite takes the slot between the two fills"
            );
            assert_eq!(window, RectU16::new(0, 0, VIEWPORT.0, VIEWPORT.1));
            assert!(!masked);
        }
        RetainedKind::Record { .. } => panic!("a DrawRetained is a draw"),
    }
}

#[test]
fn bodies_a_page_cannot_hold_are_marked_unretainable() {
    let at = Affine::translate((8.0, 8.0));
    let cases: Vec<(&str, Scene, bool)> = vec![
        (
            "a plain body",
            scene_of(|builder| record_body(builder, 1, at, 1.0)),
            true,
        ),
        (
            "a body inside a scissor that holds it",
            scene_of(|builder| {
                builder.push_clip(Rect::new(0.0, 0.0, 64.0, 64.0));
                record_body(builder, 1, at, 1.0);
                builder.pop_clip();
            }),
            true,
        ),
        (
            "a body reaching past the viewport",
            scene_of(|builder| record_body(builder, 1, Affine::translate((110.0, 8.0)), 1.0)),
            false,
        ),
        (
            "a body a scissor cuts",
            scene_of(|builder| {
                builder.push_clip(Rect::new(0.0, 0.0, 20.0, 20.0));
                record_body(builder, 1, at, 1.0);
                builder.pop_clip();
            }),
            false,
        ),
        (
            "a body under a coverage mask",
            scene_of(|builder| {
                builder.push_clip_rounded(Rect::new(0.0, 0.0, 64.0, 64.0), 6.0);
                record_body(builder, 1, at, 1.0);
                builder.pop_clip();
            }),
            false,
        ),
        (
            "a body that punches",
            scene_of(|builder| {
                builder.push_transform(at);
                builder.push_retained(1, BODY, 1.0, 1.0);
                builder.clear_rect(Rect::new(2.0, 2.0, 6.0, 6.0));
                builder.pop_retained();
                builder.pop_transform();
            }),
            false,
        ),
        (
            "a body drawing an external texture",
            scene_of(|builder| {
                builder.push_transform(at);
                builder.push_retained(1, BODY, 1.0, 1.0);
                builder.scene_texture(77, Rect::new(0.0, 0.0, 8.0, 8.0));
                builder.pop_retained();
                builder.pop_transform();
            }),
            false,
        ),
        (
            "a body a stray pop closed early",
            scene_of(|builder| {
                builder.push_transform(at);
                builder.push_retained(1, BODY, 0.5, 1.0);
                builder.pop_clip();
                builder.fill_rect(BODY, Brush::Solid(RED));
                builder.pop_retained();
                builder.pop_transform();
            }),
            false,
        ),
        (
            "a body left open at the end of the frame",
            scene_of(|builder| {
                builder.push_transform(at);
                builder.push_retained(1, BODY, 1.0, 1.0);
                builder.fill_rect(BODY, Brush::Solid(RED));
            }),
            false,
        ),
    ];

    for (what, scene, expected) in cases {
        let frame = compile_retained(&scene);
        assert_eq!(retainable(&frame), vec![expected], "{what}");
    }
}

#[test]
fn retention_keeps_the_parallel_walk_byte_identical() {
    let scene = scene_of(|builder| {
        for row in 0..6_u32 {
            let y = f64::from(row) * 14.0;
            builder.push_transform(Affine::translate((4.0, y + 1.5)));
            builder.push_retained(
                u64::from(row),
                Rect::new(0.0, 0.0, 120.0, 12.0),
                if row % 2 == 0 { 1.0 } else { 0.5 },
                1.0 + f64::from(row) * 0.01,
            );
            for column in 0..8_u32 {
                let x = f64::from(column) * 14.0 + 0.3;
                builder.fill_rounded_rect(
                    Rect::new(x, 0.5, x + 11.0, 11.0),
                    3.0,
                    Brush::Solid(RED),
                );
            }
            builder.pop_retained();
            builder.pop_transform();
        }
        draw_body(builder, 99, Affine::translate((3.0, 3.0)), 0.5, 1.0);
    });

    let mut sequential = retaining_compiler();
    sequential.set_parallel_workers(1);
    let mut parallel = retaining_compiler();
    parallel.set_parallel_workers(4);
    parallel.set_parallel_min_cost(0);

    let a = sequential
        .compile(&scene, Affine::IDENTITY, VIEWPORT)
        .expect("compiles");
    let b = parallel
        .compile(&scene, Affine::IDENTITY, VIEWPORT)
        .expect("compiles");
    assert_eq!(a.strip_buf(), b.strip_buf());
    assert_eq!(a.alphas(), b.alphas());
    assert_eq!(a.retained, b.retained);
    assert_eq!(a.recorder.layers.len(), b.recorder.layers.len());
    assert!(
        b.parallel_draws > 0,
        "precondition: helpers really generated runs"
    );
}

// ---------------------------------------------------------------------
// The store: admit, serve, refuse, evict, list
// ---------------------------------------------------------------------

#[test]
fn a_recorded_body_becomes_resident_only_once_committed() {
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    let mut frame = compile_retained(&scene_of(|builder| {
        record_body(builder, 7, Affine::translate((8.0, 8.0)), 0.5);
    }));

    let plan = pages
        .plan(&frame.retained, &mut frame.recorder.layers)
        .expect("plans");
    assert_eq!(
        plan.decisions,
        vec![RetainedDecision::Record {
            bounds: RectU16::new(8, 8, 40, 32)
        }]
    );
    assert!(
        pages.is_empty(),
        "planning changes nothing — a frame refused after it must leave the store as it was"
    );
    let before = pages.generation();

    pages.commit(&allocator, &frame.retained, &[], &plan, &[true]);
    let entries: Vec<_> = pages.entries().collect();
    assert_eq!(entries.len(), 1);
    assert_eq!(entries[0].key, 7);
    assert_eq!(entries[0].extent_px, (32, 24));
    assert_eq!(entries[0].scale, 1.0);
    assert_eq!(allocator.allocated.get(), 1);
    assert_ne!(pages.generation(), before, "a new page is a ledger change");
    assert_eq!(pages.used_bytes(), BODY_BYTES);
    assert!(
        pages.page_for(0).is_some(),
        "the bracket is bound to its page"
    );
}

#[test]
fn only_a_body_the_schedule_rendered_is_committed() {
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    let mut frame = compile_retained(&scene_of(|builder| {
        record_body(builder, 7, Affine::translate((8.0, 8.0)), 1.0);
    }));
    let plan = pages
        .plan(&frame.retained, &mut frame.recorder.layers)
        .expect("plans");
    pages.commit(&allocator, &frame.retained, &[], &plan, &[false]);
    assert!(pages.is_empty());
    assert_eq!(allocator.allocated.get(), 0);
}

#[test]
fn a_draw_is_served_at_any_alpha_and_any_whole_pixel_move() {
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| {
            record_body(builder, 1, Affine::translate((8.0, 8.0)), HALF);
        })),
    );

    let draw = |at: Affine, alpha: f32, pages: &mut FakePages| {
        let mut frame =
            compile_retained(&scene_of(|builder| draw_body(builder, 1, at, alpha, 1.0)));
        pages
            .plan(&frame.retained, &mut frame.recorder.layers)
            .expect("served")
            .decisions
    };

    assert_eq!(
        draw(Affine::translate((8.0, 8.0)), 0.25, &mut pages),
        vec![RetainedDecision::Draw {
            dest: RectU16::new(8, 8, 40, 32),
            origin: (0, 0),
        }],
        "where it was recorded, at another alpha"
    );
    assert_eq!(
        draw(Affine::translate((28.4, 9.0)), 1.0, &mut pages),
        vec![RetainedDecision::Draw {
            dest: RectU16::new(28, 9, 60, 33),
            origin: (0, 0),
        }],
        "moved by a translation rounded to whole pixels"
    );
    assert_eq!(
        draw(Affine::translate((-10.0, 8.0)), 1.0, &mut pages),
        vec![RetainedDecision::Draw {
            dest: RectU16::new(0, 8, 22, 32),
            origin: (10, 0),
        }],
        "trimmed to the viewport, sampling from the texel under the trimmed corner"
    );
    assert_eq!(
        draw(Affine::translate((500.0, 8.0)), 1.0, &mut pages),
        vec![RetainedDecision::Hidden],
        "moved wholly off screen: served, drawing nothing"
    );
}

#[test]
fn a_draw_the_store_cannot_serve_refuses_the_frame_and_clears_the_store() {
    let at = Affine::translate((8.0, 8.0));
    let cases: Vec<(&str, Scene, u64)> = vec![
        (
            "a key that was never recorded",
            scene_of(|builder| draw_body(builder, 2, at, 1.0, 1.0)),
            2,
        ),
        (
            "another presentation scale",
            scene_of(|builder| draw_body(builder, 1, at, 1.0, 0.9)),
            1,
        ),
        (
            "another device scale",
            scene_of(|builder| draw_body(builder, 1, at * Affine::scale(2.0), 1.0, 1.0)),
            1,
        ),
        (
            "a coverage mask around the draw",
            scene_of(|builder| {
                builder.push_clip_rounded(Rect::new(0.0, 0.0, 64.0, 64.0), 6.0);
                draw_body(builder, 1, at, 1.0, 1.0);
                builder.pop_clip();
            }),
            1,
        ),
    ];

    for (what, scene, key) in cases {
        let allocator = FakeAllocator::default();
        let mut pages = store(1 << 20);
        run(
            &mut pages,
            &allocator,
            compile_retained(&scene_of(|builder| record_body(builder, 1, at, 1.0))),
        );
        let generation = pages.generation();

        let mut frame = compile_retained(&scene);
        let refused = pages.plan(&frame.retained, &mut frame.recorder.layers);
        assert!(
            matches!(refused, Err(EngineError::RetainedKeyMissing { key: k }) if k == key),
            "{what}: {refused:?}"
        );
        assert!(pages.is_empty(), "{what}: the store is cleared");
        assert_ne!(pages.generation(), generation, "{what}: the ledger changed");
        assert!(pages.take_refusal(), "{what}: the refusal is reported once");
        assert!(!pages.take_refusal());
    }
}

#[test]
fn eviction_is_least_recently_used_and_spares_every_page_the_frame_uses() {
    let allocator = FakeAllocator::default();
    // Room for exactly two bodies.
    let mut pages = store(BODY_BYTES * 2);
    let at = |x: f64| Affine::translate((x, 8.0));

    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| record_body(builder, 1, at(0.0), HALF))),
    );
    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| record_body(builder, 2, at(40.0), HALF))),
    );
    // Drawing 1 makes 2 the least recently used.
    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| {
            draw_body(builder, 1, at(0.0), 1.0, 1.0)
        })),
    );
    let plan = run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| record_body(builder, 3, at(80.0), HALF))),
    );
    assert_eq!(plan.evictions, vec![2]);
    assert_eq!(keys(&pages), vec![1, 3]);
    assert!(pages.used_bytes() <= BODY_BYTES * 2);

    // A frame drawing both resident pages and recording a third cannot evict
    // either, so the third renders inline.
    let frame = compile_retained(&scene_of(|builder| {
        draw_body(builder, 1, at(0.0), 1.0, 1.0);
        draw_body(builder, 3, at(80.0), 1.0, 1.0);
        record_body(builder, 4, at(40.0), HALF);
    }));
    let plan = run(&mut pages, &allocator, frame);
    assert_eq!(
        plan.decisions[2],
        RetainedDecision::Inline(RetainedRefusal::OverBudget)
    );
    assert!(plan.evictions.is_empty());
    assert_eq!(keys(&pages), vec![1, 3]);
}

#[test]
fn refused_bodies_render_inline_and_stay_out_of_the_ledger() {
    let at = Affine::translate((8.0, 8.0));
    let cases: Vec<(&str, FakePages, Scene, RetainedRefusal)> = vec![
        (
            "a body larger than any page",
            RetainedPages::new(RetainedBudget { bytes: 1 << 20 }, 16),
            scene_of(|builder| record_body(builder, 1, at, 1.0)),
            RetainedRefusal::TooLarge,
        ),
        (
            "a body larger than the whole budget",
            store(BODY_BYTES - 1),
            scene_of(|builder| record_body(builder, 1, at, 1.0)),
            RetainedRefusal::OverBudget,
        ),
        (
            "a body drawing outside its rectangle",
            store(1 << 20),
            scene_of(|builder| {
                builder.push_transform(at);
                builder.push_retained(1, BODY, 1.0, 1.0);
                builder.fill_rect(Rect::new(0.0, 0.0, 60.0, 24.0), Brush::Solid(RED));
                builder.pop_retained();
                builder.pop_transform();
            }),
            RetainedRefusal::Overflow,
        ),
        (
            "a body drawing nothing",
            store(1 << 20),
            scene_of(|builder| {
                builder.push_transform(at);
                builder.push_retained(1, BODY, 1.0, 1.0);
                builder.pop_retained();
                builder.pop_transform();
            }),
            RetainedRefusal::Empty,
        ),
        (
            "a body clipped on the way in",
            store(1 << 20),
            scene_of(|builder| record_body(builder, 1, Affine::translate((110.0, 8.0)), 1.0)),
            RetainedRefusal::NotRetainable,
        ),
    ];

    for (what, mut pages, scene, reason) in cases {
        let allocator = FakeAllocator::default();
        let frame = compile_retained(&scene);
        let plan = run(&mut pages, &allocator, frame);
        assert_eq!(
            plan.decisions,
            vec![RetainedDecision::Inline(reason)],
            "{what}"
        );
        assert!(pages.is_empty(), "{what}: nothing resident");
        assert_eq!(allocator.allocated.get(), 0, "{what}: nothing allocated");
    }

    // The same key recorded twice in one frame: the second renders inline.
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    let frame = compile_retained(&scene_of(|builder| {
        record_body(builder, 1, Affine::translate((0.0, 0.0)), 1.0);
        record_body(builder, 1, Affine::translate((40.0, 40.0)), 1.0);
    }));
    let plan = run(&mut pages, &allocator, frame);
    assert!(matches!(plan.decisions[0], RetainedDecision::Record { .. }));
    assert_eq!(
        plan.decisions[1],
        RetainedDecision::Inline(RetainedRefusal::Duplicate)
    );
}

#[test]
fn a_re_recorded_body_reuses_its_page_while_it_fits() {
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    let at = Affine::translate((8.0, 8.0));
    let record = |builder: &mut SceneBuilder<'_>, width: f64| {
        builder.push_transform(at);
        builder.push_retained(1, BODY, HALF, 1.0);
        builder.fill_rect(Rect::new(0.0, 0.0, width, 24.0), Brush::Solid(RED));
        builder.pop_retained();
        builder.pop_transform();
    };

    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| record(builder, 32.0))),
    );
    let generation = pages.generation();
    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| record(builder, 16.0))),
    );
    assert_eq!(
        allocator.allocated.get(),
        1,
        "a smaller body reuses the page"
    );
    assert_eq!(
        pages.generation(),
        generation,
        "the same key at the same extent and scale changes nothing the ledger says"
    );

    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| {
            builder.push_transform(at);
            builder.push_retained(1, Rect::new(0.0, 0.0, 64.0, 24.0), HALF, 1.0);
            builder.fill_rect(Rect::new(0.0, 0.0, 64.0, 24.0), Brush::Solid(RED));
            builder.pop_retained();
            builder.pop_transform();
        })),
    );
    assert_eq!(
        allocator.allocated.get(),
        2,
        "a larger body takes a new page"
    );
    assert_eq!(pages.len(), 1, "and the old one goes");
    assert_eq!(pages.used_bytes(), 64 * 24 * 4);
}

// ---------------------------------------------------------------------
// A re-record whose recording does not reach the page evicts it
// ---------------------------------------------------------------------

/// The key every re-record case below records, then records again.
const KEY: u64 = 5;

/// Where every re-record case places its body.
const AT: Affine = Affine::new([1.0, 0.0, 0.0, 1.0, 8.0, 8.0]);

/// `pages` holding [`KEY`]'s page as [`record_body`] at [`AT`] and half
/// opacity records it — the page a later `DrawRetained` of the same body at
/// the same placement is served from.
fn with_key_resident(pages: &mut FakePages, allocator: &FakeAllocator) {
    run(
        pages,
        allocator,
        compile_retained(&scene_of(|builder| record_body(builder, KEY, AT, HALF))),
    );
    assert_eq!(keys(pages), vec![KEY], "precondition: the key is resident");
}

/// Whether a `DrawRetained` of [`KEY`]'s body at [`AT`] — the request the
/// page recorded by [`with_key_resident`] serves — is refused for want of the
/// key, leaving nothing composited.
fn draw_of_key_is_refused(pages: &mut FakePages) -> bool {
    let mut frame = compile_retained(&scene_of(|builder| draw_body(builder, KEY, AT, 1.0, 1.0)));
    matches!(
        pages.plan(&frame.retained, &mut frame.recorder.layers),
        Err(EngineError::RetainedKeyMissing { key: KEY })
    )
}

#[test]
fn the_draw_of_a_resident_key_is_served_when_its_bracket_is_simply_absent() {
    // The control every eviction case below rests on: the page recorded by
    // `with_key_resident` serves exactly the draw those cases expect refused,
    // and a frame that does not name the key at all leaves it resident — the
    // least-recently-used semantics are unchanged.
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    with_key_resident(&mut pages, &allocator);
    let generation = pages.generation();

    let plan = run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| record_body(builder, 9, AT, HALF))),
    );
    assert!(matches!(plan.decisions[0], RetainedDecision::Record { .. }));
    assert_eq!(keys(&pages), vec![KEY, 9], "an unnamed key stays resident");
    let generation_after_new_page = pages.generation();
    assert_ne!(
        generation_after_new_page, generation,
        "the new page is a change"
    );

    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| {
            builder.fill_rect(BODY, Brush::Solid(BLUE));
        })),
    );
    assert_eq!(
        keys(&pages),
        vec![KEY, 9],
        "a frame naming no key evicts none"
    );
    assert_eq!(pages.generation(), generation_after_new_page);

    let mut frame = compile_retained(&scene_of(|builder| draw_body(builder, KEY, AT, 1.0, 1.0)));
    let plan = pages
        .plan(&frame.retained, &mut frame.recorder.layers)
        .expect("the resident page serves the draw");
    assert!(matches!(plan.decisions[0], RetainedDecision::Draw { .. }));
}

#[test]
fn a_refused_re_record_evicts_the_keys_previous_page() {
    // Each case: the key's page resident from an earlier frame, then the same
    // key re-recorded with a body the store refuses. The refused body renders
    // inline; the page still holding the earlier body would composite stale
    // pixels on the next frame the widget draws it, so it has to go.
    type Setup = fn(&mut FakePages);
    let keep: Setup = |_| {};
    let squeeze: Setup = |pages| pages.set_budget(RetainedBudget { bytes: BODY_BYTES });
    let wide = Rect::new(0.0, 0.0, 64.0, 24.0);
    let cases: Vec<(&str, FakePages, Setup, Scene, RetainedRefusal)> = vec![
        (
            "a body that now draws nothing",
            store(1 << 20),
            keep,
            scene_of(|builder| {
                builder.push_transform(AT);
                builder.push_retained(KEY, BODY, HALF, 1.0);
                builder.pop_retained();
                builder.pop_transform();
            }),
            RetainedRefusal::Empty,
        ),
        (
            "a body that now draws outside its rectangle",
            store(1 << 20),
            keep,
            scene_of(|builder| {
                builder.push_transform(AT);
                builder.push_retained(KEY, BODY, 1.0, 1.0);
                builder.fill_rect(Rect::new(0.0, 0.0, 60.0, 24.0), Brush::Solid(RED));
                builder.pop_retained();
                builder.pop_transform();
            }),
            RetainedRefusal::Overflow,
        ),
        (
            "a body now under a rounded clip",
            store(1 << 20),
            keep,
            scene_of(|builder| {
                builder.push_clip_rounded(Rect::new(0.0, 0.0, 64.0, 64.0), 6.0);
                record_body(builder, KEY, AT, HALF);
                builder.pop_clip();
            }),
            RetainedRefusal::NotRetainable,
        ),
        (
            "a body that now punches",
            store(1 << 20),
            keep,
            scene_of(|builder| {
                builder.push_transform(AT);
                builder.push_retained(KEY, BODY, HALF, 1.0);
                builder.fill_rect(BODY, Brush::Solid(RED));
                builder.clear_rect(Rect::new(2.0, 2.0, 6.0, 6.0));
                builder.pop_retained();
                builder.pop_transform();
            }),
            RetainedRefusal::NotRetainable,
        ),
        (
            "a body grown past a budget overridden down to the old page",
            store(1 << 20),
            squeeze,
            scene_of(|builder| {
                builder.push_transform(AT);
                builder.push_retained(KEY, wide, HALF, 1.0);
                builder.fill_rect(wide, Brush::Solid(RED));
                builder.pop_retained();
                builder.pop_transform();
            }),
            RetainedRefusal::OverBudget,
        ),
        (
            "a body grown past the largest page",
            RetainedPages::new(RetainedBudget { bytes: 1 << 20 }, 40),
            keep,
            scene_of(|builder| {
                builder.push_transform(AT);
                builder.push_retained(KEY, wide, HALF, 1.0);
                builder.fill_rect(wide, Brush::Solid(RED));
                builder.pop_retained();
                builder.pop_transform();
            }),
            RetainedRefusal::TooLarge,
        ),
    ];

    for (what, mut pages, setup, scene, reason) in cases {
        let allocator = FakeAllocator::default();
        with_key_resident(&mut pages, &allocator);
        setup(&mut pages);
        assert_eq!(
            keys(&pages),
            vec![KEY],
            "{what}: precondition, still resident"
        );
        let generation = pages.generation();

        let plan = run(&mut pages, &allocator, compile_retained(&scene));
        assert_eq!(
            plan.decisions,
            vec![RetainedDecision::Inline(reason)],
            "{what}: the re-record is refused"
        );
        assert!(
            !pages.contains(KEY) && keys(&pages).is_empty(),
            "{what}: the key is absent from the ledger after the refusing frame"
        );
        assert_ne!(pages.generation(), generation, "{what}: the ledger changed");
        assert_eq!(
            allocator.allocated.get(),
            1,
            "{what}: nothing new allocated"
        );
        assert!(
            draw_of_key_is_refused(&mut pages),
            "{what}: a following DrawRetained is refused, never composited from the old page"
        );
    }
}

#[test]
fn a_re_record_nested_inside_another_bracket_evicts_the_keys_previous_page() {
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    with_key_resident(&mut pages, &allocator);

    // The key's bracket inside an outermost one: its body is painted into the
    // outer page, and its own page receives nothing.
    let frame = compile_retained(&scene_of(|builder| {
        builder.push_transform(AT);
        builder.push_retained(1, BODY, HALF, 1.0);
        builder.push_retained(KEY, BODY, HALF, 1.0);
        builder.fill_rect(BODY, Brush::Solid(BLUE));
        builder.pop_retained();
        builder.pop_retained();
        builder.pop_transform();
    }));
    assert_eq!(frame.retained_superseded, vec![KEY]);
    let generation = pages.generation();
    let plan = run(&mut pages, &allocator, frame);

    assert!(
        matches!(plan.decisions[..], [RetainedDecision::Record { .. }]),
        "the outermost bracket is admitted: {:?}",
        plan.decisions
    );
    assert_eq!(
        keys(&pages),
        vec![1],
        "the outer key is resident, the inner absent"
    );
    assert_ne!(pages.generation(), generation);
    assert!(draw_of_key_is_refused(&mut pages));
}

#[test]
fn a_re_record_the_schedule_does_not_render_evicts_the_keys_previous_page() {
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    with_key_resident(&mut pages, &allocator);

    // The body admitted, inside a layer that composites nothing: the
    // scheduler drops the layer and everything in it.
    let mut frame = compile_retained(&scene_of(|builder| {
        builder.push_layer(Rect::new(0.0, 0.0, 64.0, 64.0), 0.0);
        record_body(builder, KEY, AT, HALF);
        builder.pop_layer();
    }));
    let plan = pages
        .plan(&frame.retained, &mut frame.recorder.layers)
        .expect("plans");
    assert!(
        matches!(plan.decisions[..], [RetainedDecision::Record { .. }]),
        "precondition: the store admits the body: {:?}",
        plan.decisions
    );

    // The renderer's own reading of the schedule: which bracket a round
    // renders into its retained page.
    let mut roles = RetainedLayers::new();
    for (index, (bracket, decision)) in frame.retained.iter().zip(&plan.decisions).enumerate() {
        if let RetainedDecision::Record { .. } = decision {
            let id = u32::try_from(index).expect("a handful of brackets");
            roles.set(bracket.layer, RetainedRole::Record { bracket: id });
        }
    }
    let rounds = Schedule::build_retained(&frame.recorder, &caps(), &PageConfig::default(), &roles)
        .expect("schedules");
    let mut rendered = vec![false; frame.retained.len()];
    for target in rounds.iter().filter_map(Round::retained) {
        rendered[target.bracket as usize] = true;
    }
    assert_eq!(
        rendered,
        vec![false],
        "precondition: the body renders nowhere"
    );

    let generation = pages.generation();
    pages.commit(
        &allocator,
        &frame.retained,
        &frame.retained_superseded,
        &plan,
        &rendered,
    );
    assert!(
        keys(&pages).is_empty(),
        "the unrendered body's key is absent"
    );
    assert_ne!(pages.generation(), generation);
    assert!(
        pages.page_for(0).is_none(),
        "and its bracket is bound to nothing"
    );
    assert!(draw_of_key_is_refused(&mut pages));
}

#[test]
fn a_key_the_frame_also_draws_or_records_keeps_its_page() {
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    with_key_resident(&mut pages, &allocator);

    // Drawn and nested in one frame: the draw samples the page this frame,
    // so the page stays — it holds what the frame composited under the key.
    let frame = compile_retained(&scene_of(|builder| {
        draw_body(builder, KEY, AT, 1.0, 1.0);
        builder.push_transform(Affine::translate((48.0, 8.0)));
        builder.push_retained(1, BODY, HALF, 1.0);
        builder.push_retained(KEY, BODY, HALF, 1.0);
        builder.fill_rect(BODY, Brush::Solid(BLUE));
        builder.pop_retained();
        builder.pop_retained();
        builder.pop_transform();
    }));
    assert_eq!(frame.retained_superseded, vec![KEY]);
    let plan = run(&mut pages, &allocator, frame);
    assert!(matches!(plan.decisions[0], RetainedDecision::Draw { .. }));
    assert_eq!(keys(&pages), vec![1, KEY]);
    assert!(
        pages.page_for(0).is_some(),
        "the draw is still bound to its page"
    );

    // Recorded at the root and nested elsewhere: the root body's recording is
    // this frame's, so its page stands.
    let frame = compile_retained(&scene_of(|builder| {
        record_body(builder, KEY, AT, HALF);
        builder.push_transform(Affine::translate((48.0, 8.0)));
        builder.push_retained(1, BODY, HALF, 1.0);
        builder.push_retained(KEY, BODY, HALF, 1.0);
        builder.fill_rect(BODY, Brush::Solid(BLUE));
        builder.pop_retained();
        builder.pop_retained();
        builder.pop_transform();
    }));
    let plan = run(&mut pages, &allocator, frame);
    assert!(matches!(plan.decisions[0], RetainedDecision::Record { .. }));
    assert_eq!(keys(&pages), vec![1, KEY]);
}

#[test]
fn clearing_and_rebudgeting_change_what_the_ledger_lists() {
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| {
            record_body(builder, 1, Affine::translate((0.0, 0.0)), HALF);
            record_body(builder, 2, Affine::translate((40.0, 40.0)), HALF);
        })),
    );
    assert_eq!(keys(&pages), vec![1, 2]);

    pages.set_budget(RetainedBudget { bytes: BODY_BYTES });
    assert_eq!(pages.len(), 1, "a smaller budget evicts down to fit");

    let generation = pages.generation();
    pages.clear();
    assert!(pages.is_empty());
    assert_ne!(pages.generation(), generation);
    assert!(
        !pages.take_refusal(),
        "a clear the host asked for is not a refusal"
    );
}

#[test]
fn the_budget_follows_the_atlas_tier() {
    assert_eq!(
        RetainedBudget::for_tier(AtlasTier::Mobile),
        RetainedBudget::MOBILE
    );
    assert_eq!(
        RetainedBudget::for_tier(AtlasTier::MobileLarge),
        RetainedBudget::MOBILE_LARGE
    );
    assert_eq!(
        RetainedBudget::for_tier(AtlasTier::Desktop),
        RetainedBudget::DESKTOP
    );
    const { assert!(RetainedBudget::MOBILE.bytes < RetainedBudget::MOBILE_LARGE.bytes) };
    const { assert!(RetainedBudget::MOBILE_LARGE.bytes < RetainedBudget::DESKTOP.bytes) };
    // A full-screen 1080x2400 page, three times over, fits a phone.
    const { assert!(RetainedBudget::MOBILE.bytes >= 3 * 1080 * 2400 * 4) };
}

// ---------------------------------------------------------------------
// What the scheduler makes of the store's answers
// ---------------------------------------------------------------------

fn layer(opacity: f32) -> LayerProps {
    LayerProps {
        blend_mode: vello_common::peniko::BlendMode::default(),
        opacity,
        mask: None,
        clip_path: None,
    }
}

fn draw(recorder: &mut CommandRecorder<EngineDraw>, x: u16, y: u16, width: u16) {
    let strips = vec![
        Strip::new(x, y, 0, false),
        Strip::sentinel(y, u32::from(width) * u32::from(Tile::HEIGHT)),
    ];
    let depth = u32::try_from(recorder.draws.len()).expect("a handful of draws");
    recorder.push_draw(
        EngineDraw::new(Paint::from(RAW_RED), depth, 0..strips.len()),
        &strips,
    );
}

/// The fan-inside-a-fan `tests/schedule.rs` shows needing a fourth live page
/// (`a_sibling_pair_nested_inside_a_sibling_pair_escalates`): an outer layer
/// holding a flat child and a child carrying two children of its own.
fn nested_fan_inside_a_fan() -> CommandRecorder<EngineDraw> {
    let mut recorder = CommandRecorder::new(256, 192);
    recorder.push_layer(layer(0.5), None);
    recorder.push_layer(layer(0.5), None);
    draw(&mut recorder, 0, 16, 32);
    recorder.pop_layer();
    recorder.push_layer(layer(0.5), None);
    recorder.push_layer(layer(0.5), None);
    draw(&mut recorder, 48, 16, 32);
    recorder.pop_layer();
    recorder.push_layer(layer(0.5), None);
    draw(&mut recorder, 96, 16, 32);
    recorder.pop_layer();
    recorder.pop_layer();
    recorder.pop_layer();
    recorder
}

/// The pooled pages each round has live — its own and every one it samples —
/// which is what [`MAX_LIVE_PAGES`] bounds; the `tests/schedule.rs` live-page
/// assertion, unchanged. A retained round has no pooled page of its own, and a
/// retained composite releases none.
fn assert_pooled_pages_within_the_bound(rounds: &[Round]) {
    for round in rounds {
        let live = usize::from(round.page().is_some()) + round.released.len();
        assert!(
            live <= MAX_LIVE_PAGES,
            "no round holds more than the bound live: {round:?}"
        );
    }
}

#[test]
fn a_retained_page_does_not_count_toward_the_live_page_bound() {
    let recorder = nested_fan_inside_a_fan();
    let config = PageConfig::default();
    assert!(
        matches!(
            Schedule::build(&recorder, &caps(), &config),
            Err(EngineError::SchedulerEscalation { .. })
        ),
        "precondition: pooled throughout, the shape needs a fourth live page"
    );

    // The outer layer retained: it holds no page group, so the shape fits.
    let mut retained = RetainedLayers::new();
    retained.set(0, RetainedRole::Record { bracket: 0 });
    let rounds = Schedule::build_retained(&recorder, &caps(), &config, &retained)
        .expect("a retained outer layer takes no page group");
    assert_pooled_pages_within_the_bound(&rounds);

    let retained_rounds: Vec<_> = rounds.iter().filter_map(Round::retained).collect();
    assert!(!retained_rounds.is_empty());
    assert!(
        retained_rounds
            .iter()
            .all(|target| target.layer == 0 && target.bracket == 0)
    );
    assert!(
        rounds
            .iter()
            .all(|round| round.page().is_none_or(|page| page.layer != 0)),
        "the retained layer never takes a pooled page"
    );

    // Its composite samples the retained page and hands no group back.
    let root = rounds.last().expect("a root round");
    assert!(root.is_root());
    let composite = root
        .composites()
        .find(|composite| composite.layer == 0)
        .expect("the retained layer composites into the surface");
    assert_eq!(composite.retained.map(|source| source.bracket), Some(0));
    assert!(root.released.is_empty());

    // Every pooled layer is still composited exactly once.
    let mut composited: Vec<u32> = rounds
        .iter()
        .flat_map(Round::composites)
        .map(|c| c.layer)
        .collect();
    composited.sort_unstable();
    assert_eq!(composited, vec![0, 1, 2, 3, 4]);
}

#[test]
fn a_retained_body_is_isolated_at_full_opacity_and_rendered_at_zero() {
    let config = PageConfig::default();
    for (opacity, composites) in [(1.0, 1), (0.0, 0)] {
        let mut recorder = CommandRecorder::new(256, 192);
        recorder.push_layer(layer(opacity), None);
        draw(&mut recorder, 16, 16, 32);
        recorder.pop_layer();

        let mut retained = RetainedLayers::new();
        retained.set(0, RetainedRole::Record { bracket: 0 });
        let rounds =
            Schedule::build_retained(&recorder, &caps(), &config, &retained).expect("schedules");
        assert!(
            matches!(rounds[0].target, RoundTarget::Retained(_)),
            "opacity {opacity}: the body renders into its page"
        );
        assert_eq!(
            rounds.iter().flat_map(Round::composites).count(),
            composites,
            "opacity {opacity}"
        );

        // Without a role the same layer is the ordinary one: inlined at full
        // opacity, dropped at zero.
        let plain = Schedule::build(&recorder, &caps(), &config).expect("schedules");
        assert_eq!(plain.len(), 1);
        assert!(plain[0].is_root());
    }
}

#[test]
fn a_draw_role_is_a_composite_alone() {
    let mut recorder = CommandRecorder::new(256, 192);
    draw(&mut recorder, 0, 0, 16);
    recorder.push_layer(layer(0.5), None);
    recorder.pop_layer();
    draw(&mut recorder, 0, 8, 16);

    let dest = RectU16::new(40, 40, 72, 64);
    let mut retained = RetainedLayers::new();
    retained.set(
        0,
        RetainedRole::Draw {
            bracket: 3,
            dest,
            origin: (2, 0),
        },
    );
    let rounds = Schedule::build_retained(&recorder, &caps(), &PageConfig::default(), &retained)
        .expect("schedules");
    assert_eq!(rounds.len(), 1, "a draw renders nothing of its own");
    let ops: Vec<&RoundOp> = rounds[0].ops.iter().collect();
    assert_eq!(ops.len(), 3, "draws, the composite, draws: {ops:?}");
    let RoundOp::Composite(composite) = ops[1] else {
        panic!("the composite sits between the two draws: {ops:?}");
    };
    assert_eq!(composite.bounds, dest);
    assert_eq!(composite.source(), RectU16::new(2, 0, 34, 24));
    assert_eq!(composite.opacity, 0.5);
    assert!(rounds[0].released.is_empty());

    // Hidden: nothing at all.
    let mut hidden = RetainedLayers::new();
    hidden.set(0, RetainedRole::Hidden);
    let rounds = Schedule::build_retained(&recorder, &caps(), &PageConfig::default(), &hidden)
        .expect("schedules");
    assert_eq!(rounds[0].composites().count(), 0);
}

#[test]
fn a_key_the_frame_draws_is_not_re_recorded_in_the_same_frame() {
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    let at = Affine::translate((8.0, 8.0));
    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| record_body(builder, 1, at, HALF))),
    );
    let plan = run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| {
            draw_body(builder, 1, at, HALF, 1.0);
            record_body(builder, 1, at, HALF);
        })),
    );
    assert!(matches!(plan.decisions[0], RetainedDecision::Draw { .. }));
    assert_eq!(
        plan.decisions[1],
        RetainedDecision::Inline(RetainedRefusal::Duplicate)
    );
    assert_eq!(allocator.allocated.get(), 1);
}

#[test]
fn a_served_draw_grows_every_layer_around_it_to_hold_its_composite() {
    let allocator = FakeAllocator::default();
    let mut pages = store(1 << 20);
    run(
        &mut pages,
        &allocator,
        compile_retained(&scene_of(|builder| {
            record_body(builder, 1, Affine::translate((8.0, 8.0)), HALF);
        })),
    );

    // A translucent layer holding nothing but the drawn page: its own draws
    // cover no pixel, so without the composite folded in it would be dropped.
    let mut frame = compile_retained(&scene_of(|builder| {
        builder.push_layer(Rect::new(0.0, 0.0, 128.0, 96.0), 0.5);
        draw_body(builder, 1, Affine::translate((50.0, 30.0)), 1.0, 1.0);
        builder.pop_layer();
    }));
    assert!(
        frame.recorder.layers[0].bbox.is_empty(),
        "precondition: the enclosing layer recorded no draw"
    );
    let plan = pages
        .plan(&frame.retained, &mut frame.recorder.layers)
        .expect("served");
    let RetainedDecision::Draw { dest, .. } = plan.decisions[0] else {
        panic!("the draw is served: {plan:?}");
    };
    assert_eq!(dest, RectU16::new(50, 30, 82, 54));
    assert_eq!(
        frame.recorder.layers[0].bbox,
        RectU16::new(48, 28, 84, 56),
        "the enclosing layer now covers the composite, rounded out to tiles"
    );

    let mut roles = RetainedLayers::new();
    roles.set(
        frame.retained[0].layer,
        RetainedRole::Draw {
            bracket: 0,
            dest,
            origin: (0, 0),
        },
    );
    let rounds = Schedule::build_retained(&frame.recorder, &caps(), &PageConfig::default(), &roles)
        .expect("schedules");
    let page = rounds
        .iter()
        .find_map(Round::page)
        .expect("the enclosing layer renders a page");
    assert_eq!(page.layer, 0);
    let composite = rounds[0]
        .composites()
        .next()
        .expect("the drawn page composites into the enclosing layer's page");
    assert_eq!(composite.bounds, dest);
}