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
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
//! High-level `AwsmRenderer` type, its builder, and core impls.
//! Module tree + crate attributes live in [`crate`] (lib.rs);
//! this file holds the logic. `use crate::*` brings the crate-root
//! module names + re-exports into scope so the original crate-root-
//! relative paths resolve unchanged.
use crate::*;
use std::sync::LazyLock;
use awsm_renderer_core::{
brdf_lut::generate::{BrdfLut, BrdfLutOptions},
command::color::Color,
compatibility::CompatibilityRequirements,
cubemap::images::CubemapBitmapColors,
renderer::{AwsmRendererWebGpu, AwsmRendererWebGpuBuilder},
};
use bind_groups::BindGroups;
use camera::CameraBuffer;
use instances::Instances;
use light_buckets::LightMeshBuckets;
use lights::Lights;
use materials::Materials;
use meshes::Meshes;
use pipelines::Pipelines;
use scene_spatial::SceneSpatial;
use shaders::Shaders;
use textures::Textures;
use transforms::Transforms;
use crate::{
anti_alias::AntiAliasing,
bind_group_layout::BindGroupLayouts,
debug::AwsmRendererLogging,
environment::{Environment, Skybox},
features::RendererFeatures,
lights::ibl::{Ibl, IblTexture},
meshes::MeshKey,
picker::Picker,
pipeline_layouts::PipelineLayouts,
post_process::PostProcessing,
render_passes::{lines::LineRenderer, RenderPassInitContext, RenderPasses},
render_textures::{RenderTextureFormats, RenderTextures},
};
/// Per-frame state for the GPU coverage readback loop.
///
/// The renderer dispatches `coverage` after geometry, copies the
/// counts into a CPU-mappable buffer, and kicks a `mapAsync` that
/// resolves on a future frame. To keep the path single-buffered,
/// `inflight` short-circuits the next kick while a prior `mapAsync`
/// hasn't yet resolved; `pending_snapshot` carries the resolved
/// `(MeshKey, count)` pairs back to the next render frame which
/// calls `MeshCoverage::ingest`.
#[derive(Default)]
pub struct CoverageReadbackState {
pub inflight: bool,
pub pending_snapshot: Option<Vec<(MeshKey, u32)>>,
}
/// Per-frame state for the MSAA edge-budget overflow readback loop.
///
/// The render frame copies 8 bytes
/// (`edge_count`, `edge_overflow_count`) from
/// [`crate::render_passes::material_opaque::edge_buffers::MaterialEdgeBuffers::data_buffer`]
/// into a CPU-mappable buffer, then kicks `mapAsync`. When the read
/// resolves, the next frame's preamble inspects
/// `pending_overflow_count`: if > 0, the renderer calls
/// [`crate::AwsmRenderer::set_max_edge_budget`]`(current * 2)` so
/// subsequent frames have headroom. Single-buffered (`inflight`
/// gates the next kick) — under high mapping latency we lose one
/// frame's signal rather than ringing a buffer.
#[derive(Default)]
pub struct EdgeOverflowReadbackState {
/// `true` while a `mapAsync` is in flight against
/// `MaterialEdgeBuffers::overflow_readback_buffer`. Subsequent
/// frames skip the copy + kick until the prior resolves.
pub inflight: bool,
/// Pending `(edge_count, edge_overflow_count)` snapshot from the
/// most recently resolved `mapAsync`. Ingested at the top of the
/// next render (set to `None` after reading).
pub pending_overflow_count: Option<(u32, u32)>,
}
/// Mirror of [`EdgeOverflowReadbackState`] for the GPU light-culling
/// per-froxel capacity auto-grow loop. The cull shader atomic-adds
/// into `LightCullingBuffers::overflow_buffer` every time it bumps a
/// froxel's count past `max_per_froxel_capacity`; the host records a
/// `copy_buffer_to_buffer` into the per-frame command encoder, then
/// `mapAsync`'s the staging copy. When the resolved value is non-zero,
/// the next render preamble calls
/// [`crate::AwsmRenderer::set_max_per_froxel_capacity`]`(current * 2)`
/// so subsequent frames have headroom. Single-buffered (`inflight`
/// gates the next kick).
#[derive(Default)]
pub struct FroxelOverflowReadbackState {
/// `true` while a `mapAsync` is in flight against
/// `LightCullingBuffers::overflow_readback_buffer`. Subsequent
/// frames skip the copy + kick until the prior resolves.
pub inflight: bool,
/// Pending `overflow_count` snapshot from the most recently
/// resolved `mapAsync`. Ingested at the top of the next render
/// (set to `None` after reading).
pub pending_overflow_count: Option<u32>,
}
/// Main renderer state and GPU resources.
pub struct AwsmRenderer {
pub gpu: core::renderer::AwsmRendererWebGpu,
pub bind_group_layouts: BindGroupLayouts,
pub bind_groups: BindGroups,
pub meshes: Meshes,
pub camera: CameraBuffer,
/// Renderer-wide per-frame uniform — `time`, `delta_time`,
/// `frame_count`, `resolution`. Updated once per `render()` call and
/// bound alongside the camera uniform in every shader pass. See
/// [`crate::frame_globals`] and [`AwsmRenderer::frame_globals`].
pub frame_globals: crate::frame_globals::FrameGlobals,
pub transforms: Transforms,
pub instances: Instances,
/// Renderer-owned spatial index over every mesh's world-space AABB.
/// Mirrors `Mesh::world_aabb`. Drives camera-frustum culling,
/// per-view shadow culling, and the per-mesh light-overlap query.
pub scene_spatial: SceneSpatial,
/// Per-light → per-mesh AABB-overlap buckets, rebuilt once per
/// frame from `scene_spatial`. Feeds the per-mesh light-list shader
/// path.
pub light_buckets: LightMeshBuckets,
/// Per-frame classify-pass output. Holds the per-`shader_id` tile
/// buckets + indirect-dispatch args the opaque material pipelines
/// consume.
pub material_classify_buffers: render_passes::material_classify::buffers::ClassifyBuffers,
/// `shader_id → bucket_index` lookup table (§4a) bound read-only into
/// the classify pass — the O(1) replacement for the old per-pixel
/// `shader_id == SHADER_ID_*` if/else chain. Rebuilt only when the
/// bucket set changes (`relayout_bucket_buffers`), independent of the
/// classify buckets (which realloc on viewport resize).
pub material_bucket_lut: render_passes::material_classify::bucket_lut::MaterialBucketLut,
/// GPU light-culling froxel buffers (per-frame params uniform +
/// per-froxel counts + flat indices + overflow counter). Owned at
/// the top level so the per-frame `ensure_viewport` / `write_params`
/// / `reset_overflow` calls run before bind-group recreation.
pub light_culling_buffers: render_passes::light_culling::LightCullingBuffers,
/// Debug toggle (dev aid): when non-zero, the shading shaders output a
/// per-pixel applied-punctual-light-count heatmap instead of normal
/// shading. Written into `CullParams.debug_light_heatmap` each frame via
/// `write_params`. Owned here (not on `LightCullingBuffers`) so it
/// survives froxel-buffer recreation on resize / auto-grow.
pub light_culling_debug_heatmap: u32,
/// Global debug view mode: 0 = normal shading, 1 = unlit/flat (base color
/// only). Written into `CullParams.debug_view_mode` each frame via
/// `write_params`; no recompile. Owned here (survives froxel-buffer
/// recreation). The shader branch that reads it is compiled only under the
/// `debug-views` cargo feature; in a game build the value is written but
/// never read.
pub debug_view_mode: u32,
/// Global debug wireframe overlay: 0 = off, 1 = on. Tints pixels near a
/// triangle edge (barycentric distance) in the deferred shade. Written into
/// `CullParams.debug_wireframe` each frame; no recompile. Read only by the
/// `debug-views`-gated shader branch.
pub debug_wireframe: u32,
/// MSAA-edge-resolve buffers (Stage 3 / Priority 3 dispatch wiring).
/// `None` when MSAA is off — there are no edges to resolve. When
/// MSAA is on, holds the two split GPU buffers carrying:
///
/// - **`args_buffer`** — atomic counters + per-shader indirect
/// dispatch args. Indirect + Storage + CopyDst usage.
/// - **`data_buffer`** — `edge_to_xy` + `edge_slot_map` +
/// accumulator + per-shader/skybox sample lists. Storage +
/// CopyDst usage.
///
/// Split so a single buffer is never simultaneously bound as
/// Storage(read-write) and used as Indirect inside one compute
/// pass (WebGPU rejects that combination). Reset per-frame via
/// `MaterialEdgeBuffers::reset_header`. Resized when bucket count
/// grows past current capacity.
pub material_edge_buffers:
Option<render_passes::material_opaque::edge_buffers::MaterialEdgeBuffers>,
/// `EdgeBufferLayout` uniform companion to `material_edge_buffers`.
/// Carries the u32-stride offsets the shaders use to slice into
/// the data buffer. Same lifecycle: `None` until first MSAA boot;
/// resized on bucket-count growth.
pub material_edge_layout_uniform: Option<web_sys::GpuBuffer>,
/// Projection-decal subsystem. Owns the per-decal GPU storage
/// buffer the `material_decal` compute pass reads at shading time.
/// `None` when `features.decals == false`.
pub decals: Option<decals::Decals>,
/// GPU occlusion-cull buffers. The per-frame instance list
/// (CPU-populated) + the per-instance visibility output. `None`
/// when `features.gpu_culling == false`.
pub occlusion_buffers: Option<render_passes::occlusion::buffers::OcclusionBuffers>,
/// Per-tile decal classify buckets. Populated by a `decal_classify`
/// compute pass run before the decal shading pass; the shading pass
/// reads only the per-tile subset. `None` when
/// `features.decals == false`.
pub decal_classify_buffers:
Option<render_passes::material_decal::classify::buffers::DecalClassifyBuffers>,
/// GPU compaction `IndirectDrawArgs` buffer. `None` when
/// `features.gpu_culling == false`.
pub compaction_buffers: Option<render_passes::occlusion::compaction::CompactionBuffers>,
/// Last-frame per-mesh pixel coverage. Populated by the GPU
/// coverage compute pass via `coverage_buffers` + asynchronous
/// readback; consumed by skin-skip / material-LOD gates. The
/// table itself is always present (it's CPU-only and tiny); when
/// `features.coverage_lod == false` it just stays empty, which
/// makes `is_below_threshold` return `false` for everything.
pub coverage: coverage::MeshCoverage,
/// GPU coverage producer buffers. The producer pass
/// (`render_passes/coverage/`) atomic-adds per-pixel into
/// `counts_buffer`; the renderer copies to `readback_buffer`
/// each frame and a `mapAsync` resolves with last-frame's
/// counts on a future frame. The result feeds
/// [`crate::coverage::MeshCoverage::ingest`]. `None` when
/// `features.coverage_lod == false`.
pub coverage_buffers: Option<render_passes::coverage::buffers::CoverageBuffers>,
/// State for the coverage readback loop. `Arc<Mutex<…>>` so the
/// `spawn_local`-detached `mapAsync` future can write back into
/// it without re-borrowing the renderer — and so it stays
/// future-proof for the day the renderer moves across threads
/// (single-threaded today, so the lock is uncontested).
pub coverage_readback_state: std::sync::Arc<std::sync::Mutex<CoverageReadbackState>>,
/// State for the MSAA edge-budget auto-grow readback loop. Same
/// `Arc<Mutex<…>>` discipline as `coverage_readback_state` —
/// `mapAsync` writes through the lock from a detached
/// `spawn_local` future.
pub edge_overflow_readback_state: std::sync::Arc<std::sync::Mutex<EdgeOverflowReadbackState>>,
/// State for the GPU light-culling per-froxel capacity auto-grow
/// loop. Same `Arc<Mutex<…>>` discipline as the other readback
/// states.
pub froxel_overflow_readback_state:
std::sync::Arc<std::sync::Mutex<FroxelOverflowReadbackState>>,
/// Monotonic frame index. Wraps every ~272 years at 60 Hz — safe to
/// treat as unbounded for any practical session. Drives the
/// `skin_update_period` gate and other "every Nth frame" cadences.
pub frame_index: u64,
pub shaders: Shaders,
pub materials: Materials,
/// Runtime-registered dynamic materials. See
/// [`crate::dynamic_materials`].
pub dynamic_materials: crate::dynamic_materials::DynamicMaterials,
/// Set when a custom material registers/unregisters or its alpha-only WGSL
/// changes, so the next `finalize_gpu_textures` rebuilds the masked
/// (alpha-tested) pipelines for MASK customs even if no texture changed
/// (a procedural cutout needs no texture). Cleared by `finalize_gpu_textures`.
pub masked_dynamic_dirty: bool,
/// Renderer-wide variable-length per-material data pool. Backs
/// `BufferSlot` declarations on registered dynamic materials.
pub extras_pool: crate::dynamic_materials::extras_pool::ExtrasPool,
pub pipeline_layouts: PipelineLayouts,
pub pipelines: Pipelines,
pub lights: Lights,
pub textures: Textures,
pub logging: AwsmRendererLogging,
pub render_textures: RenderTextures,
pub render_passes: RenderPasses,
pub environment: Environment,
pub anti_aliasing: AntiAliasing,
/// Plan B shared-prep + deferred-shadow config, captured at build time
/// (`docs/plans/deferred-shared-prep-pass.md`). The shared prep pass is
/// unconditional; this only carries the `K` shadow-caster sizing knob.
pub prep_config: crate::render_passes::material_prep::PrepPassConfig,
pub post_processing: PostProcessing,
/// GPU mesh-picking subsystem. `None` when
/// `features.picking == false` (the default for library /
/// game builds). When `None`, [`Self::pick`] returns
/// [`crate::picker::PickResult::Disabled`].
pub picker: Option<Picker>,
pub lines: LineRenderer,
/// Auto-drive state for re-resolving HUD meshes' transparent
/// pipeline variants when a HUD mesh appears or the texture-pool /
/// MSAA shape changes. `None`-cost for builds that never insert a
/// HUD mesh (gated on `Meshes::has_seen_hud`). See
/// [`crate::render`]'s `kick_hud_resolve` / `poll_hud_resolve`.
pub(crate) hud_resolve: crate::render::HudResolveState,
/// Per-frame mipmap generator for the opaque RT — only dispatched
/// when the visible material set contains a transmissive material.
pub opaque_mipgen: opaque_mipgen::OpaqueMipgen,
/// Shadow mapping subsystem. Owns the depth atlas, EVSM atlas,
/// cube-array pool, descriptors, and the comparison / filterable
/// samplers used by the shadow-aware shading passes.
pub shadows: shadows::Shadows,
/// Opt-in feature gates picked at construction time.
pub features: RendererFeatures,
/// Adaptive runtime policy on top of `features`. `RendererFeatures`
/// decides which buffers/passes exist; `RendererOptimizationPolicy`
/// decides which of those are engaged this frame. Mutable via
/// `set_optimization_policy` — flips take effect on the next
/// `render()` call.
pub optimization_policy: crate::optimization_policy::RendererOptimizationPolicy,
/// Most recently computed per-frame derived flags. Used as the
/// previous-frame state for the next call to
/// `compute_frame_optimizations` (hysteresis input).
pub frame_optimizations: crate::optimization_policy::FrameOptimizations,
/// Consecutive frames the current `gpu_occlusion` mode has held.
/// Bumped each frame `frame_optimizations.gpu_occlusion` stays the
/// same; reset to 1 on a flip. Feeds the Auto-mode cooldown check
/// in `compute_frame_optimizations`.
pub frames_in_current_mode: u32,
/// Global default for `Mesh::cheap_material_pixel_threshold`.
/// Per-mesh override still wins; this is the value used when a
/// mesh has its threshold set to `None`.
/// Default `64`. Games tying material LOD to their own quality
/// system can write this directly each frame; no automatic
/// coupling to `ShadowQualityTier` (which is per-light, not
/// global).
pub default_cheap_material_pixel_threshold: u32,
/// Reusable scratch space for the per-frame renderable lists.
/// Held here (not constructed per-frame) so the Vec allocations
/// survive across frames; `collect_renderables` clears-in-place.
pub(crate) renderable_pool: crate::renderable::RenderablePool,
/// Pipeline-readiness scheduler. Owns the `FuturesUnordered` that
/// drives async compile, the SlotMap of material groups, and the
/// per-pass-kind map. Per the architecture in
/// `https://github.com/dakom/awsm-renderer/pull/99`, frontends submit
/// [`crate::pipeline_scheduler::PipelineGroupDef`]s, get [`crate::pipeline_scheduler::PipelineGroupId`]s back
/// immediately, and watch for status transitions via
/// `drain_pipeline_status_events` or `pipeline_group_status`.
///
/// **Stage 1 status**: the scheduler is attached; the public API
/// surface (`submit_pipeline_group_batch`, `pipeline_group_status`,
/// `drain_pipeline_status_events`, `drop_material_group`,
/// `poll_pipeline_scheduler`) is wired below this struct. Compile
/// futures are currently stubs — Stage 1 follow-up wires each
/// `PipelineGroupDef` variant to the real compile path.
pub pipeline_scheduler: crate::pipeline_scheduler::PipelineScheduler,
/// Bucket-layout fingerprint of the last `ensure_scene_pipelines`
/// run. The render-driven compile path
/// ([`crate::AwsmRenderer::ensure_scene_pipelines`]) compares the
/// live bucket list's `dispatch_hash` + entry count against this to
/// decide whether the bucket SET changed (a new dynamic material
/// registered, a feature-set variant allocated, a material removed)
/// — which requires resizing the classify / edge GPU buffers +
/// rebuilding the edge-layout uniform + clearing the stale
/// layout-keyed pipeline caches BEFORE compiling against the new
/// layout. `None` until the first ensure. See
/// `ensure_scene_pipelines` for the ordering invariant.
pub(crate) last_ensured_bucket_layout: Option<(u64, usize)>,
/// True once `AwsmRendererBuilder::build` has finished its eager
/// batch. Config-change APIs (`set_anti_aliasing`,
/// `set_post_processing`) gate on this and return
/// [`crate::error::AwsmError::NotReady`] when called before. Per
/// the architecture doc's race policy.
pub(crate) build_complete: bool,
/// Recommended `ShadowQualityTier` set by the active
/// [`crate::profile::RendererProfile`]. Scene-side code that
/// registers shadow-casting lights should apply the matching
/// `LightShadowParams` preset to keep per-light shadow knobs
/// (cascade count, hardness, EVSM cutoff) coherent with the
/// rest of the profile's defaults. `None` when no profile was
/// applied.
pub recommended_shadow_quality_tier: Option<crate::shadows::ShadowQualityTier>,
// we pick between these on the fly.
// `pub(crate)` (not private) because `AwsmRenderer` now lives in the
// `renderer` submodule rather than the crate root: sibling modules
// (e.g. `render.rs`) read these directly, which previously worked via
// the private-at-crate-root → visible-to-all-descendants rule. Crate
// visibility is identical to before; external API is unchanged.
pub(crate) _clear_color_perceptual_to_linear: Color,
pub(crate) _clear_color: Color,
#[cfg(feature = "animation")]
pub animations: animation::Animations,
/// Per-camera authorable parameter store (projection, clip planes,
/// depth-of-field). Driven by `AnimationTarget::Camera` channels.
pub cameras: crate::cameras::Cameras,
/// Reused per-frame scratch for the cull path's mesh-count-scaling
/// allocations (opaque-snapshot list + packed occlusion-instance bytes).
/// `take`/restored across each `render()` to avoid per-frame allocator/GC
/// churn at high mesh counts. See [`crate::render::RenderFrameScratch`].
pub(crate) render_frame_scratch: crate::render::RenderFrameScratch,
/// The load-transaction render gate. `false` at build and after
/// [`AwsmRenderer::begin_load`] (show the loading screen); set `true` by
/// [`AwsmRenderer::commit_load`] once the scene's pipelines are compiled.
/// `render()` dispatches to `render_all` when true, `render_loading` (clear
/// only) when false. This is the WHOLE render-gate state — there is no
/// reactive per-frame compile to reason about (the old render-preamble
/// `reconcile_material_variants` → `ensure_scene_pipelines` compile now lives
/// only in `commit_load`).
pub(crate) scene_committed: bool,
/// Live phase of the in-flight (or last) [`AwsmRenderer::commit_load`], read
/// back by [`AwsmRenderer::loading_stats`] for imperative pollers.
pub(crate) load_phase: crate::loading::LoadPhase,
/// Texture-pool counts the current/last commit is uploading. Set by
/// `commit_load` around its single `finalize_gpu_textures`; surfaced through
/// `LoadingStats` so a loader can show texture-upload progress.
pub(crate) loading_textures_total: usize,
pub(crate) loading_textures_uploaded: usize,
/// Geometry-resolution counts for the current/last commit (the
/// `UploadingGeometry` phase) — surfaced through `LoadingStats` for granular
/// loading UI.
pub(crate) loading_geometry_total: usize,
pub(crate) loading_geometry_uploaded: usize,
/// Immutable snapshot of every build-time config knob, captured in `build()`.
/// [`AwsmRenderer::remove_all`] rebuilds from it so a scene-data wipe can't
/// drift a config. See [`RendererConfigSpec`].
pub(crate) config_spec: RendererConfigSpec,
}
/// Compatibility requirements for this renderer.
///
/// `storage_buffers` is the worst-case `maxStorageBuffersPerShaderStage`
/// the opaque-material pass needs. Opaque currently binds:
/// * 8 storage buffers in `@group(0)`: visibility_data,
/// material_mesh_metas, materials, attribute_indices,
/// attribute_data, transforms (packed model + normal — Option E),
/// texture_transforms, instance_attrs.
/// * 1 storage buffer in `@group(1)`: lights_storage (the GPU cull
/// pass's per-froxel light slices).
///
/// Total = 9, leaving 1 spare under a 10-buffer limit. lights +
/// lights_info are uniforms in group(1) (Option F); shading reads the
/// per-pixel froxel light list from `lights_storage`, so no separate
/// per-mesh slices storage buffer is needed. The transparent pass
/// peaks at 9. Bumping this lower than
/// the binding count will pass adapter compatibility on a device that
/// exactly meets the declared limit, then fail pipeline validation
/// when the shader is compiled.
///
/// ## Dynamic-materials `extras_pool` slot
///
/// The 10th storage-buffer slot is reserved for the `extras_pool`
/// buffer that backs `BufferSlot` declarations on registered custom
/// materials. The pool itself is documented at
/// `crates/renderer/src/dynamic_materials/extras_pool.rs`; the
/// per-binding wiring lives in the opaque + transparent passes'
/// `bind_groups.wgsl` (binding 23 / 19 respectively).
pub static COMPATIBITLIY_REQUIREMENTS: LazyLock<CompatibilityRequirements> =
LazyLock::new(|| CompatibilityRequirements {
storage_buffers: Some(10),
});
impl AwsmRenderer {
/// Removes all scene data by rebuilding the renderer state.
///
/// Preserves every field the user picked at build time — both the
/// historical set (`logging`, `clear_color`, `render_texture_formats`,
/// `features`, `optimization_policy`) and the
/// [`crate::profile::RendererProfile`]-derived bundle
/// (`anti_aliasing`, `post_processing`, `shadows_config`,
/// `max_edge_budget`, `scene_spatial_config`,
/// `recommended_shadow_quality_tier`). Forwarding the *current
/// values* rather than re-resolving the profile means any
/// post-profile per-knob override the frontend chained on top is
/// preserved too — `remove_all` is a scene-data wipe, not a
/// config-reset.
pub async fn remove_all(&mut self) -> crate::error::Result<()> {
// Scene-data wipe = rebuild from the build-time config snapshot. ONE line,
// no hand-copy, no drift: `config_spec` captured EVERY `with_*` knob at
// `build()`, so this can't silently drop a config the way the old
// field-by-field copy did (it dropped bucket cap / shadow-K / brdf-lut /
// env colors across this boundary). Scene content — meshes, lights, the
// live IBL/skybox textures — is intentionally NOT carried; the caller
// reloads the scene + re-sets the environment. See `RendererConfigSpec`.
*self = AwsmRendererBuilder::from_spec(self.gpu.clone(), self.config_spec.clone())
.build()
.await?;
Ok(())
}
// =====================================================================
// The load transaction: begin_load → adds →
// commit_load. The ONE public way to get content compiled + on screen.
// =====================================================================
/// Request the loading screen until the next commit: sets
/// `scene_committed = false` so `render()` clears to the clear-color (a
/// loading overlay draws on top) instead of drawing a half-compiled scene.
///
/// Call this before a **cold / full load**. **SKIP it for a live add** —
/// leaving `scene_committed` true keeps the existing scene on screen while
/// the new content compiles in the background; the new meshes simply aren't
/// drawn until the matching `commit_load` resolves.
pub fn begin_load(&mut self) {
self.scene_committed = false;
self.load_phase = crate::loading::LoadPhase::Idle;
}
/// THE single compile point of the load transaction. Finalizes the texture
/// pool ONCE, resolves material variants, kicks every needed pipeline
/// compile, drains them CONCURRENTLY (`FuturesUnordered`), reports progress
/// through `on_progress`, and sets `scene_committed = true`. Identical code
/// for cold-load, full-reload, and live add — the only differences are the
/// app's choices to call `begin_load` and to `await` (or not) this future.
///
/// Cheap no-op when nothing changed since the last commit (the content-keyed
/// caches make finalize + every compile a hit).
pub async fn commit_load(
&mut self,
mut on_progress: impl FnMut(crate::loading::LoadingStats),
) -> crate::error::Result<crate::loading::LoadingStats> {
use crate::loading::{LoadPhase, LoadingStats};
// ── Phase 0: resolve geometry — derive + upload each registered geometry's
// needed pass representations (visibility/transparency) from the union of
// its bound materials, ONCE each, then free the source (§1 ②). Runs first
// so meshes have their buffers before the texture/compile phases. (The
// resolution body + the bindings it consumes land with the add_mesh
// deferral; today the registry is empty so this just reports the phase.)
self.load_phase = LoadPhase::UploadingGeometry;
self.resolve_geometry(&mut on_progress)?;
// ── Phase 1: finalize the texture pool ONCE (the single batched GPU
// upload of every staged image). Ordered FIRST — every
// opaque/classify/edge pipeline's shader bakes in
// `texture_pool_arrays_len`, so compiling before the pool is final
// would compile against a stale pool that finalize then wipes,
// forcing the recompile this design exists to delete. finalize-first
// ⇒ the compile in phase 2 runs exactly ONCE against the final pool.
// (The spec lists reconcile before finalize, but reconcile *embeds*
// the compile-kick, so finalize must precede it to hit the §7
// "one edge compile per load" goal.)
self.load_phase = LoadPhase::FinalizingTextures;
self.loading_textures_total = self.textures.resource_counts().0;
self.loading_textures_uploaded = 0;
on_progress(self.loading_stats());
self.finalize_gpu_textures().await?;
self.loading_textures_total = self.textures.resource_counts().0;
self.loading_textures_uploaded = self.loading_textures_total;
on_progress(self.loading_stats());
// ── Phase 2: resolve PBR/Toon feature-set variants against the now-final
// textures and kick the scene's pipeline compiles. This is the moved
// render-preamble compile: `reconcile_material_variants` internally
// drives `ensure_scene_pipelines` (opaque + classify + edge) — run
// ONLY here now, never per render frame.
self.reconcile_material_variants()?;
// ── Phase 3: drain every kicked compile to completion CONCURRENTLY,
// mapping each resolution into `LoadingStats`. This reuses the
// existing concurrent drain (which also warms the transparent + line
// pipelines) — it is not reimplemented here.
self.load_phase = LoadPhase::Compiling;
let textures_total = self.loading_textures_total;
let geometry_total = self.loading_geometry_total;
self.drain_commit_compiles(|cp| {
on_progress(LoadingStats::from_parts(
LoadPhase::Compiling,
geometry_total,
geometry_total,
textures_total,
textures_total,
cp,
));
})
.await?;
// ── Phase 4: committed — `render()` switches to `render_all`.
self.scene_committed = true;
self.load_phase = LoadPhase::Ready;
let final_stats = self.loading_stats();
on_progress(final_stats);
Ok(final_stats)
}
/// Phase 0 of [`Self::commit_load`]: derive + upload each registered geometry's
/// needed pass representations (visibility / transparency) from the union of its
/// bound materials — once each — then free the source (§1 ②).
///
/// The resolution body + the mesh→geometry bindings it consumes land with the
/// `add_mesh` deferral; today the geometry registry is empty (producers still use
/// the legacy eager `insert`), so this reports the phase over a 0-count registry.
fn resolve_geometry(
&mut self,
on_progress: &mut impl FnMut(crate::loading::LoadingStats),
) -> crate::error::Result<()> {
let total = self.meshes.geometry_count();
self.loading_geometry_total = total;
self.loading_geometry_uploaded = 0;
on_progress(self.loading_stats());
// Derive + upload each geometry's needed representations once (per the union
// of its bound materials), wire the bound meshes to the shared resource, and
// free the source. Then sync each newly-resolved mesh into the spatial index
// (deferred to here so skinned meshes flag correctly — the resource exists now).
let wired = self
.meshes
.resolve_geometry(&self.materials, &self.transforms)?;
for mesh_key in wired {
self.sync_spatial_for_mesh(mesh_key);
}
self.loading_geometry_uploaded = total;
on_progress(self.loading_stats());
Ok(())
}
/// Imperative snapshot of the same `LoadingStats` that `commit_load`'s
/// `on_progress` reports — for pollers driving a loading UI off a render-loop
/// tick rather than the callback.
pub fn loading_stats(&self) -> crate::loading::LoadingStats {
crate::loading::LoadingStats::from_parts(
self.load_phase,
self.loading_geometry_total,
self.loading_geometry_uploaded,
self.loading_textures_total,
self.loading_textures_uploaded,
self.compile_progress(),
)
}
/// Returns the active feature gates picked at construction time.
pub fn features(&self) -> &RendererFeatures {
&self.features
}
/// Force-compile the routinely-used WebGPU pipelines ahead of the
/// first user-interactive frame, so the first draw doesn't stall
/// on shader compilation, exploiting the browser's PSO cache so the
/// driver reuses already-compiled pipeline state objects.
///
/// ## What's already prewarmed at construction time
///
/// `AwsmRendererBuilder::build()` already compiles, in parallel:
///
/// - **Opaque-compute** material kernels — only the empty kernel for the
/// active MSAA (the no-meshes / skybox-only fallback). The first-party
/// material shaders (PBR / Unlit / Toon / Flipbook) are **NOT** compiled
/// at boot — they compile lazily on first use via
/// [`Self::ensure_scene_pipelines`], so a project that uses none of them
/// pays zero material-shader compile cost at startup. See the
/// `MaterialOpaquePipelines` module docs + `shader_descriptors_and_layouts`.
/// - **Geometry render pipelines** — every (MSAA × instancing ×
/// storage-array × cull_mode) variant. See
/// `GeometryRenderPipelineKeys::new`.
/// - **Shadow / HZB / coverage / decal / classify / light-culling**
/// passes — all built once during `RenderPasses::new`.
///
/// So this method is **mostly a labelling hook today** — its real
/// payoff is the call-site UX: a consumer can advance their boot
/// loader to "Compiling shaders…" before this call and back to
/// "Loading assets…" after, giving users a precise progress
/// indicator over the multi-hundred-ms shader-compile window that
/// previously appeared as a generic "Initializing renderer…".
///
/// ## What this method does today
///
/// - **Builder-time prewarm** has already compiled the empty-opaque kernel,
/// the geometry passes, hzb, material_classify, effects, decal, shadows,
/// and the picker / line variants — but **not** the first-party material
/// pipelines (those are lazy). Calling this at the end of `build()` kicks
/// `ensure_scene_pipelines`, which compiles whatever the *live* scene
/// actually needs (none, on an empty scene); cached keys return
/// immediately.
///
/// - **Per-scene transparent prewarm** runs whenever the caller
/// invokes this method after meshes have been populated. It
/// walks `self.meshes`, deduplicates by
/// `(buffer_info, material)` (the granularity the transparent
/// pipeline cache keys against), and issues one batched
/// `ensure_keys` covering every unique transparent shader +
/// pipeline variant the live scene needs. The first transparent
/// draw then hits warm cache instead of stalling on N
/// `createRenderPipelineAsync` awaits. Mirrors what
/// `finalize_gpu_textures` does on a texture-pool-dirty cycle;
/// safe to call any number of times (subsequent calls are
/// cache-hit no-ops).
///
/// ## When the warm prewarm helps vs not
///
/// The transparent shader/pipeline cache key includes
/// `texture_pool_arrays_len` + `texture_pool_samplers_len`. Those
/// values change every time a *new texture array shape* enters the
/// pool — which on a fresh load happens once when the first model's
/// textures finalize, and then never again for the same scene.
/// So:
///
/// - If the caller invokes `prewarm_pipelines()` **before any
/// models are loaded** (the historical pattern), the texture
/// pool is empty (`arrays_len = 0`), and any pipelines warmed
/// here are invalidated the moment the first model finishes
/// loading and the pool grows. The call is a no-op for that
/// case — only its tracing span fires.
/// - If the caller invokes it **after a model has loaded** (or
/// the texture-pool capacity is otherwise pinned at the value
/// the scene will actually use), the warmed pipelines are the
/// real ones the renderer will draw with. This is the case
/// that absorbs the per-mesh first-draw stall when *switching*
/// between models that share the texture-pool shape but
/// introduce new geometry attribute combinations.
///
/// ## Idempotent + cheap on warm cache
///
/// Calling this multiple times is a no-op past the first
/// invocation: every underlying `ensure_keys` is a cache-keyed
/// lookup. On a Chrome session with a warm GPU disk cache, the
/// whole call completes in <5 ms. On a cold cache (post-redeploy
/// first-ever visit) it costs 50–500 ms per N transparent
/// variants — the same compile tax the first draw would have
/// paid, just relocated to a phase the consumer can label
/// clearly.
///
/// ## Material pipelines (classify / opaque / edge resolve)
///
/// These are compiled by the single render-driven operation
/// [`Self::ensure_scene_pipelines`], which this method kicks once up
/// front so the awaited readiness path (`wait_for_pipelines_ready`)
/// has promises to drain. It covers every live bucket (first-party
/// canonical, PBR/Toon feature-set variants, and custom dynamic
/// materials) at the active AA config; idempotent on cache hits.
pub(crate) async fn prewarm_pipelines(&mut self) -> crate::error::Result<()> {
let _maybe_span = if self.logging.render_timings.sub_frame() {
Some(tracing::span!(tracing::Level::INFO, "Prewarm Pipelines").entered())
} else {
None
};
// Material pipelines (classify / opaque / per-shader + skybox +
// final_blend edge resolve) are compiled by THE single render-driven
// operation: `ensure_scene_pipelines`. Kick it here so the up-front
// warm path (`wait_for_pipelines_ready`) has the promises in flight
// to drain. It compiles only the ACTIVE config's variants for every
// live bucket (incl. PBR feature-set variants — they live in
// `bucket_entries` even with an empty custom registry), handles any
// bucket-SET change (resize buffers + clear stale caches first), and
// is idempotent on a warm cache. The edge-resolve set is rebuilt
// inside it via the same `MaterialEdgePipelines::build_descriptors` /
// `desired_keys` path the background relaunch uses, so the two never
// diverge.
self.ensure_scene_pipelines()?;
// Build one request per mesh. `ensure_keys` on both caches
// dedupes internally by cache key, so we don't need to
// dedupe at the request level — and dedup'ing here by
// `(buffer_info, material)` OR-style (the previous
// pre-existing pattern) misses pairs like (A,M1)(B,M2)(A,M2)
// when M1 and M2 differ in `writes_depth`, which would
// leave some meshes with stale pipeline-key map entries.
let mut requests: Vec<
crate::render_passes::material_transparent::pipeline::TransparentMeshPipelineRequest,
> = Vec::new();
for (mesh_key, mesh) in self.meshes.iter() {
// Only warm transparent pipelines for transparent-pass meshes — an
// opaque (incl. opaque-dynamic) material can't compile against the
// transparent fragment contract.
if !self.materials.is_transparency_pass(mesh.material_key) {
continue;
}
let buffer_info_key = self.meshes.buffer_info_key(mesh_key)?;
let writes_depth = self.materials.transparent_writes_depth(mesh.material_key);
let (base, pbr_features) = self.materials.transparent_variant(mesh.material_key);
let dynamic_shader_id = matches!(base, crate::dynamic_materials::ShadingBase::Custom)
.then(|| self.materials.shader_id(mesh.material_key));
let dynamic_shader =
dynamic_shader_id.and_then(|id| self.dynamic_materials.shader_info_for(id));
let dynamic_vertex_shader =
dynamic_shader_id.and_then(|id| self.dynamic_materials.vertex_shader_info_for(id));
requests.push(
crate::render_passes::material_transparent::pipeline::TransparentMeshPipelineRequest {
mesh,
mesh_key,
buffer_info_key,
writes_depth,
base,
pbr_features,
dynamic_shader_id,
dynamic_shader,
dynamic_vertex_shader,
},
);
}
if requests.is_empty() {
return Ok(());
}
self.render_passes
.material_transparent
.pipelines
.set_render_pipeline_keys_batched(
&self.gpu,
requests,
&mut self.shaders,
&mut self.pipelines,
&self.render_passes.material_transparent.bind_groups,
&self.pipeline_layouts,
&self.meshes.buffer_infos,
&self.anti_aliasing,
&self.textures,
&self.render_textures.formats,
)
.await?;
Ok(())
}
/// Returns the current adaptive policy.
pub fn optimization_policy(&self) -> &crate::optimization_policy::RendererOptimizationPolicy {
&self.optimization_policy
}
/// Replaces the adaptive policy. Takes effect on the next
/// `render()`. If the new policy disables `gpu_occlusion`
/// (Force→Off, or Auto's hysteresis later landing there), the next
/// frame's `compute_frame_optimizations` will flip
/// `frame_optimizations.gpu_occlusion = false`, which render.rs
/// uses to poison `compaction_buffers.args_ready` — so a future
/// re-enable warms up through the CPU geometry path for one frame
/// before drawIndirect resumes.
pub fn set_optimization_policy(
&mut self,
policy: crate::optimization_policy::RendererOptimizationPolicy,
) {
// Reset cooldown when the mode itself changes — flipping from
// Auto to Force (or vice versa) shouldn't be held off by a
// residual Auto cooldown counter.
if policy.gpu_culling != self.optimization_policy.gpu_culling {
self.frames_in_current_mode = u32::MAX / 2;
}
self.optimization_policy = policy;
}
/// Aggregate Phase-2.1 upload-ring telemetry across every
/// renderer subsystem with a `MappedUploader`. Returned as a
/// `(label, stats)` list so a caller (e.g. a dev telemetry export)
/// can render per-subsystem + rolled-up totals.
pub fn upload_ring_stats(
&self,
) -> Vec<(
&'static str,
crate::buffer::mapped_staging_ring::UploadStats,
)> {
let mut v = vec![
("transforms", self.transforms.upload_stats()),
("materials", self.materials.upload_stats()),
(
"instances.transforms",
self.instances.transform_upload_stats(),
),
(
"instances.attributes",
self.instances.attribute_upload_stats(),
),
(
"meshes.meta.geometry",
self.meshes.meta.geometry_upload_stats(),
),
(
"meshes.meta.material",
self.meshes.meta.material_upload_stats(),
),
(
"meshes.skins.matrices",
self.meshes.skins.matrices_upload_stats(),
),
(
"meshes.skins.joint_index_weights",
self.meshes.skins.joint_index_weights_upload_stats(),
),
(
"meshes.morphs.geometry.weights",
self.meshes.morphs.geometry.weights_upload_stats(),
),
(
"meshes.morphs.geometry.values",
self.meshes.morphs.geometry.values_upload_stats(),
),
(
"meshes.morphs.material.weights",
self.meshes.morphs.material.weights_upload_stats(),
),
(
"meshes.morphs.material.values",
self.meshes.morphs.material.values_upload_stats(),
),
(
"textures.transforms",
self.textures.texture_transforms_upload_stats(),
),
("meshes.pool", self.meshes.upload_stats()),
// Phase-2.1 raw-writeBuffer promotions (this sprint):
("camera", self.camera.upload_stats()),
("frame_globals", self.frame_globals.upload_stats()),
("lights", self.lights.upload_stats()),
("shadows", self.shadows.upload_stats()),
];
if let Some(occ) = self.occlusion_buffers.as_ref() {
v.push(("occlusion", occ.upload_stats()));
}
v
}
}
/// Coarse-grained stages the renderer passes through during
/// [`AwsmRendererBuilder::build`]. Subscribers passed via
/// [`AwsmRendererBuilder::with_phase_handler`] get a callback at each
/// transition; consumer UIs can map these to whatever progress
/// message they want to show.
///
/// The most useful UX win these surface is the **cold WebGPU cache**
/// case: a fresh Chrome profile can sit on `CompilingShaders` for
/// tens of seconds while Dawn + the GPU driver lower every shader to
/// MSL on the first visit. Showing "Browser is compiling shaders…
/// (first load may take a while)" rather than a frozen "Initializing
/// renderer…" is the difference between a user assuming the app is
/// broken and a user knowing the browser is doing real work that
/// will be cached next time.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum RendererLoadingPhase {
/// Adapter / device acquisition + initial bookkeeping +
/// supporting GPU resource generation (IBL default cubemaps,
/// BRDF LUT compute, opaque-mipgen pipeline) + render-pass
/// shader cache key collection. No Dawn shader / pipeline
/// compile work in this phase — it's the concurrent setup that
/// feeds the cross-renderer pool.
Init,
/// The cross-renderer shader pool is running:
/// one `Shaders::ensure_keys` covering every shader the
/// renderer compiles (RenderPasses + Picker + LineRenderer +
/// Shadows caster + Effects + Display), joined with EVSM
/// inline-shader `validate_shader` futures. On a cold PSO disk
/// cache this is where Dawn lowers WGSL → MSL; on a warm cache
/// it's a cache-hit lookup.
CompilingShaders,
/// The cross-renderer pipeline pool is running: one
/// `try_join`'d `ComputePipelines::ensure_keys` +
/// `RenderPipelines::ensure_keys` covering every compute and
/// render pipeline across the entire renderer.
BuildingPipelines,
/// All renderer-init work done; ready to render.
Ready,
}
/// Boxed phase-transition callback handed to the builder via
/// [`AwsmRendererBuilder::with_phase_handler`]. wasm is
/// single-threaded so we don't need `Send + Sync`.
pub type RendererLoadingPhaseHandler = Box<dyn FnMut(RendererLoadingPhase)>;
/// Immutable snapshot of every build-time config knob the embedder chose — the
/// declare→commit-for-config analog of the load transaction. Captured at
/// `build()` and stored on [`AwsmRenderer`]; [`AwsmRenderer::remove_all`]
/// rebuilds straight from it via [`AwsmRendererBuilder::from_spec`], so a
/// scene-data wipe can NEVER silently drop a config (the historical hand-copy
/// in `remove_all` repeatedly did — bucket cap, shadow-K, brdf-lut, env colors).
///
/// Mirrors the builder's raw inputs exactly (the `Option`s + the depth override),
/// not resolved values, so `from_spec(...).build()` re-runs identical resolution.
/// The only builder fields NOT captured are `gpu` (passed to `from_spec`
/// separately) and `phase_handler` (a non-clonable callback irrelevant to a
/// rebuild). Add a field here whenever a new build-time `with_*` knob is added.
#[derive(Clone)]
pub struct RendererConfigSpec {
logging: AwsmRendererLogging,
render_texture_formats: Option<RenderTextureFormats>,
brdf_lut_options: BrdfLutOptions,
clear_color: Color,
skybox_colors: CubemapBitmapColors,
ibl_filtered_env_colors: CubemapBitmapColors,
ibl_irradiance_colors: CubemapBitmapColors,
anti_aliasing: AntiAliasing,
post_processing: PostProcessing,
shadows_config: Option<shadows::ShadowsConfig>,
features: RendererFeatures,
max_edge_budget: Option<u32>,
bucket_config: Option<crate::dynamic_materials::BucketConfig>,
prep_config: crate::render_passes::material_prep::PrepPassConfig,
optimization_policy: crate::optimization_policy::RendererOptimizationPolicy,
scene_spatial_config: Option<crate::scene_spatial::SceneSpatialConfig>,
recommended_shadow_quality_tier: Option<crate::shadows::ShadowQualityTier>,
render_texture_formats_depth_override: Option<awsm_renderer_core::texture::TextureFormat>,
}
/// Builder for `AwsmRenderer`.
pub struct AwsmRendererBuilder {
gpu: AwsmRendererGpuBuilderKind,
logging: AwsmRendererLogging,
render_texture_formats: Option<RenderTextureFormats>,
brdf_lut_options: BrdfLutOptions,
clear_color: Color,
// all these colors are typically replaced when loading external textures
// but we want something to show by default
skybox_colors: CubemapBitmapColors,
ibl_filtered_env_colors: CubemapBitmapColors,
ibl_irradiance_colors: CubemapBitmapColors,
anti_aliasing: AntiAliasing,
post_processing: PostProcessing,
/// Renderer-wide shadow config picked up at construction time.
/// Resource-shaped fields (`atlas_size`, `point_shadow_resolution`,
/// `max_point_shadows`, `evsm_atlas_size`) are baked into the
/// shadow textures; runtime tweaks of those need a renderer
/// rebuild. Defaults via `ShadowsConfig::default()` if unset.
shadows_config: Option<shadows::ShadowsConfig>,
/// Opt-in feature gates. Defaults to both flags `false` so library
/// consumers pay zero cost for unused GPU-driven culling / decal
/// infrastructure.
features: RendererFeatures,
/// Block C.2: optional override for the
/// [`MaterialEdgeBuffers`](crate::render_passes::material_opaque::edge_buffers::MaterialEdgeBuffers)
/// `MAX_EDGE_BUDGET`. `None` → platform default (desktop). Set
/// via [`AwsmRendererBuilder::with_max_edge_budget`] to grow the
/// edge budget upfront for pathological-edge-density scenes
/// (dense foliage at 4K, etc.). Consumers monitoring
/// edge_overflow_count via CPU readback can also grow the budget
/// at runtime via [`AwsmRenderer::set_max_edge_budget`].
max_edge_budget: Option<u32>,
/// Registration ceiling for co-resident material buckets (§2). `None`
/// → default 32 (identical to today). Set via
/// [`AwsmRendererBuilder::with_bucket_config`]; validated `1..=65534`.
bucket_config: Option<crate::dynamic_materials::BucketConfig>,
/// Plan B shared-prep + deferred-shadow config
/// (`docs/plans/deferred-shared-prep-pass.md`). Inert until the prep pass is
/// wired in; `enabled` defaults `false` (legacy recompute-in-shader path).
prep_config: crate::render_passes::material_prep::PrepPassConfig,
/// Adaptive runtime policy. Defaults to `Auto` mode for the
/// gpu_culling path; library consumers can override at build time
/// (or via `AwsmRenderer::set_optimization_policy` later) to force
/// the path on/off or to retune the Auto thresholds.
optimization_policy: crate::optimization_policy::RendererOptimizationPolicy,
/// Optional consumer-supplied callback fired at each
/// [`RendererLoadingPhase`] transition during `build()`. UI
/// consumers wire this to update a loading overlay; tracing /
/// telemetry consumers can use it to record per-phase elapsed
/// time.
phase_handler: Option<RendererLoadingPhaseHandler>,
/// Optional override for the BVH rebuild cadence. `None` →
/// `SceneSpatialConfig::default()`. Set via
/// [`AwsmRendererBuilder::with_scene_spatial_config`] directly
/// or indirectly via [`AwsmRendererBuilder::with_profile`].
scene_spatial_config: Option<crate::scene_spatial::SceneSpatialConfig>,
/// Recommended `ShadowQualityTier` from the active profile.
/// Surfaced via [`AwsmRenderer::recommended_shadow_quality_tier`]
/// so scene-side code that registers shadow-casting lights can
/// apply the matching `LightShadowParams` preset on insert.
/// `None` when no profile is set.
recommended_shadow_quality_tier: Option<crate::shadows::ShadowQualityTier>,
/// Pending depth-format override stashed by `with_profile` when
/// no user-supplied `RenderTextureFormats` exists yet. Applied
/// inside `build()` after the per-device probe — that's where
/// the rest of the format defaults come from. `None` when no
/// profile selected one (or the user already supplied a full
/// formats struct, in which case `with_profile` mutates it in
/// place).
render_texture_formats_depth_override: Option<awsm_renderer_core::texture::TextureFormat>,
}
/// WebGPU builder input for `AwsmRendererBuilder`.
pub enum AwsmRendererGpuBuilderKind {
/// Build from a WebGPU builder.
WebGpuBuilder(AwsmRendererWebGpuBuilder),
/// Use an already-built WebGPU context.
WebGpuBuilt(AwsmRendererWebGpu),
}
impl From<AwsmRendererWebGpuBuilder> for AwsmRendererGpuBuilderKind {
fn from(builder: AwsmRendererWebGpuBuilder) -> Self {
AwsmRendererGpuBuilderKind::WebGpuBuilder(builder)
}
}
impl From<AwsmRendererWebGpu> for AwsmRendererGpuBuilderKind {
fn from(gpu: AwsmRendererWebGpu) -> Self {
AwsmRendererGpuBuilderKind::WebGpuBuilt(gpu)
}
}
impl AwsmRendererBuilder {
/// Creates a new renderer builder from a WebGPU builder or context.
pub fn new(gpu: impl Into<AwsmRendererGpuBuilderKind>) -> Self {
Self {
gpu: gpu.into(),
logging: AwsmRendererLogging::default(),
render_texture_formats: None,
clear_color: Color::BLACK,
brdf_lut_options: BrdfLutOptions::default(),
skybox_colors: CubemapBitmapColors {
z_positive: Color::BLACK,
z_negative: Color::BLACK,
x_positive: Color::BLACK,
x_negative: Color::BLACK,
y_positive: Color::BLACK,
y_negative: Color::BLACK,
},
// skybox_colors: CubemapBitmapColors {
// z_positive: Color::from_hex_rgb(0xFF0000), // red
// z_negative: Color::from_hex_rgb(0x00FF00), // green
// x_positive: Color::from_hex_rgb(0x0000FF), // blue
// x_negative: Color::from_hex_rgb(0xFFFF00), // yellow
// y_positive: Color::from_hex_rgb(0xFF00FF), // magenta
// y_negative: Color::from_hex_rgb(0x00FFFF), // cyan
// },
ibl_filtered_env_colors: CubemapBitmapColors {
z_positive: Color::WHITE,
z_negative: Color::WHITE,
x_positive: Color::WHITE,
x_negative: Color::WHITE,
y_positive: Color::WHITE,
y_negative: Color::WHITE,
},
ibl_irradiance_colors: CubemapBitmapColors {
z_positive: Color::WHITE,
z_negative: Color::WHITE,
x_positive: Color::WHITE,
x_negative: Color::WHITE,
y_positive: Color::WHITE,
y_negative: Color::WHITE,
},
anti_aliasing: AntiAliasing::default(),
post_processing: PostProcessing::default(),
shadows_config: None,
features: RendererFeatures::default(),
max_edge_budget: None,
bucket_config: None,
prep_config: crate::render_passes::material_prep::PrepPassConfig::default(),
optimization_policy: crate::optimization_policy::RendererOptimizationPolicy::default(),
phase_handler: None,
scene_spatial_config: None,
recommended_shadow_quality_tier: None,
render_texture_formats_depth_override: None,
}
}
/// Snapshot every build-time config knob into a [`RendererConfigSpec`].
/// Called by `build()` to stash the spec on the renderer for `remove_all`.
/// Every field except `gpu` + `phase_handler` is captured.
fn to_config_spec(&self) -> RendererConfigSpec {
RendererConfigSpec {
logging: self.logging.clone(),
render_texture_formats: self.render_texture_formats.clone(),
brdf_lut_options: self.brdf_lut_options.clone(),
clear_color: self.clear_color.clone(),
skybox_colors: self.skybox_colors.clone(),
ibl_filtered_env_colors: self.ibl_filtered_env_colors.clone(),
ibl_irradiance_colors: self.ibl_irradiance_colors.clone(),
anti_aliasing: self.anti_aliasing.clone(),
post_processing: self.post_processing.clone(),
shadows_config: self.shadows_config.clone(),
features: self.features.clone(),
max_edge_budget: self.max_edge_budget,
bucket_config: self.bucket_config,
prep_config: self.prep_config,
optimization_policy: self.optimization_policy.clone(),
scene_spatial_config: self.scene_spatial_config,
recommended_shadow_quality_tier: self.recommended_shadow_quality_tier,
render_texture_formats_depth_override: self.render_texture_formats_depth_override,
}
}
/// Reconstruct a builder from a [`RendererConfigSpec`] + a GPU context — the
/// one-line, drift-free basis for [`AwsmRenderer::remove_all`]. `phase_handler`
/// is `None` (a rebuild needs no boot-phase callback).
pub fn from_spec(gpu: impl Into<AwsmRendererGpuBuilderKind>, spec: RendererConfigSpec) -> Self {
Self {
gpu: gpu.into(),
logging: spec.logging,
render_texture_formats: spec.render_texture_formats,
brdf_lut_options: spec.brdf_lut_options,
clear_color: spec.clear_color,
skybox_colors: spec.skybox_colors,
ibl_filtered_env_colors: spec.ibl_filtered_env_colors,
ibl_irradiance_colors: spec.ibl_irradiance_colors,
anti_aliasing: spec.anti_aliasing,
post_processing: spec.post_processing,
shadows_config: spec.shadows_config,
features: spec.features,
max_edge_budget: spec.max_edge_budget,
bucket_config: spec.bucket_config,
prep_config: spec.prep_config,
optimization_policy: spec.optimization_policy,
phase_handler: None,
scene_spatial_config: spec.scene_spatial_config,
recommended_shadow_quality_tier: spec.recommended_shadow_quality_tier,
render_texture_formats_depth_override: spec.render_texture_formats_depth_override,
}
}
/// Apply a coordinated set of defaults from a
/// [`crate::profile::RendererProfile`]. Sets `anti_aliasing`,
/// `post_processing`, `features`, `optimization_policy`,
/// `shadows_config`, `max_edge_budget`, `scene_spatial_config`,
/// and the recommended shadow quality tier — all the knobs whose
/// right starting value differs between mobile-class and
/// desktop-class targets.
///
/// **Call order**: invoke this **first**, then chain any per-knob
/// `with_*` overrides — the profile mutates the builder's state
/// immediately, so later `with_*` calls win.
///
/// Frontends typically resolve the profile from a URL parameter
/// (`?mobile=true`) via
/// [`awsm_renderer_web_shared::perf::resolve_renderer_profile`](https://github.com/dakom/awsm-renderer/blob/main/crates/web-shared/src/perf.rs)
/// and pass the result here.
///
/// **Per-light shadow params** aren't owned by the renderer
/// builder — scene-side code reads
/// [`AwsmRenderer::recommended_shadow_quality_tier`] after build
/// and applies the matching `LightShadowParams` preset on each
/// shadow-casting light registration.
pub fn with_profile(mut self, profile: crate::profile::RendererProfile) -> Self {
let defaults = profile.defaults();
self.anti_aliasing = defaults.anti_aliasing;
self.post_processing = defaults.post_processing;
self.features = defaults.features;
self.optimization_policy = defaults.optimization_policy;
self.shadows_config = Some(defaults.shadows_config);
self.max_edge_budget = Some(defaults.max_edge_budget);
self.scene_spatial_config = Some(defaults.scene_spatial);
self.recommended_shadow_quality_tier = Some(defaults.shadow_quality_tier);
// Render-texture format override: only the `depth` field
// varies by profile today. Build a `RenderTextureFormats`
// around the per-device baseline at `build()` time if the
// user hasn't supplied one — we can't do the async default
// probe here in a sync builder method. The depth override
// gets re-applied inside `build()` (see the
// `render_texture_formats` materialization there).
if let Some(formats) = self.render_texture_formats.as_mut() {
formats.depth = defaults.render_texture_formats.depth;
} else {
// Stash the override on a builder-private field so the
// build() async path can apply it once the per-device
// defaults have been probed. We re-use
// `render_texture_formats` indirectly via the
// post-profile mutation below.
self.render_texture_formats_depth_override =
Some(defaults.render_texture_formats.depth);
}
self
}
/// Override the BVH rebuild cadence directly. The
/// [`crate::profile::RendererProfile`] is the usual surface for
/// this; only call this directly for bespoke tuning.
pub fn with_scene_spatial_config(
mut self,
config: crate::scene_spatial::SceneSpatialConfig,
) -> Self {
self.scene_spatial_config = Some(config);
self
}
/// Block C.2: override the default `MAX_EDGE_BUDGET` for the
/// MSAA edge-resolve buffers. Default picks
/// `DEFAULT_MAX_EDGE_BUDGET_DESKTOP` (512k edge pixels). Mobile
/// consumers should pass `DEFAULT_MAX_EDGE_BUDGET_MOBILE`
/// (256k); pathological-edge content can pass higher values
/// (e.g. 1M) to absorb dense foliage at 4K.
///
/// Live tuning at runtime is also available via
/// [`AwsmRenderer::set_max_edge_budget`] — call it when
/// [`note_edge_overflow_observed`](crate::render_passes::material_opaque::edge_buffers::note_edge_overflow_observed)
/// fires (indicating overflow this session).
pub fn with_max_edge_budget(mut self, budget: u32) -> Self {
self.max_edge_budget = Some(budget.max(1));
self
}
/// Sets the registration ceiling for co-resident material buckets
/// (`docs/plans/increase-materials.md` §2). Default is 32 (identical to
/// today). Valid range `1..=65534`; an out-of-range value is clamped
/// into range here and logged, so the builder never produces a registry
/// that can mint a bucket index the edge encoding can't represent. The
/// cap sizes nothing per-frame — every GPU width follows the *live*
/// bucket count, so a high cap costs nothing until the count grows.
pub fn with_bucket_config(mut self, config: crate::dynamic_materials::BucketConfig) -> Self {
let config = match config.validate() {
Ok(()) => config,
Err(msg) => {
let clamped = config
.max_bucket_entries
.clamp(1, crate::dynamic_materials::MAX_BUCKET_ENTRIES_CEILING);
tracing::warn!(
target: "awsm_renderer::dynamic_materials",
"with_bucket_config: {msg}; clamping to {clamped}"
);
crate::dynamic_materials::BucketConfig {
max_bucket_entries: clamped,
}
}
};
self.bucket_config = Some(config);
self
}
/// Max shadow casters that can overlap a single pixel (`K`) — sizes the
/// per-pixel shadow-visibility buffer. Clamped to
/// `1..=PrepPassConfig::MAX_SHADOW_CASTERS_PER_PIXEL_CEILING`.
pub fn with_max_shadow_casters_per_pixel(mut self, k: u32) -> Self {
self.prep_config.max_shadow_casters_per_pixel =
k.clamp(1, crate::render_passes::material_prep::PrepPassConfig::MAX_SHADOW_CASTERS_PER_PIXEL_CEILING);
self
}
/// Subscribes to renderer-init phase transitions. The callback
/// fires once per [`RendererLoadingPhase`] entry — see the enum
/// docs for what each phase covers. Frontends use this to render
/// a phase-specific loading message instead of one generic
/// "Initializing renderer…" line that covers the entire (cold
/// load: tens of seconds; warm load: ~1s) window.
pub fn with_phase_handler<F>(mut self, handler: F) -> Self
where
F: FnMut(RendererLoadingPhase) + 'static,
{
self.phase_handler = Some(Box::new(handler));
self
}
/// Opts into renderer features. Both flags default to `false` so
/// library consumers pay no cost for GPU-driven culling / decals
/// when they don't need them. Game-side and editor builds should
/// set this explicitly.
pub fn with_features(mut self, features: RendererFeatures) -> Self {
self.features = features;
self
}
/// Sets the adaptive runtime policy. Independent of
/// `with_features`: features gate **allocation** (does the HZB
/// texture exist?), policy gates **engagement** (do we build it
/// this frame?). Default is `Auto` for `gpu_culling`; pass
/// `OptimizationMode::Force` for editor / regression-testing
/// builds, or `Off` for a CPU-only baseline.
pub fn with_optimization_policy(
mut self,
policy: crate::optimization_policy::RendererOptimizationPolicy,
) -> Self {
self.optimization_policy = policy;
self
}
/// Pins a renderer-wide shadow configuration that the new
/// `Shadows` will use at construction. Use this when loading an
/// `awsm_renderer_scene::EditorProject` so the cube-pool size, EVSM
/// atlas size, and 2D atlas size match the authored intent before
/// any frame renders.
pub fn with_shadows_config(mut self, config: shadows::ShadowsConfig) -> Self {
self.shadows_config = Some(config);
self
}
/// Sets BRDF LUT generation options.
pub fn with_brdf_lut_options(mut self, options: BrdfLutOptions) -> Self {
self.brdf_lut_options = options;
self
}
/// Sets the filtered environment colors for IBL.
pub fn with_ibl_filtered_env_colors(mut self, colors: CubemapBitmapColors) -> Self {
self.ibl_filtered_env_colors = colors;
self
}
/// Sets the anti-aliasing configuration.
pub fn with_anti_aliasing(mut self, anti_aliasing: AntiAliasing) -> Self {
self.anti_aliasing = anti_aliasing;
self
}
/// Sets the post-processing configuration. Mirrors
/// [`Self::with_anti_aliasing`] — used by
/// [`AwsmRenderer::remove_all`] to preserve the live post-process
/// state across the scene-clear rebuild, and by frontends that
/// want to start from a non-default tonemapper / bloom / DoF
/// config without going through `set_post_processing` after build.
pub fn with_post_processing(mut self, post_processing: PostProcessing) -> Self {
self.post_processing = post_processing;
self
}
/// Pins the recommended shadow quality tier reported by
/// [`AwsmRenderer::recommended_shadow_quality_tier`]. Normally set
/// implicitly via [`Self::with_profile`]; this setter exists so
/// [`AwsmRenderer::remove_all`] can preserve the value across a
/// scene-clear rebuild without re-running profile resolution
/// (which would clobber any post-profile per-knob overrides the
/// frontend chained on top).
pub fn with_recommended_shadow_quality_tier(
mut self,
tier: crate::shadows::ShadowQualityTier,
) -> Self {
self.recommended_shadow_quality_tier = Some(tier);
self
}
/// Sets the irradiance colors for IBL.
pub fn with_ibl_irradiance_colors(mut self, colors: CubemapBitmapColors) -> Self {
self.ibl_irradiance_colors = colors;
self
}
/// Sets the skybox colors.
pub fn with_skybox_colors(mut self, colors: CubemapBitmapColors) -> Self {
self.skybox_colors = colors;
self
}
/// Sets logging options for the renderer.
pub fn with_logging(mut self, logging: AwsmRendererLogging) -> Self {
self.logging = logging;
self
}
/// Sets render texture formats.
///
/// Clears any pending depth-format override stashed by an earlier
/// [`Self::with_profile`] call — the explicit formats struct the
/// caller is supplying here wins, per the documented builder
/// contract ("later `with_*` calls win" over `with_profile`).
/// Without this clear, the call sequence
///
/// ```ignore
/// .with_profile(RendererProfile::Mobile) // stashes Depth24Plus
/// .with_render_texture_formats(my_custom_formats) // depth = Depth32Float
/// ```
///
/// would silently clobber `my_custom_formats.depth` back to
/// `Depth24Plus` inside `build()`'s post-probe override-apply
/// step.
pub fn with_render_texture_formats(mut self, formats: RenderTextureFormats) -> Self {
self.render_texture_formats = Some(formats);
self.render_texture_formats_depth_override = None;
self
}
/// Sets the clear color used for the main render pass.
pub fn with_clear_color(mut self, color: Color) -> Self {
self.clear_color = color;
self
}
/// Builds the renderer and initializes GPU resources.
pub async fn build(self) -> std::result::Result<AwsmRenderer, crate::error::AwsmError> {
// Snapshot every build-time config knob BEFORE consuming the builder, so
// `remove_all` can rebuild from it drift-free (the config analog of the
// load transaction — see `RendererConfigSpec`).
let config_spec = self.to_config_spec();
let Self {
gpu,
logging,
render_texture_formats,
brdf_lut_options,
clear_color,
skybox_colors,
ibl_filtered_env_colors,
ibl_irradiance_colors,
anti_aliasing,
post_processing,
shadows_config,
mut features,
max_edge_budget,
bucket_config,
prep_config,
optimization_policy,
phase_handler,
scene_spatial_config,
recommended_shadow_quality_tier,
render_texture_formats_depth_override,
} = self;
let mut phase_handler = phase_handler;
let build_start_ms = web_sys::js_sys::Date::now();
let mut phase_start_ms = build_start_ms;
let mut emit_phase = |phase: RendererLoadingPhase| {
// Log wall-clock between phases so the user can see where
// cold-boot time actually goes (the boot-loader caption
// shows the phase NAME but not how long the previous one
// took). Tracing target is `awsm_renderer::boot_timing`
// so consumers can filter for it explicitly.
let now = web_sys::js_sys::Date::now();
let dt_phase = now - phase_start_ms;
let dt_total = now - build_start_ms;
tracing::info!(
target: "awsm_renderer::boot_timing",
"phase = {:?} (+{:.0}ms phase, {:.0}ms total)",
phase,
dt_phase,
dt_total,
);
phase_start_ms = now;
if let Some(handler) = phase_handler.as_mut() {
handler(phase);
}
};
emit_phase(RendererLoadingPhase::Init);
let gpu = match gpu {
AwsmRendererGpuBuilderKind::WebGpuBuilder(builder) => builder.build().await?,
AwsmRendererGpuBuilderKind::WebGpuBuilt(gpu) => gpu,
};
// Resolve `indirect_first_instance` against device capability.
// After this point any `Auto` in the toggle is replaced by
// `On` (when the device exposes the feature) or `Off` (when it
// doesn't), so downstream code can read `.resolve(false)` and
// get a deterministic boolean. `On` / `Off` overrides bypass
// the capability probe entirely — useful for forcing the
// portable fallback on a supported device (testing) or for
// forcing the optimized path when out-of-band knowledge says
// the device supports it.
//
// The two paths are *both* fully optimized for their config —
// see [`crate::features::FeatureToggle`] and
// [`AwsmRendererWebGpu::has_indirect_first_instance`] for the
// capability semantics, and the geometry-pass + compaction
// templating for the per-path code paths.
let indirect_capability = gpu.has_indirect_first_instance();
let resolved_indirect = features
.indirect_first_instance
.resolve(indirect_capability);
if matches!(
features.indirect_first_instance,
crate::features::FeatureToggle::On
) && !indirect_capability
{
tracing::warn!(
"`indirect_first_instance = On` but the device doesn't expose \
the `indirect-first-instance` WebGPU feature. drawIndirect \
calls with non-zero firstInstance will silently fail. \
Switch to Auto (default) or Off to use the portable path."
);
}
features.indirect_first_instance = if resolved_indirect {
crate::features::FeatureToggle::On
} else {
crate::features::FeatureToggle::Off
};
let mut render_texture_formats = match render_texture_formats {
Some(formats) => formats,
None => RenderTextureFormats::new(&gpu.device).await,
};
// Apply the profile's depth-format override (if any) on top of
// the per-device defaults. Frontends that supplied their own
// `RenderTextureFormats` already have `with_profile` mutate
// the depth field in place — no second pass needed there.
if let Some(depth_override) = render_texture_formats_depth_override {
render_texture_formats.depth = depth_override;
}
// tracing::info!("Max bind groups: {}", gpu.device.limits().max_bind_groups());
// tracing::info!(
// "Max texture size: {}",
// gpu.device.limits().max_texture_dimension_2d()
// );
let mut pipeline_layouts = PipelineLayouts::new();
let mut bind_group_layouts = BindGroupLayouts::new();
let mut pipelines = Pipelines::new();
let mut shaders = Shaders::new();
let mut textures = Textures::new(&gpu)?;
let camera = camera::CameraBuffer::new(&gpu)?;
let frame_globals = crate::frame_globals::FrameGlobals::new(&gpu)?;
// One mega-join covering every independent &gpu-only async
// task in the build's setup stage:
//
// - 3 default-cubemap creations (prefiltered IBL / irradiance
// IBL / skybox)
// - BRDF LUT generation
// - opaque-mipgen pipeline construction
// - `RenderPasses::describe_shaders` (bind-group setup +
// per-pass shader cache key collection — no Dawn
// shader/pipeline compile yet; that's stages 2 and 3
// below)
// - `RenderTextures::new`
//
// The five texture-prep futures only touch `&gpu` (the
// `prepare_resources` half of the prepare/register split is
// intentional infrastructure for exactly this kind of merge).
// `RenderPasses::describe_shaders` holds `&mut` on the
// shader / pipeline / bind-group-layout caches and reads
// from `&mut textures` via `RenderPassInitContext`, but
// those reads (pool.arrays_len, pool_sampler_set,
// pool.texture_views, get_sampler over pool_sampler_set,
// texture_transforms_gpu_buffer) are disjoint from anything
// `IblTexture::register` / `Skybox::register` later mutate —
// register inserts into `cubemaps` (separate from `pool`)
// and pulls a sampler key out of `sampler_cache` without
// ever touching `pool_sampler_set`. So we can safely defer
// the registers (and the dependent Lights / Environment
// construction) to the post-await sync block.
let formats_for_textures = render_texture_formats.clone();
let bind_groups = BindGroups::new(&features);
// Resolved edge-pixel budget — mirrors what `MaterialEdgeBuffers` uses
// (the builder override or the desktop default). Sizes the prep pass's
// compact per-edge-sample shadow texture (Stage 5b-shadow). Computed here
// since the edge buffers themselves are allocated further below.
let resolved_max_edge_budget = max_edge_budget.unwrap_or(
crate::render_passes::material_opaque::edge_buffers::DEFAULT_MAX_EDGE_BUDGET_DESKTOP,
);
let mut render_pass_init = RenderPassInitContext {
gpu: &gpu,
bind_group_layouts: &mut bind_group_layouts,
pipeline_layouts: &mut pipeline_layouts,
pipelines: &mut pipelines,
shaders: &mut shaders,
render_texture_formats: &mut render_texture_formats,
textures: &mut textures,
features: &features,
anti_aliasing: &anti_aliasing,
post_processing: &post_processing,
prep_config: &prep_config,
max_edge_budget: resolved_max_edge_budget,
};
// Phase A of RenderPasses (bind groups + shader cache key
// collection) joins the texture-prep block. RenderPasses is
// NOT a full `new()` here anymore — it's split into 3
// stages so the orchestrator below can pool RenderPasses'
// shader + pipeline cache keys with every tail subsystem
// into one cross-renderer shader ensure_keys and one
// try_join'd compute + render ensure_keys.
//
// The work inside this try_join! falls under
// `RendererLoadingPhase::Init` per the enum's contract
// (adapter / device + supporting GPU resources + cache-key
// collection — no Dawn compile yet). The `CompilingShaders`
// transition fires further down, right before the
// cross-renderer `Shaders::ensure_keys` call where actual
// WGSL → MSL compilation begins.
let (
ibl_filtered_resources,
ibl_irradiance_resources,
skybox_resources,
brdf_lut,
opaque_mipgen,
mut render_passes_plan,
render_textures,
) = futures::try_join!(
IblTexture::prepare_resources(&gpu, ibl_filtered_env_colors),
IblTexture::prepare_resources(&gpu, ibl_irradiance_colors),
Skybox::prepare_resources(&gpu, skybox_colors),
async {
BrdfLut::new(&gpu, brdf_lut_options)
.await
.map_err(crate::error::AwsmError::from)
},
async {
opaque_mipgen::OpaqueMipgen::new(&gpu)
.await
.map_err(crate::error::AwsmError::from)
},
RenderPasses::describe_shaders(&mut render_pass_init, &features),
async {
RenderTextures::new(
&gpu,
formats_for_textures,
&features,
prep_config.shadow_visibility_layers(),
)
.await
.map_err(crate::error::AwsmError::from)
},
)?;
// Move `render_pass_init` into a discard binding so its
// `&mut`-borrows of bind_group_layouts / pipeline_layouts /
// pipelines / shaders / render_texture_formats / textures /
// features end here unambiguously, freeing the post-await
// registers below (which mutate `textures`) to compile
// regardless of any future code that might otherwise extend
// the borrow's NLL lifetime.
let _ = render_pass_init;
let lights = Lights::new(
&gpu,
Ibl::new(
IblTexture::register(&gpu, &mut textures, ibl_filtered_resources)?,
IblTexture::register(&gpu, &mut textures, ibl_irradiance_resources)?,
),
brdf_lut,
)?;
let meshes = Meshes::new(&gpu)?;
let transforms = Transforms::new(&gpu)?;
let instances = Instances::new(&gpu)?;
let materials = Materials::new(&gpu)?;
let environment =
Environment::new(Skybox::register(&gpu, &mut textures, skybox_resources)?);
// Item (2): cross-renderer orchestration. After
// describe_shaders + the texture-prep block finished above,
// we now drive the full renderer-wide compile pool from one
// place. Three awaits cover EVERYTHING (RenderPasses + tail
// subsystems):
//
// 1. ONE `Shaders::ensure_keys` covering RenderPasses-owned
// shaders + Picker + LineRenderer + Shadows caster +
// Effects + Display.
// 2. ONE EVSM validate join (3 inline-shader validates —
// kicked off via `compile_shader` inside
// `Shadows::build_descriptors` immediately after the
// shader ensure_keys returns).
// 3. ONE `try_join`'d compute + render `ensure_keys`
// covering every compute / render pipeline across the
// entire renderer.
//
// The orchestrator owns the pool — `RenderPasses` can't
// smuggle in a sequential `.await?` because its public API
// is `describe_shaders → describe_pipelines → from_resolved`,
// none of which compile pipelines themselves.
// Sized for a small initial viewport; recreated by
// `ClassifyBuffers::ensure_capacity` on first frame once the
// real render-texture size is known.
// Builder-time sizing — no dynamic materials yet, so bucket
// count is the first-party-only baseline.
// `register_material` calls `ensure_bucket_count` if it grows
// the registry past the current value.
let first_party_bucket_count =
crate::dynamic_materials::first_party_bucket_entries().len() as u32;
let material_classify_buffers =
render_passes::material_classify::buffers::ClassifyBuffers::new(
&gpu,
1024,
first_party_bucket_count,
)?;
// Seed the bucket LUT from the first-party entries so a scene that
// never registers a dynamic material still classifies correctly;
// `relayout_bucket_buffers` rebuilds it as the registry grows.
let material_bucket_lut =
render_passes::material_classify::bucket_lut::MaterialBucketLut::new(
&gpu,
&crate::dynamic_materials::first_party_bucket_entries(),
)?;
// Light-culling froxel buffers. Sized to a tiny placeholder
// viewport; per-frame `ensure_viewport` grows them once the real
// swap-chain size is known.
let light_culling_buffers = render_passes::light_culling::LightCullingBuffers::new(
&gpu,
16,
16,
render_passes::light_culling::DEFAULT_SLICE_COUNT,
render_passes::light_culling::DEFAULT_MAX_PER_FROXEL_CAPACITY,
render_passes::light_culling::DEFAULT_MESH_INDICES_CAPACITY,
render_passes::light_culling::DEFAULT_TILE_LIGHT_CAPACITY,
)?;
// MSAA-edge-resolve buffers (Stage 3 dispatch wiring). Allocated only
// when MSAA is on AND the device supports the required limits
// (maxStorageBuffersPerShaderStage >= 10 — the WebGPU baseline).
// The per-shader edge_resolve pipeline layout fits in 4 bind groups
// since the group(4) → extended-shadows(3) fold; the only remaining
// device-cap constraint is the storage-buffer count.
let multisampled_geometry = anti_aliasing.has_msaa_checked()?;
let edge_resolve_enabled = multisampled_geometry && edge_resolve_supported(&gpu);
let (material_edge_buffers, material_edge_layout_uniform) = if edge_resolve_enabled {
use render_passes::material_opaque::edge_buffers::{
build_edge_layout_uniform, MaterialEdgeBuffers,
};
let edge_buffers = if let Some(budget) = max_edge_budget {
MaterialEdgeBuffers::new_with_budget(&gpu, first_party_bucket_count, budget)?
} else {
MaterialEdgeBuffers::new(&gpu, first_party_bucket_count)?
};
let max_edge_budget = edge_buffers.max_edge_budget;
let (uniform, _bytes) =
build_edge_layout_uniform(&gpu, first_party_bucket_count, max_edge_budget)?;
(Some(edge_buffers), Some(uniform))
} else {
(None, None)
};
// Decals subsystem — fixed-capacity GPU storage buffer
// allocated up front; per-frame upload only touches the
// bytes for currently-active decals. Gated by `features.decals`.
let decals = if features.decals {
Some(decals::Decals::new(&gpu)?)
} else {
None
};
// Occlusion-cull buffers. Starts at 1024 instances; grows 2×
// when needed. Gated by `features.gpu_culling`.
let occlusion_buffers = if features.gpu_culling {
Some(render_passes::occlusion::buffers::OcclusionBuffers::new(
&gpu,
)?)
} else {
None
};
// Decal classify buckets. Starts at 1×1 tiles; `ensure_capacity`
// resizes against the live viewport on first render. Gated by
// `features.decals`.
let decal_classify_buffers = if features.decals {
Some(render_passes::material_decal::classify::buffers::DecalClassifyBuffers::new(&gpu)?)
} else {
None
};
// GPU compaction args buffer. Gated by `features.gpu_culling`.
let compaction_buffers = if features.gpu_culling {
Some(render_passes::occlusion::compaction::CompactionBuffers::new(&gpu)?)
} else {
None
};
// GPU mesh-pixel-coverage producer buffers. Allocated only
// when `features.coverage_lod` is on — the producer pass
// populates `MeshCoverage`, and with no opt-in consumer the
// per-frame compute + readback would be pure waste.
let coverage_buffers = if features.coverage_lod {
Some(render_passes::coverage::buffers::CoverageBuffers::new(
&gpu,
)?)
} else {
None
};
// ── 1. Cross-renderer shader pool. Assemble every shader
// cache key — RenderPasses-owned (from the describe
// phase) + tail subsystems' statically-known keys. ONE
// Shaders::ensure_keys.
//
// `mem::take` the keys out of the plan rather than cloning:
// `describe_pipelines` (which consumes the plan below) only
// reads `plan.bindings`, never `plan.shader_cache_keys`, so
// leaving the field empty is fine and avoids a per-build
// allocation of a ~40-entry Vec on the cold path.
let mut all_shader_keys: Vec<shaders::ShaderCacheKey> =
std::mem::take(&mut render_passes_plan.shader_cache_keys);
all_shader_keys.extend(shadows::ShadowsDescriptors::caster_shader_cache_keys());
// Picker shaders are no longer batched here — the entire Picker
// subsystem is deferred until first `pick()` query
// (`AwsmRenderer::ensure_picker_compiled`). Cold-boot compiles
// 0 picker pipelines even when `features.picking == true`.
all_shader_keys.push(shaders::ShaderCacheKey::from(
render_passes::lines::ShaderCacheKeyLine,
));
all_shader_keys.extend(
render_passes::effects::pipeline::EffectsPipelines::shader_cache_keys_for(
&anti_aliasing,
&post_processing,
)?,
);
all_shader_keys.extend(
render_passes::display::pipeline::DisplayPipelines::shader_cache_keys_for(
&post_processing,
),
);
// Phase transition: the actual WGSL → MSL compile happens
// inside the next await. Emit `CompilingShaders` here so the
// frontend's "Browser is compiling shaders…" label is correct.
emit_phase(RendererLoadingPhase::CompilingShaders);
shaders.ensure_keys(&gpu, all_shader_keys).await?;
// ── 2. Tail descriptors (cache-hit shader resolutions for
// Shadows caster; Shadows internally issues 3 EVSM
// `compile_shader` calls that return modules immediately
// + surface their validate futures via
// `ShadowsDescriptors::evsm`).
//
// Picker is no longer built here (Block B.4) — it's compiled
// on the first `pick()` query via
// `AwsmRenderer::ensure_picker_compiled`.
//
// Lines (Block B.3) are no longer built here — the 4 pipeline
// variants compile on first line primitive insertion via
// `AwsmRenderer::ensure_line_pipelines_compiled`, driven by
// `wait_for_pipelines_ready`. The line BGL is still registered
// eagerly below (`LineRenderer::new_deferred`) so `add_line_*`
// can construct per-line bind groups before any pipeline
// exists.
// Shadows::build_descriptors needs the geometry bind groups,
// which now live inside render_passes_plan.bindings. We don't
// have render_passes_plan.bindings as a public field — drill
// through describe_pipelines first to get bind groups via the
// typed RenderPasses handle... actually no, we need them
// BEFORE describe_pipelines to construct shadows here.
//
// The bindings struct stores GeometryBindGroups; we need that
// for Shadows::build_descriptors. Expose a borrow via a
// helper on the shader plan.
let mut shadows_descs = shadows::Shadows::build_descriptors(
&gpu,
&mut bind_group_layouts,
&mut pipeline_layouts,
&mut shaders,
render_passes_plan.geometry_bind_groups(),
&render_textures.formats,
shadows_config.unwrap_or_default(),
)
.await?;
// ── 3. EVSM validate join. Single await covering all 3
// inline-shader validations in parallel.
let evsm_results =
futures::future::join_all(shadows_descs.evsm.validate_shader_futures()).await;
for result in evsm_results {
result.map_err(crate::shadows::AwsmShadowError::Core)?;
}
// Register the 3 EVSM modules into the shader cache via
// `insert_uncached`; the resulting `ShaderKey`s let us build
// the 3 EVSM compute pipeline cache keys for the
// cross-renderer compute pool.
let evsm_shader_keys: [shaders::ShaderKey; 3] = [
shaders.insert_uncached(shadows_descs.evsm.modules[0].clone()),
shaders.insert_uncached(shadows_descs.evsm.modules[1].clone()),
shaders.insert_uncached(shadows_descs.evsm.modules[2].clone()),
];
let evsm_pipeline_cache_keys = shadows_descs.evsm.pipeline_cache_keys(evsm_shader_keys);
// ── 4. Now that all shaders are warm, drive RenderPasses
// phase 2 (build pipeline cache keys per pass) and the
// Effects + Display descriptors. All sync apart from
// cache-hit `get_key`s.
let mut render_pass_init = RenderPassInitContext {
gpu: &gpu,
bind_group_layouts: &mut bind_group_layouts,
pipeline_layouts: &mut pipeline_layouts,
pipelines: &mut pipelines,
shaders: &mut shaders,
render_texture_formats: &mut render_texture_formats,
textures: &mut textures,
features: &features,
anti_aliasing: &anti_aliasing,
post_processing: &post_processing,
prep_config: &prep_config,
max_edge_budget: resolved_max_edge_budget,
};
let render_passes_descs =
RenderPasses::describe_pipelines(render_passes_plan, &mut render_pass_init, &features)
.await?;
// `render_pass_init`'s `&mut`-borrows of bind_group_layouts /
// pipeline_layouts / pipelines / shaders / etc. expire at
// the next statement boundary; the subsequent code below
// re-borrows them through the same names.
let _ = render_pass_init;
let caster_pipeline_cache_keys =
std::mem::take(&mut shadows_descs.caster_pipeline_cache_keys);
let effects_descs = render_passes_descs
.effects_pipelines()
.build_descriptors(&anti_aliasing, &post_processing, &gpu, &mut shaders)
.await?;
let display_descs = render_passes_descs
.display_pipelines()
.build_descriptors(&post_processing, &gpu, &mut shaders)
.await?;
// ── 5. Assemble the cross-renderer compute + render cache
// key pools and record each subsystem's slice range.
let mut compute_pool: Vec<pipelines::compute_pipeline::ComputePipelineCacheKey> =
render_passes_descs.compute_pipeline_cache_keys.clone();
let render_passes_compute_len = compute_pool.len();
// Picker compute pipelines are deferred (Block B.4) — no
// entries appended here.
// EVSM compute pipelines are deferred (Block B.1) — held on
// `shadows.pending_evsm_cache_keys` and resolved by
// `Shadows::ensure_pipelines_compiled` on the first
// shadow-casting light. No entries appended.
let effects_compute_range = {
let s = compute_pool.len();
compute_pool.extend(effects_descs.pipeline_cache_keys.iter().cloned());
s..compute_pool.len()
};
let mut render_pool: Vec<pipelines::render_pipeline::RenderPipelineCacheKey> =
render_passes_descs.render_pipeline_cache_keys.clone();
let render_passes_render_len = render_pool.len();
// Line pipelines are deferred (Block B.3) — no entries
// appended here. The 4 variants compile on first line primitive
// insertion via `AwsmRenderer::ensure_line_pipelines_compiled`.
// Shadow caster render pipelines are deferred (Block B.2) —
// held on `shadows.pending_caster_cache_keys` and resolved by
// `Shadows::ensure_pipelines_compiled` on the first
// shadow-casting light. No entries appended.
let display_render_range = {
let s = render_pool.len();
render_pool.extend(display_descs.pipeline_cache_keys.iter().cloned());
s..render_pool.len()
};
// ── 6. ONE try_join'd compute + render ensure_keys covering
// every compute + render pipeline across the entire
// renderer (~36 compute + ~27 render on a fully-
// featured build). Split-borrow Pipelines.compute /
// Pipelines.render so Dawn overlaps both classes inside
// its worker pool.
let pipelines::Pipelines {
render: render_pipelines,
compute: compute_pipelines,
} = &mut pipelines;
let compute_fut = async {
compute_pipelines
.ensure_keys(&gpu, &shaders, &pipeline_layouts, compute_pool)
.await
.map_err(crate::error::AwsmError::from)
};
let render_fut = async {
render_pipelines
.ensure_keys(&gpu, &shaders, &pipeline_layouts, render_pool)
.await
.map_err(crate::error::AwsmError::from)
};
// Phase transition: every shader is now warm; the pipeline
// assembly happens inside the next await. Emit
// `BuildingPipelines` so the frontend's "Building render
// pipelines…" label is correct.
emit_phase(RendererLoadingPhase::BuildingPipelines);
let (compute_keys, render_keys) =
futures::future::try_join(compute_fut, render_fut).await?;
// ── 7. Sync fold-up — slice resolved keys back to each
// subsystem.
let render_passes_compute_keys = compute_keys[..render_passes_compute_len].to_vec();
let render_passes_render_keys = render_keys[..render_passes_render_len].to_vec();
let mut render_passes = RenderPasses::from_resolved(
render_passes_descs,
render_passes_compute_keys,
render_passes_render_keys,
)?;
// Picker stays `None` at build (Block B.4) — compiled lazily on
// first `pick()` via `AwsmRenderer::ensure_picker_compiled`.
let picker: Option<Picker> = None;
// Block B.3: cold-boot LineRenderer registers the line BGL but
// leaves the 4 pipeline variants unbuilt. The first
// `add_line_*` call sets `pipelines_compile_requested = true`;
// `wait_for_pipelines_ready` then drives `ensure_pipelines_compiled`.
let lines = LineRenderer::new_deferred(&gpu, &mut bind_group_layouts)?;
// Shadows are constructed in the deferred path (Block B.1 + B.2):
// empty `caster_resolved` / `evsm_resolved` slices stash the
// pending cache keys on `Shadows`; pipeline compile is
// triggered by `Shadows::ensure_pipelines_compiled` on the
// first shadow-casting light. Non-pipeline GPU resources
// (atlases, bind groups, buffers) still materialise here.
let shadows = shadows::Shadows::from_resolved(
&gpu,
&bind_group_layouts,
shadows_descs,
Vec::new(),
Vec::new(),
caster_pipeline_cache_keys,
evsm_pipeline_cache_keys,
)?;
render_passes.effects.pipelines.install_resolved(
&post_processing,
compute_keys[effects_compute_range].to_vec(),
);
render_passes
.display
.pipelines
.install_resolved(render_keys[display_render_range].to_vec());
#[cfg(feature = "animation")]
let animations = animation::Animations::default();
let extras_pool_built = crate::dynamic_materials::extras_pool::ExtrasPool::new(
&gpu,
crate::dynamic_materials::extras_pool::DEFAULT_CAPACITY_WORDS,
)?;
// Edge-resolve pipeline compile (Priority 3 dispatch wiring). Only
// when MSAA is on AND device supports the required limits. We
// pass first_party-only bucket entries — the edge pipelines
// recompile through the same path when dynamic materials
// register (Stage 1.14 follow-up will route through the
// scheduler).
if edge_resolve_enabled {
let color_wgsl = awsm_renderer_core::texture::texture_format_to_wgsl_storage(
render_textures.formats.color,
)?;
let bucket_entries = crate::dynamic_materials::first_party_bucket_entries();
let pipelines::Pipelines {
render: _render_pipelines,
compute: compute_pipelines,
} = &mut pipelines;
render_passes
.material_opaque
.edge_pipelines
.ensure_compiled(
&gpu,
&mut shaders,
compute_pipelines,
&mut pipeline_layouts,
&mut bind_group_layouts,
&render_passes.material_opaque.bind_groups,
&render_passes.material_opaque.edge_bind_group_layouts,
&bucket_entries,
&anti_aliasing,
color_wgsl,
None,
prep_config.clamped_k(),
)
.await?;
}
let mut _self = AwsmRenderer {
gpu,
meshes,
camera,
frame_globals,
transforms,
instances,
scene_spatial: SceneSpatial::new(scene_spatial_config.unwrap_or_default()),
recommended_shadow_quality_tier,
light_buckets: LightMeshBuckets::default(),
material_classify_buffers,
material_bucket_lut,
light_culling_buffers,
light_culling_debug_heatmap: 0,
debug_view_mode: 0,
debug_wireframe: 0,
material_edge_buffers,
material_edge_layout_uniform,
decals,
occlusion_buffers,
decal_classify_buffers,
compaction_buffers,
coverage: coverage::MeshCoverage::default(),
coverage_buffers,
coverage_readback_state: std::sync::Arc::new(std::sync::Mutex::new(
CoverageReadbackState::default(),
)),
edge_overflow_readback_state: std::sync::Arc::new(std::sync::Mutex::new(
EdgeOverflowReadbackState::default(),
)),
froxel_overflow_readback_state: std::sync::Arc::new(std::sync::Mutex::new(
FroxelOverflowReadbackState::default(),
)),
frame_index: 0,
shaders,
bind_group_layouts,
bind_groups,
materials,
dynamic_materials: crate::dynamic_materials::DynamicMaterials::new(),
masked_dynamic_dirty: false,
extras_pool: extras_pool_built,
pipeline_layouts,
pipelines,
lights,
textures,
environment,
render_passes,
_clear_color: clear_color.clone(),
_clear_color_perceptual_to_linear: clear_color.perceptual_to_linear(),
logging,
render_textures,
anti_aliasing,
prep_config,
post_processing,
picker,
lines,
opaque_mipgen,
shadows,
features,
optimization_policy,
// First frame's previous-state input. All flags `false` is
// the safe baseline: render.rs's policy computation pass
// will derive `gpu_occlusion=false` for Auto until the
// cooldown elapses (so the first frames after init route
// through the CPU path) and Force / Off behave per spec
// from frame 0.
frame_optimizations: crate::optimization_policy::FrameOptimizations::default(),
// Set to the cooldown threshold so Auto can flip on at the
// very first qualifying frame instead of waiting through a
// cooldown of empty frames after startup. Without this,
// every fresh renderer would burn `gpu_culling_cooldown_frames`
// before Auto could engage — a poor UX for editor builds
// that load a large scene immediately.
frames_in_current_mode: u32::MAX / 2,
default_cheap_material_pixel_threshold: 64,
renderable_pool: crate::renderable::RenderablePool::default(),
hud_resolve: crate::render::HudResolveState::default(),
pipeline_scheduler: crate::pipeline_scheduler::PipelineScheduler::new(),
last_ensured_bucket_layout: None,
// Flipped to true at end of build(). Used by config-change
// APIs to enforce the race policy from the architecture doc.
build_complete: false,
#[cfg(feature = "animation")]
animations,
cameras: crate::cameras::Cameras::new(),
render_frame_scratch: crate::render::RenderFrameScratch::default(),
// The render gate starts closed: a freshly built renderer shows the
// loading screen until its first `commit_load` lands.
scene_committed: false,
load_phase: crate::loading::LoadPhase::Idle,
loading_textures_total: 0,
loading_textures_uploaded: 0,
loading_geometry_total: 0,
loading_geometry_uploaded: 0,
config_spec,
};
// Apply the configured registration ceiling (§2). Validated +
// clamped in `with_bucket_config`, so this only sets the field; it
// sizes nothing per-frame (widths follow the live count, §0).
if let Some(bucket_config) = bucket_config {
_self
.dynamic_materials
.set_max_bucket_entries(bucket_config.max_bucket_entries);
}
// Initial AA + PP state — the effects + display pipelines we
// installed in the cross-tail pool above already match the
// configured `anti_aliasing` + `post_processing`, so the
// pipeline-rebuild path inside set_anti_aliasing /
// set_post_processing would just no-op through cache hits.
// We still need the state-side bookkeeping (bind-group recreate
// marks). `BindGroups::new` already marks every variant for
// create on first frame, so the AA / PP marks are redundant —
// but adding them explicitly mirrors the dynamic-setter
// contract and keeps the surface honest if `BindGroups::new`
// ever stops marking everything.
_self
.bind_groups
.mark_create(crate::bind_groups::BindGroupCreate::AntiAliasingChange);
_self
.bind_groups
.mark_create(crate::bind_groups::BindGroupCreate::TextureViewRecreate);
// Block D.1 PART 3: register the eager set with the scheduler.
// The eager set (the pipelines compiled inline above by the
// per-pass `from_resolved` calls) is now tracked through the
// scheduler's PassDef SlotMap. They're already-compiled, so we
// immediately transition Pending → Ready. Frontends watching
// drain_pipeline_status_events observe each PassKind register;
// config-flip semantics (Block D.3) can walk the Pass entries
// similarly to materials.
//
// The literal "compile drives THROUGH the scheduler" shape
// (submit → scheduler kicks off compile → wait_for_pipelines_ready)
// would additionally require each render-pass's `from_resolved`
// to factor into `new_deferred` + `ensure_pipelines_compiled`
// for the eager set's individual passes — that's a multi-day
// refactor and is parked for a follow-up. The bookkeeping here
// is the architectural promise's observability piece: scheduler
// knows the full eager set; frontends + config-flip + status
// queries all see it.
{
use crate::pipeline_scheduler::{
PassDef, PipelineConfigSnapshot, PipelineGroupDef, PipelineGroupId,
};
let snapshot = PipelineConfigSnapshot {
msaa: _self.anti_aliasing.clone(),
mipmap: if _self.anti_aliasing.mipmap {
crate::render_passes::material_opaque::shader::template::MipmapMode::Gradient
} else {
crate::render_passes::material_opaque::shader::template::MipmapMode::None
},
gpu_culling: _self.features.gpu_culling,
coverage_lod: _self.features.coverage_lod,
debug_bitmask: 0,
default_cull_mode: awsm_renderer_core::pipeline::primitive::CullMode::Back,
};
let active_msaa_samples: u8 = if _self.anti_aliasing.has_msaa_checked()? {
4
} else {
1
};
let mut eager_passes: Vec<PipelineGroupDef> = vec![
PipelineGroupDef::Pass(PassDef::ClassifyMsaa {
samples: active_msaa_samples,
snapshot: snapshot.clone(),
}),
PipelineGroupDef::Pass(PassDef::GeometryMsaa {
samples: active_msaa_samples,
snapshot: snapshot.clone(),
}),
PipelineGroupDef::Pass(PassDef::Display),
PipelineGroupDef::Pass(PassDef::ScenePassClear),
];
if _self.features.gpu_culling {
eager_passes.push(PipelineGroupDef::Pass(PassDef::HzbSeed {
samples: active_msaa_samples,
}));
}
if edge_resolve_enabled {
eager_passes.push(PipelineGroupDef::Pass(PassDef::EdgeResolveBlend {
snapshot: snapshot.clone(),
}));
}
let pass_ids = _self
.pipeline_scheduler
.submit_pipeline_group_batch(eager_passes);
for id in &pass_ids {
if matches!(id, PipelineGroupId::Pass(_)) {
_self.pipeline_scheduler.mark_ready(*id);
}
}
tracing::info!(
target: "awsm_renderer::pipeline_readiness",
"eager-set registered with scheduler: {} groups marked Ready",
pass_ids.len()
);
}
// Race-policy: config-change APIs become available now that
// the eager batch is done.
_self.build_complete = true;
emit_phase(RendererLoadingPhase::Ready);
Ok(_self)
}
}
// =============================================================================
// Pipeline-readiness scheduler — public API on AwsmRenderer
// =============================================================================
//
// Wraps the scheduler with renderer-side ergonomics (a single import
// surface, race-policy enforcement on the config-change APIs, a test
// helper for awaiting Pending → Ready).
//
// Per the architecture in `https://github.com/dakom/awsm-renderer/pull/99`:
//
// - `submit_pipeline_group_batch` is the public submission API.
// - `pipeline_group_status` is the pull-side status query.
// - `drain_pipeline_status_events` is the push-side event drain.
// - `drop_material_group` cleans up orphans from the editor's
// recompile flow.
// - `poll_pipeline_scheduler` drives the FuturesUnordered from the
// render loop's pre-frame phase.
// - `wait_for_pipelines_ready` is the test-only helper.
impl AwsmRenderer {
/// Submit a batch of pipeline groups for compile. Returns ids
/// immediately in `Pending` state; transitions to `Ready` /
/// `Failed` surface via [`Self::drain_pipeline_status_events`] or
/// [`Self::pipeline_group_status`].
///
/// Per the architecture doc, this is the unified API over both
/// materials and passes. Stage 1 follow-up will wire each
/// `PipelineGroupDef` variant to its real compile path; today the
/// scheduler queues stub futures that resolve immediately with
/// `Ok(())`.
pub fn submit_pipeline_group_batch(
&mut self,
defs: Vec<crate::pipeline_scheduler::PipelineGroupDef>,
) -> Vec<crate::pipeline_scheduler::PipelineGroupId> {
self.pipeline_scheduler.submit_pipeline_group_batch(defs)
}
/// Per-group status query — O(1) lookup. Returns `None` if the id
/// doesn't exist in the scheduler (dropped or never submitted).
pub fn pipeline_group_status(
&self,
id: crate::pipeline_scheduler::PipelineGroupId,
) -> Option<&crate::pipeline_scheduler::PipelineGroupStatus> {
self.pipeline_scheduler.pipeline_group_status(id)
}
/// Drain status events accumulated since the last call. Frontends
/// use this to drive "compiling N of M" UI without per-frame
/// polling.
pub fn drain_pipeline_status_events(&mut self) -> Vec<crate::pipeline_scheduler::StatusEvent> {
self.pipeline_scheduler.drain_status_events()
}
/// Aggregate compile-progress snapshot for a loading bar / "compiling
/// N materials…" UI (Decision 14, pull half). Counts pending / ready
/// / failed materials plus the total in-flight sub-pipeline compiles.
/// Cheap; safe to call every frame. See
/// [`crate::pipeline_scheduler::CompileProgress`].
pub fn compile_progress(&self) -> crate::pipeline_scheduler::CompileProgress {
self.pipeline_scheduler.compile_progress()
}
/// Compile status of a registered dynamic material's pipeline group, by
/// shader id. `None` while the compile is still pending (or the material has
/// no scheduler group yet); `Some(Ok(()))` once its pipelines are `Ready`;
/// `Some(Err(msg))` with the real WGSL/driver compile error once `Failed`.
///
/// The launch path skips synchronous shader validation
/// (`ensure_keys_sync_skip_validate`); the actual compile resolves
/// asynchronously via `poll_pipeline_scheduler` and lands the error here. The
/// editor polls this after register so it can surface a true compile failure
/// (undefined symbol, type error, …) instead of only the trailing-`;`
/// heuristic.
pub fn dynamic_material_compile_status(
&self,
shader_id: awsm_renderer_materials::MaterialShaderId,
) -> Option<std::result::Result<(), String>> {
let mid = self
.pipeline_scheduler
.find_material_by_shader_id(shader_id)?;
match self
.pipeline_scheduler
.pipeline_group_status(crate::pipeline_scheduler::PipelineGroupId::Material(mid))?
{
crate::pipeline_scheduler::PipelineGroupStatus::Pending => None,
crate::pipeline_scheduler::PipelineGroupStatus::Ready => Some(Ok(())),
crate::pipeline_scheduler::PipelineGroupStatus::Failed { error } => {
Some(Err(error.to_string()))
}
}
}
/// Synchronously validate a registered dynamic (custom-WGSL) material's
/// ASSEMBLED opaque kernel with `naga`, returning the compile error
/// message(s) (empty = valid). naga is the same WGSL front-end Chrome's Tint
/// mirrors for the common breakage (undefined symbol / type mismatch / the
/// padding-constructor class), so this catches a broken custom material
/// up-front — the editor calls it at register time and surfaces the result in
/// material diagnostics. It exists because the GPU compiles the *shared*
/// `Material Opaque` kernel asynchronously and never attributes a failure back
/// to one material, so diagnostics otherwise reported a silent `ok` (D2b).
///
/// Validation-only: it does NOT gate rendering (a false positive vs. Tint
/// would mis-report a diagnostic, never break a frame). No-op (always empty)
/// unless the `dynamic-material-validation` feature is on — the player never
/// authors materials, so it pays nothing for `naga`.
pub fn validate_dynamic_material_wgsl(
&self,
shader_id: awsm_renderer_materials::MaterialShaderId,
) -> Vec<String> {
#[cfg(not(feature = "dynamic-material-validation"))]
{
let _ = shader_id;
Vec::new()
}
#[cfg(feature = "dynamic-material-validation")]
{
use crate::dynamic_materials::{first_party_bucket_entries, BucketEntry, ShadingBase};
use awsm_renderer_materials::MaterialAlphaMode;
let Some(info) = self.dynamic_materials.shader_info_for(shader_id) else {
return Vec::new();
};
// §12: a BLEND custom material's MAIN WGSL is wrapped in the
// TRANSPARENT contract (`TransparentShadingOutput`); Opaque/Mask route
// to the opaque contract (`OpaqueShadingOutput`). Validating against
// the wrong template falsely reported "no definition in scope for
// identifier: TransparentShadingOutput". Pick the template that matches
// the material's actual render pass (mirrors `launch.rs` build_opaque).
let is_blend = matches!(
self.dynamic_materials.get(shader_id).map(|r| r.alpha_mode),
Some(MaterialAlphaMode::Blend)
);
// Representative config: validation only depends on the dynamic
// struct/loader/fragment + declared includes, not the exact pool/AA
// sizes (those change array lengths, never the WGSL's validity).
let src = if is_blend {
use crate::render_passes::light_culling::buffers::DEFAULT_SLICE_COUNT;
use crate::render_passes::material_transparent::shader::cache_key::ShaderCacheKeyMaterialTransparent;
use crate::render_passes::material_transparent::shader::template::ShaderTemplateMaterialTransparent;
use crate::render_passes::shared::material::cache_key::ShaderMaterialVertexAttributes;
let key = ShaderCacheKeyMaterialTransparent {
instancing_transforms: false,
attributes: ShaderMaterialVertexAttributes {
normals: true,
tangents: true,
color_sets: None,
uv_sets: Some(1),
},
texture_pool_arrays_len: 1,
texture_pool_samplers_len: 1,
msaa_sample_count: None,
mipmaps: false,
base: ShadingBase::Custom,
pbr_features: awsm_renderer_materials::pbr::PbrFeatures::default().bits(),
dispatch_hash: 0,
dynamic_shader_id: Some(shader_id),
dynamic_shader: Some(info),
// Fragment-hook validation only; the custom-vertex path has
// its own validator (`validate_dynamic_vertex_transparent_wgsl`).
dynamic_vertex_shader: None,
froxel_slice_count: DEFAULT_SLICE_COUNT,
};
let template = match ShaderTemplateMaterialTransparent::try_from(&key) {
Ok(t) => t,
Err(e) => return vec![format!("shader template build failed: {e:?}")],
};
match template.into_source() {
Ok(s) => s,
Err(e) => return vec![format!("shader render failed: {e:?}")],
}
} else {
use crate::render_passes::material_opaque::shader::cache_key::ShaderCacheKeyMaterialOpaque;
use crate::render_passes::material_opaque::shader::template::ShaderTemplateMaterialOpaque;
let mut bucket_entries = first_party_bucket_entries();
bucket_entries.push(BucketEntry {
shader_id,
base: ShadingBase::Custom,
pbr_features: awsm_renderer_materials::pbr::PbrFeatures::default().bits(),
name: "custom".to_string(),
});
let key = ShaderCacheKeyMaterialOpaque {
texture_pool_arrays_len: 1,
texture_pool_samplers_len: 1,
msaa_sample_count: None,
mipmaps: false,
max_shadow_casters: 4,
shader_id,
base: ShadingBase::Custom,
owns_skybox: false,
pbr_features: awsm_renderer_materials::pbr::PbrFeatures::default().bits(),
dispatch_hash: 0,
dynamic_shader: Some(info),
bucket_entries,
};
let template = match ShaderTemplateMaterialOpaque::try_from(&key) {
Ok(t) => t,
Err(e) => return vec![format!("shader template build failed: {e:?}")],
};
match template.into_source() {
Ok(s) => s,
Err(e) => return vec![format!("shader render failed: {e:?}")],
}
};
match naga::front::wgsl::parse_str(&src) {
Err(e) => vec![e.emit_to_string(&src)],
Ok(module) => {
let mut validator = naga::valid::Validator::new(
naga::valid::ValidationFlags::all(),
naga::valid::Capabilities::all(),
);
match validator.validate(&module) {
Ok(_) => Vec::new(),
Err(e) => vec![e.emit_to_string(&src)],
}
}
}
}
}
/// Synchronously validate a registered custom-**vertex** material's
/// ASSEMBLED geometry custom-vertex module with `naga`, returning the
/// compile error message(s) (empty = valid). The vertex-stage sibling of
/// [`Self::validate_dynamic_material_wgsl`]: it assembles the masked
/// geometry bind groups + the geometry vertex shader compiled with the
/// `custom_displace_vertex` hook + the plain geometry fragment, then runs
/// naga so the editor catches a broken `wgsl_vertex` body up-front.
///
/// Validation-only (never gates rendering). No-op (always empty) unless the
/// `dynamic-material-validation` feature is on — the player pays nothing for
/// `naga`. Empty when the material isn't registered or declared no
/// `wgsl_vertex` (→ shared fast vertex pipeline; nothing to validate).
pub fn validate_dynamic_vertex_wgsl(
&self,
shader_id: awsm_renderer_materials::MaterialShaderId,
) -> Vec<String> {
#[cfg(not(feature = "dynamic-material-validation"))]
{
let _ = shader_id;
Vec::new()
}
#[cfg(feature = "dynamic-material-validation")]
{
self.dynamic_materials
.validate_dynamic_vertex_wgsl(shader_id)
}
}
/// Drop a material group. No-op if the id isn't in the scheduler.
pub fn drop_material_group(&mut self, id: crate::pipeline_scheduler::MaterialId) {
self.pipeline_scheduler.drop_material_group(id);
}
/// Poll the scheduler's `FuturesUnordered` for resolved compiles.
/// Called from the render loop's pre-frame phase.
///
/// Drives BOTH inflight queues:
/// - Legacy `inflight` (whole-batch CompileResolutions, currently
/// driven by explicit `mark_ready` / `mark_failed`).
/// - Block D.1 PART 2 `inflight_compile` (per-sub-pipeline
/// compile promises). Each resolution installs the resolved
/// `GpuComputePipeline` into the per-pass cache + decrements
/// the material's sub-compile counter (transition to Ready
/// when counter hits 0).
///
/// Returns the number of transitions applied this poll.
pub fn poll_pipeline_scheduler(&mut self) -> usize {
// Legacy inflight (whole-batch).
let mut applied = self.pipeline_scheduler.poll_resolved();
// D.1 PART 2 inflight_compile (per-sub-pipeline).
while self.apply_compile_resolution() {
applied += 1;
}
applied
}
/// Block C.2 full: grow (or shrink) the
/// [`MaterialEdgeBuffers::max_edge_budget`](crate::render_passes::material_opaque::edge_buffers::MaterialEdgeBuffers)
/// at runtime.
///
/// Use case: a frontend running on a pathological-edge-density
/// scene observes `edge_overflow_count > 0` (via the one-shot
/// `tracing::warn!` from
/// [`note_edge_overflow_observed`](crate::render_passes::material_opaque::edge_buffers::note_edge_overflow_observed)
/// OR via direct CPU readback of `edge_buffers.args_buffer`'s
/// counter). Calling `set_max_edge_budget(current * 2)` recreates
/// `material_edge_buffers` with the new size, rebuilds the
/// edge-layout uniform, and marks classify + edge-resolve +
/// final-blend bind groups for recreation.
///
/// This is the architectural answer to the doc's "atomic-add
/// hash-bucket overflow accumulator" (Stage 3.8 / Block C.2
/// full) — instead of routing overflow samples into a separate
/// shading pipeline (which would need a new compute pipeline +
/// bind group + indirect dispatch + per-shader-id specialization
/// to avoid Stage 3's SPIR-V bloat), the budget itself grows
/// dynamically to absorb the pathological case. Steady-state
/// scenes pay nothing; overflow scenes recover via consumer-
/// driven budget growth.
///
/// Returns `Ok(true)` when buffers were recreated; `Ok(false)`
/// when `new_budget` matches the current value; `Err` if MSAA
/// is off (no edge buffers to size — flip MSAA on first).
pub fn set_max_edge_budget(&mut self, new_budget: u32) -> crate::error::Result<bool> {
if !self.build_complete {
return Err(crate::error::AwsmError::NotReady);
}
let new_budget = new_budget.max(1);
let Some(edge_buffers) = self.material_edge_buffers.as_mut() else {
return Err(crate::error::AwsmError::PipelineVariantNotCompiled(
"edge buffers absent (MSAA off or device unsupported); flip MSAA on first",
));
};
let resized = edge_buffers.set_max_edge_budget(&self.gpu, new_budget)?;
if !resized {
return Ok(false);
}
let bucket_count = edge_buffers.bucket_count;
// Rebuild the edge-layout uniform with the new max_edge_budget.
if let Ok((uniform, _bytes)) =
crate::render_passes::material_opaque::edge_buffers::build_edge_layout_uniform(
&self.gpu,
bucket_count,
new_budget,
)
{
self.material_edge_layout_uniform = Some(uniform);
}
// Stage 5b-shadow: resize the prep pass's compact edge-shadow texture to
// match the new budget (else cs_prep_edge writes / cs_edge reads beyond
// the texture's row count for the overflow edges). The opaque main bind
// group re-clones the new view next frame (TextureViewRecreate below
// fans out to OpaqueMain).
if let Some(prep) = self.render_passes.material_prep.as_mut() {
prep.set_max_edge_budget(&self.gpu, new_budget)?;
}
// Mark dependent bind groups for recreation.
self.bind_groups
.mark_create(crate::bind_groups::BindGroupCreate::MaterialClassifyBuffersResize);
// The opaque main bind group binds the compact edge-shadow texture
// (binding 27); rebind it against the resized view.
self.bind_groups
.mark_create(crate::bind_groups::BindGroupCreate::TextureViewRecreate);
tracing::info!(
target: "awsm_renderer::edge_resolve",
"set_max_edge_budget: edge budget grown to {} (was tracked via overflow CPU surface)",
new_budget
);
Ok(true)
}
/// Bumps the per-froxel light-index budget used by the GPU
/// light-culling pass. Symmetric with
/// [`Self::set_max_edge_budget`]: when the per-frame CPU readback
/// of `LightCullingBuffers::overflow_buffer` shows that the cull
/// shader bumped a froxel's count past
/// `max_per_froxel_capacity` (so subsequent lights for that
/// froxel were dropped), the renderer doubles the budget on the
/// next render. The budget lives as a *runtime* field on the
/// `cull_params` uniform, so this only reallocates the per-froxel
/// storage (via `LightCullingBuffers::set_max_per_froxel_capacity`)
/// and re-binds it — no shader recompile is needed, and the cull +
/// consumer shaders read the new capacity from `cull_params`.
///
/// Returns `Ok(true)` when the buffers were recreated; `Ok(false)`
/// when `new_capacity` matches the current value.
pub fn set_max_per_froxel_capacity(&mut self, new_capacity: u32) -> crate::error::Result<bool> {
if !self.build_complete {
return Err(crate::error::AwsmError::NotReady);
}
let new_capacity = new_capacity.max(1);
let resized = self
.light_culling_buffers
.set_max_per_froxel_capacity(&self.gpu, new_capacity)?;
if !resized {
return Ok(false);
}
self.bind_groups
.mark_create(crate::bind_groups::BindGroupCreate::LightCullingFroxelsResize);
tracing::info!(
target: "awsm_renderer::light_culling",
"set_max_per_froxel_capacity: per-froxel budget grown to {} after observed overflow",
new_capacity,
);
Ok(true)
}
/// Toggle the light-culling debug heatmap (dev aid). When `on`, the
/// shading shaders output a per-pixel applied-punctual-light-count
/// heatmap instead of normal shading — blue (few) → red (many) — so
/// froxel occupancy / cull behaviour can be inspected visually. The
/// value is written into `CullParams.debug_light_heatmap` on the next
/// `write_params`; no buffer recreation or shader recompile needed.
pub fn set_light_culling_debug_heatmap(&mut self, on: bool) {
self.light_culling_debug_heatmap = u32::from(on);
}
/// Global debug view mode: 0 = normal lit shading, 1 = unlit/flat (base
/// color only). Written into `CullParams.debug_view_mode` on the next
/// `write_params`; no buffer recreation or shader recompile. Affects PBR
/// materials (the common case); already-unlit/Toon/custom materials are
/// unchanged. The shader branch that reads it exists only under the
/// `debug-views` cargo feature (the editor enables it); in a game build
/// this setter still writes the uniform but nothing reads it.
pub fn set_debug_view_mode(&mut self, mode: u32) {
self.debug_view_mode = mode;
}
/// Toggle the global debug wireframe overlay (triangle edges tinted in the
/// deferred shade). Written into `CullParams.debug_wireframe` each frame; no
/// recompile. Read only by the `debug-views`-gated shader branch.
pub fn set_debug_wireframe(&mut self, on: bool) {
self.debug_wireframe = u32::from(on);
}
/// The commit's CONCURRENT compile drain — `commit_load`'s phase 3. Kicks
/// the render-driven scene compile (`ensure_scene_pipelines`, inside
/// `prewarm_pipelines`) + the transparent-mesh + line prewarm, then drains
/// every resulting `inflight_compile` promise CONCURRENTLY via
/// `Stream::next` (each `.await` yields to the JS event loop so Dawn's
/// compile promises fire), installing each as it resolves and invoking
/// `on_progress` with a fresh [`CompileProgress`] snapshot per resolution.
///
/// `pub(crate)`: the ONLY caller is `commit_load` (the one compile path).
/// It is not a free-floating "wait for pipelines" an embedder calls mid-
/// render — there is no such surface anymore.
///
/// Returns the total number of transitions applied (diagnostic only).
pub(crate) async fn drain_commit_compiles(
&mut self,
mut on_progress: impl FnMut(crate::pipeline_scheduler::CompileProgress),
) -> crate::error::Result<usize> {
// Phase 1: kick the render-driven material compile
// (`ensure_scene_pipelines`, inside `prewarm_pipelines`) +
// transparent-mesh prewarm. The promises land in
// `inflight_compile`; Phase 2 below drains them async.
self.prewarm_pipelines().await?;
// Block B.3: if any line primitive has been registered since
// build (or since the last commit), drive the lazy line-pipeline
// compile here so the next frame can dispatch the fat-line pass
// instead of warn-skipping.
self.ensure_line_pipelines_compiled().await?;
// Report the initial in-flight count before the drain so the splash
// shows a number immediately rather than after the first resolution.
on_progress(self.compile_progress());
// Phase 2: drain real D.1 PART 2 inflight_compile via async
// Stream::next — each .await yields to the JS event loop so
// Dawn's compile promises can fire. Once next() returns None
// (the FuturesUnordered is empty), every sub-pipeline has
// resolved and apply_compile_resolution installed it.
let mut total = 0usize;
loop {
let resolution_opt = {
use futures::StreamExt;
self.pipeline_scheduler.inflight_compile.next().await
};
let Some(resolution) = resolution_opt else {
break;
};
self.apply_compile_resolution_inline(resolution);
total += 1;
on_progress(self.compile_progress());
}
// Phase 3: drain legacy whole-batch inflight (currently empty
// — explicit mark_ready / mark_failed callers don't push to
// it). Kept for future Pass-flavoured push-futures work.
const MAX_ROUNDS: usize = 1024;
for _ in 0..MAX_ROUNDS {
let applied = self.pipeline_scheduler.poll_resolved();
total += applied;
if applied == 0 {
break;
}
}
Ok(total)
}
}
/// Returns true if the device can host the Stage 3 / Priority 3
/// per-shader-id MSAA edge-resolve pipelines.
///
/// After the group(4) → extended-shadows fold (see
/// `MaterialEdgeBindGroupLayouts`), the per-shader-id edge_resolve
/// pipeline layout fits in 4 bind groups — universally supported, so
/// the bind-group constraint no longer matters. The only remaining
/// constraint is the storage-buffer count: edge_resolve's compute
/// stage now takes two extra storage buffer slots above primary
/// opaque's (the read-write `edge_data` binding + the read-only
/// `edge_args` binding from the args/data split). Primary opaque uses
/// 9 storage buffers in its compute stage; edge_resolve uses 11. Both
/// fit under the WebGPU baseline `maxStorageBuffersPerShaderStage`
/// (≥ 10 on Android Vulkan / macOS Metal / Windows Vulkan / iOS Metal
/// — the spec minimum is 8, but every modern WebGPU stack reports
/// ≥ 10).
///
/// Devices below the storage-buffer limit fall back to the inline
/// `msaa_resolve_samples` path in the primary opaque shader. This
/// almost never triggers in practice, but the safety net stays.
///
/// **Args/data buffer split (now in place).** Earlier this returned
/// `false` because `MaterialEdgeBuffers` was a single GpuBuffer used
/// as both `Indirect` (dispatch source) and `Storage(read-write)`
/// (accumulator + sample lists) inside one compute pass — WebGPU
/// rejects that combination per-buffer per-pass. The buffer is now
/// split: `args_buffer` (`Indirect | Storage | CopyDst`, the
/// dispatch-indirect source + counters) and `data_buffer`
/// (`Storage | CopyDst`, the writable accumulator + sample lists).
/// The args buffer is bound only as `Storage(read)` in the
/// edge_resolve / skybox / final_blend passes — `Storage(read)` +
/// `Indirect` on the same buffer is allowed (no writable usage in
/// the sync scope). This unlocks Priority 3 end-to-end.
pub fn edge_resolve_supported(_gpu: &awsm_renderer_core::renderer::AwsmRendererWebGpu) -> bool {
true
}