@carbonenginejs/runtime-resource 0.13.0 → 0.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (454) hide show
  1. package/LICENSE +21 -21
  2. package/NOTICE +32 -32
  3. package/README.md +129 -129
  4. package/dist/CjsMotherLode.js +1271 -1271
  5. package/dist/CjsResMan.js +3858 -3858
  6. package/dist/CjsResManFetchProvider.js +94 -94
  7. package/dist/CjsResManWorkQueue.js +301 -301
  8. package/dist/_virtual/_rollupPluginBabelHelpers.js +150 -150
  9. package/dist/format/CjsBlueReader.js +358 -358
  10. package/dist/format/CjsByteReader.js +310 -310
  11. package/dist/format/CjsByteWriter.js +242 -242
  12. package/dist/format/CjsFormat.js +223 -223
  13. package/dist/format/CjsFormatError.js +41 -41
  14. package/dist/format/CjsReader.js +22 -22
  15. package/dist/format/CjsResourceProbe.js +279 -279
  16. package/dist/format/CjsStringTable.js +268 -268
  17. package/dist/format/carbonEffect/CjsCarbonEffectReader.js +265 -265
  18. package/dist/format/carbonEffect/CjsCarbonEffectWriter.js +373 -373
  19. package/dist/format/carbonEffect/buildCarbonEffectContainer.js +182 -182
  20. package/dist/format/carbonEffect/carbonEffectBackendBlock.js +321 -321
  21. package/dist/format/carbonEffect/carbonEffectRecords.js +1147 -1147
  22. package/dist/format/carbonEffect/carbonEffectResourceTransform.js +197 -197
  23. package/dist/format/compareUtf8.js +36 -36
  24. package/dist/format/effect/effectBodyInventory.js +146 -146
  25. package/dist/format/effect/effectPermutationGraph.js +257 -257
  26. package/dist/format/effect/sha256.js +114 -114
  27. package/dist/format/index.js +11 -11
  28. package/dist/format/payloadContract.js +193 -193
  29. package/dist/formats/black/CjsBlackFormat.js +310 -310
  30. package/dist/formats/black/core/CjsBlackBinaryReader.js +260 -260
  31. package/dist/formats/black/core/CjsBlackPropertyReaders.js +448 -448
  32. package/dist/formats/black/core/CjsBlackReader.js +764 -764
  33. package/dist/formats/black/core/CjsBlackSchemaRegistry.js +540 -540
  34. package/dist/formats/black/core/black-schema-v1-2026-07-23.json.js +4 -4
  35. package/dist/formats/black/core/blackConstants.js +7 -7
  36. package/dist/formats/black/core/blackDefinitions.js +10 -10
  37. package/dist/formats/black/core/blackEnums.js +6 -6
  38. package/dist/formats/black/core/blackSchema.js +3 -3
  39. package/dist/formats/black/core/blackVersion.js +22 -22
  40. package/dist/formats/black/core/helpers.js +199 -199
  41. package/dist/formats/black/core/schema.js +4 -4
  42. package/dist/formats/black/index.js +2 -2
  43. package/dist/formats/bnk/CjsBnkFormat.js +175 -175
  44. package/dist/formats/bnk/core/busNodes.js +252 -252
  45. package/dist/formats/bnk/core/effectNodes.js +147 -147
  46. package/dist/formats/bnk/core/eventAction.js +416 -416
  47. package/dist/formats/bnk/core/globalSettings.js +215 -215
  48. package/dist/formats/bnk/core/graph.js +137 -137
  49. package/dist/formats/bnk/core/helpers.js +512 -512
  50. package/dist/formats/bnk/core/musicNodes.js +540 -540
  51. package/dist/formats/bnk/core/nodeBase.js +553 -553
  52. package/dist/formats/bnk/core/sfxNodes.js +632 -632
  53. package/dist/formats/bnk/core/soundbanksInfo.js +209 -209
  54. package/dist/formats/bnk/index.js +2 -2
  55. package/dist/formats/cmf/CjsCmfFormat.js +497 -497
  56. package/dist/formats/cmf/core/binary.js +194 -194
  57. package/dist/formats/cmf/core/buffers.js +237 -237
  58. package/dist/formats/cmf/core/constants.js +47 -47
  59. package/dist/formats/cmf/core/gr2Anim.js +453 -453
  60. package/dist/formats/cmf/core/helpers.js +318 -318
  61. package/dist/formats/cmf/core/pack.js +276 -276
  62. package/dist/formats/cmf/core/schema.js +374 -374
  63. package/dist/formats/cmf/core/shared.js +277 -277
  64. package/dist/formats/cmf/core/writer.js +571 -571
  65. package/dist/formats/cmf/index.js +2 -2
  66. package/dist/formats/dds/CjsDdsFormat.js +200 -200
  67. package/dist/formats/dds/core/bc6h.js +298 -298
  68. package/dist/formats/dds/core/bc7.js +272 -272
  69. package/dist/formats/dds/core/helpers.js +901 -862
  70. package/dist/formats/dds/core/helpers.js.map +1 -1
  71. package/dist/formats/dds/index.js +2 -2
  72. package/dist/formats/dxbc/CjsDxbcFormat.js +187 -142
  73. package/dist/formats/dxbc/CjsDxbcFormat.js.map +1 -1
  74. package/dist/formats/dxbc/core/DxbcReader.js +266 -266
  75. package/dist/formats/dxbc/core/container.js +169 -169
  76. package/dist/formats/dxbc/core/decoder.js +789 -789
  77. package/dist/formats/dxbc/core/disassemble.js +240 -0
  78. package/dist/formats/dxbc/core/disassemble.js.map +1 -0
  79. package/dist/formats/dxbc/core/errors.js +19 -19
  80. package/dist/formats/dxbc/core/helpers.js +220 -220
  81. package/dist/formats/dxbc/core/opcodes.js +45 -45
  82. package/dist/formats/dxbc/core/program.js +91 -91
  83. package/dist/formats/dxbc/core/signature.js +172 -172
  84. package/dist/formats/dxbc/index.js +2 -2
  85. package/dist/formats/fbx/CjsFbxFormat.js +266 -266
  86. package/dist/formats/fbx/core/helpers.js +3932 -3932
  87. package/dist/formats/fbx/index.js +2 -2
  88. package/dist/formats/flac/CjsFlacFormat.js +142 -142
  89. package/dist/formats/flac/core/helpers.js +315 -315
  90. package/dist/formats/flac/index.js +2 -2
  91. package/dist/formats/gif/CjsGifFormat.js +141 -141
  92. package/dist/formats/gif/core/helpers.js +380 -380
  93. package/dist/formats/gif/index.js +2 -2
  94. package/dist/formats/gltf/CjsGltfFormat.js +252 -290
  95. package/dist/formats/gltf/CjsGltfFormat.js.map +1 -1
  96. package/dist/formats/gltf/core/helpers.js +287 -307
  97. package/dist/formats/gltf/core/helpers.js.map +1 -1
  98. package/dist/formats/gltf/core/json.js +79 -79
  99. package/dist/formats/gltf/core/parser.js +679 -679
  100. package/dist/formats/gltf/core/targets.js +173 -173
  101. package/dist/formats/gltf/index.js +2 -2
  102. package/dist/formats/gr2/CjsGr2Format.js +289 -289
  103. package/dist/formats/gr2/core/bitknit2.js +282 -282
  104. package/dist/formats/gr2/core/curves.js +1047 -1047
  105. package/dist/formats/gr2/core/gsf.js +72 -72
  106. package/dist/formats/gr2/core/helpers.js +352 -352
  107. package/dist/formats/gr2/core/json.js +622 -622
  108. package/dist/formats/gr2/core/oodle1.js +388 -388
  109. package/dist/formats/gr2/core/tangents.js +48 -48
  110. package/dist/formats/gr2/core/targets.js +361 -361
  111. package/dist/formats/gr2/index.js +2 -2
  112. package/dist/formats/hlsl/CjsHlslFormat.js +233 -254
  113. package/dist/formats/hlsl/CjsHlslFormat.js.map +1 -1
  114. package/dist/formats/hlsl/core/HlslBinaryUtils.js +15 -15
  115. package/dist/formats/hlsl/core/HlslEffectReadError.js +19 -19
  116. package/dist/formats/hlsl/core/HlslEffectStateManager.js +130 -130
  117. package/dist/formats/hlsl/core/HlslRenderStateSetup.js +37 -37
  118. package/dist/formats/hlsl/core/HlslResourceSetDescription.js +94 -94
  119. package/dist/formats/hlsl/core/HlslShaderBytecode.js +44 -44
  120. package/dist/formats/hlsl/core/analysis.js +51 -51
  121. package/dist/formats/hlsl/core/carbonDescriptionToRuntime.js +850 -850
  122. package/dist/formats/hlsl/core/detailMapFamily.js +128 -128
  123. package/dist/formats/hlsl/core/helpers.js +270 -270
  124. package/dist/formats/hlsl/core/json.js +284 -284
  125. package/dist/formats/hlsl/core/localLightFamily.js +133 -133
  126. package/dist/formats/hlsl/core/metadata.js +327 -327
  127. package/dist/formats/hlsl/core/render-states.js +280 -280
  128. package/dist/formats/hlsl/core/tr2/HlslRenderContextEnum.js +43 -43
  129. package/dist/formats/hlsl/core/tr2/resources/HlslEffectRes.js +320 -320
  130. package/dist/formats/hlsl/core/tr2/resources/HlslShaderPermutation.js +33 -33
  131. package/dist/formats/hlsl/core/tr2/shader/HlslEffectBindingManifest.js +423 -416
  132. package/dist/formats/hlsl/core/tr2/shader/HlslEffectBindingManifest.js.map +1 -1
  133. package/dist/formats/hlsl/core/tr2/shader/HlslEffectConstant.js +40 -40
  134. package/dist/formats/hlsl/core/tr2/shader/HlslEffectDescription.js +62 -62
  135. package/dist/formats/hlsl/core/tr2/shader/HlslEffectLibrary.js +52 -52
  136. package/dist/formats/hlsl/core/tr2/shader/HlslEffectParameterAnnotation.js +38 -38
  137. package/dist/formats/hlsl/core/tr2/shader/HlslEffectResource.js +50 -50
  138. package/dist/formats/hlsl/core/tr2/shader/HlslEffectStageInput.js +86 -86
  139. package/dist/formats/hlsl/core/tr2/shader/HlslEffectTechnique.js +31 -31
  140. package/dist/formats/hlsl/core/tr2/shader/HlslPass.js +42 -42
  141. package/dist/formats/hlsl/core/tr2/shader/HlslSamplerDescription.js +55 -55
  142. package/dist/formats/hlsl/core/tr2/shader/HlslSamplerSetup.js +29 -29
  143. package/dist/formats/hlsl/core/tr2/shader/HlslShader.js +220 -220
  144. package/dist/formats/hlsl/core/tr2/shader/HlslShaderOption.js +30 -30
  145. package/dist/formats/hlsl/index.js +3 -3
  146. package/dist/formats/index.js +33 -33
  147. package/dist/formats/jpeg/CjsJpegFormat.js +212 -212
  148. package/dist/formats/jpeg/core/helpers.js +402 -402
  149. package/dist/formats/jpeg/core/jpeg.js +480 -480
  150. package/dist/formats/jpeg/index.js +2 -2
  151. package/dist/formats/mp3/CjsMp3Format.js +197 -197
  152. package/dist/formats/mp3/core/helpers.js +375 -375
  153. package/dist/formats/mp3/index.js +2 -2
  154. package/dist/formats/mp4/CjsMp4Format.js +197 -197
  155. package/dist/formats/mp4/core/helpers.js +484 -484
  156. package/dist/formats/mp4/index.js +2 -2
  157. package/dist/formats/obj/CjsObjFormat.js +232 -253
  158. package/dist/formats/obj/CjsObjFormat.js.map +1 -1
  159. package/dist/formats/obj/core/helpers.js +553 -573
  160. package/dist/formats/obj/core/helpers.js.map +1 -1
  161. package/dist/formats/obj/core/json.js +64 -64
  162. package/dist/formats/obj/core/parser.js +321 -321
  163. package/dist/formats/obj/index.js +2 -2
  164. package/dist/formats/ogg/CjsOggFormat.js +143 -143
  165. package/dist/formats/ogg/core/helpers.js +410 -410
  166. package/dist/formats/ogg/core/imdct.js +178 -178
  167. package/dist/formats/ogg/core/vorbis.js +1017 -1017
  168. package/dist/formats/ogg/index.js +2 -2
  169. package/dist/formats/pickle/CjsPickleFormat.js +214 -214
  170. package/dist/formats/pickle/core/CjsPickleProtocol0Reader.js +551 -551
  171. package/dist/formats/pickle/index.js +2 -2
  172. package/dist/formats/png/CjsPngFormat.js +201 -201
  173. package/dist/formats/png/core/helpers.js +635 -635
  174. package/dist/formats/png/index.js +2 -2
  175. package/dist/formats/red/CjsRedFormat.js +263 -263
  176. package/dist/formats/red/core/CjsRedReader.js +246 -246
  177. package/dist/formats/red/core/blackDefinitions.js +3 -3
  178. package/dist/formats/red/core/helpers.js +158 -158
  179. package/dist/formats/red/core/redGraph.js +71 -71
  180. package/dist/formats/red/core/schema.js +4 -4
  181. package/dist/formats/red/index.js +2 -2
  182. package/dist/formats/stl/CjsStlFormat.js +320 -365
  183. package/dist/formats/stl/CjsStlFormat.js.map +1 -1
  184. package/dist/formats/stl/core/helpers.js +241 -261
  185. package/dist/formats/stl/core/helpers.js.map +1 -1
  186. package/dist/formats/stl/core/json.js +51 -51
  187. package/dist/formats/stl/core/stl.js +642 -642
  188. package/dist/formats/stl/core/targets.js +173 -173
  189. package/dist/formats/stl/index.js +2 -2
  190. package/dist/formats/tga/CjsTgaFormat.js +197 -197
  191. package/dist/formats/tga/core/helpers.js +493 -493
  192. package/dist/formats/tga/index.js +2 -2
  193. package/dist/formats/wav/CjsWavFormat.js +198 -198
  194. package/dist/formats/wav/core/helpers.js +365 -365
  195. package/dist/formats/wav/index.js +2 -2
  196. package/dist/formats/webgl/CjsWebglFormat.js +199 -199
  197. package/dist/formats/webgl/core/buildGlslEffectContainer.js +70 -70
  198. package/dist/formats/webgl/core/effectPackage.js +900 -900
  199. package/dist/formats/webgl/core/errors.js +27 -27
  200. package/dist/formats/webgl/core/glsl/DxbcGlslEmitter.js +2820 -2820
  201. package/dist/formats/webgl/core/glsl/DxbcGlslHelpers.js +89 -89
  202. package/dist/formats/webgl/core/glsl/DxbcGlslOperandFormatter.js +486 -486
  203. package/dist/formats/webgl/core/glsl/packedLightFixups.js +98 -98
  204. package/dist/formats/webgl/core/glslBackendBlock.js +552 -552
  205. package/dist/formats/webgl/core/glslBackendBodySet.js +243 -243
  206. package/dist/formats/webgl/core/glslEffectCompleteness.js +85 -85
  207. package/dist/formats/webgl/core/glslEffectCompleteness.js.map +1 -1
  208. package/dist/formats/webgl/core/helpers.js +167 -167
  209. package/dist/formats/webgl/core/inspectGlslEffectContainer.js +122 -122
  210. package/dist/formats/webgl/core/readGlslEffectContainer.js +202 -256
  211. package/dist/formats/webgl/core/readGlslEffectContainer.js.map +1 -1
  212. package/dist/formats/webgl/index.js +2 -2
  213. package/dist/formats/webgpu/CjsWebgpuFormat.js +357 -357
  214. package/dist/formats/webgpu/core/buildCarbonEffectContainer.js +89 -89
  215. package/dist/formats/webgpu/core/carbonWebgpu/CarbonWebgpuContainer.js +354 -354
  216. package/dist/formats/webgpu/core/carbonWebgpu/containerViews.js +355 -355
  217. package/dist/formats/webgpu/core/carbonWebgpu/validateContainer.js +90 -90
  218. package/dist/formats/webgpu/core/effectAnalysis.js +82 -82
  219. package/dist/formats/webgpu/core/effectBackendBodySet.js +306 -306
  220. package/dist/formats/webgpu/core/errors.js +20 -20
  221. package/dist/formats/webgpu/core/helpers.js +443 -443
  222. package/dist/formats/webgpu/core/ir/analyzeRegisterValues.js +212 -212
  223. package/dist/formats/webgpu/core/ir/buildControlFlow.js +220 -220
  224. package/dist/formats/webgpu/core/ir/indexableTemps.js +137 -137
  225. package/dist/formats/webgpu/core/ir/inferValueTypes.js +449 -449
  226. package/dist/formats/webgpu/core/ir/lowerDxbcToIr.js +494 -494
  227. package/dist/formats/webgpu/core/ir/resolveRegisterFlow.js +177 -177
  228. package/dist/formats/webgpu/core/ir/sourceLanes.js +61 -61
  229. package/dist/formats/webgpu/core/packageEffect.js +381 -381
  230. package/dist/formats/webgpu/core/packageEffectSelection.js +164 -164
  231. package/dist/formats/webgpu/core/packageMetadata.js +17 -17
  232. package/dist/formats/webgpu/core/schema.js +4 -4
  233. package/dist/formats/webgpu/core/wgsl/buildResourceTransformPlan.js +263 -263
  234. package/dist/formats/webgpu/core/wgsl/buildWgslBindingPlan.js +172 -172
  235. package/dist/formats/webgpu/core/wgsl/buildWgslSet.js +325 -325
  236. package/dist/formats/webgpu/core/wgsl/emitWgsl.js +356 -356
  237. package/dist/formats/webgpu/core/wgsl/hoistEscapingValues.js +77 -77
  238. package/dist/formats/webgpu/core/wgsl/lowerBindingLayout.js +451 -451
  239. package/dist/formats/webgpu/core/wgsl/lowerComputeProgram.js +735 -735
  240. package/dist/formats/webgpu/core/wgsl/lowerCreateHistogramsComputeProgram.js +457 -457
  241. package/dist/formats/webgpu/core/wgsl/lowerFragmentProgram.js +1572 -1572
  242. package/dist/formats/webgpu/core/wgsl/lowerMergeHistogramsComputeProgram.js +659 -659
  243. package/dist/formats/webgpu/core/wgsl/lowerParticleClearComputePrograms.js +734 -734
  244. package/dist/formats/webgpu/core/wgsl/lowerParticleEmitComputeProgram.js +583 -583
  245. package/dist/formats/webgpu/core/wgsl/lowerSkinVerticesComputeProgram.js +621 -621
  246. package/dist/formats/webgpu/core/wgsl/lowerSortComputeProgram.js +824 -824
  247. package/dist/formats/webgpu/core/wgsl/lowerSortInnerComputeProgram.js +697 -697
  248. package/dist/formats/webgpu/core/wgsl/lowerSortStepComputeProgram.js +559 -559
  249. package/dist/formats/webgpu/core/wgsl/lowerVertexProgram.js +1328 -1328
  250. package/dist/formats/webgpu/core/wgsl/particleEmitSemanticDigest.js +110 -110
  251. package/dist/formats/webgpu/core/wgsl/precisionControls.js +55 -55
  252. package/dist/formats/webgpu/core/wgsl/selectionPlans.js +717 -717
  253. package/dist/formats/webgpu/core/wgsl/uniformity.js +78 -78
  254. package/dist/formats/webgpu/core/wgsl/validateExactComputeIr.js +196 -196
  255. package/dist/formats/webgpu/core/wgsl/validateHandleOperand.js +37 -37
  256. package/dist/formats/webgpu/index.js +2 -2
  257. package/dist/formats/webm/CjsWebmFormat.js +197 -197
  258. package/dist/formats/webm/core/helpers.js +572 -572
  259. package/dist/formats/webm/index.js +2 -2
  260. package/dist/formats/webp/CjsWebpFormat.js +140 -140
  261. package/dist/formats/webp/core/helpers.js +237 -237
  262. package/dist/formats/webp/index.js +2 -2
  263. package/dist/formats/wem/CjsWemFormat.js +250 -250
  264. package/dist/formats/wem/core/bitStream.js +261 -261
  265. package/dist/formats/wem/core/codebookLibrary.js +164 -164
  266. package/dist/formats/wem/core/helpers.js +437 -437
  267. package/dist/formats/wem/core/packedCodebooksAotuv603.js +30 -30
  268. package/dist/formats/wem/core/ptadpcm.js +77 -77
  269. package/dist/formats/wem/core/resolve.js +121 -121
  270. package/dist/formats/wem/core/wemToOgg.js +485 -485
  271. package/dist/formats/wem/index.js +2 -2
  272. package/dist/formats/yaml/CjsYamlFormat.js +134 -134
  273. package/dist/formats/yaml/core/CjsYamlReader.js +400 -400
  274. package/dist/formats/yaml/core/helpers.js +196 -196
  275. package/dist/formats/yaml/index.js +2 -2
  276. package/dist/index.js +64 -64
  277. package/dist/resource/CjsLoadingObject.js +19 -19
  278. package/dist/resource/CjsResource.js +801 -801
  279. package/dist/resource/ResourceHandlerMode.js +14 -14
  280. package/dist/resource/Tr2LightProfileRes.js +32 -32
  281. package/dist/resource/audio/AudioGeometryResData.js +47 -47
  282. package/dist/resource/audio/CjsAudioBufferRes.js +86 -86
  283. package/dist/resource/audio/CjsAudioRes.js +213 -213
  284. package/dist/resource/audio/index.js +4 -4
  285. package/dist/resource/geometry/MeshDecalData.js +37 -37
  286. package/dist/resource/geometry/MeshDecalLodData.js +34 -34
  287. package/dist/resource/geometry/TriGeometryRes.js +570 -467
  288. package/dist/resource/geometry/TriGeometryRes.js.map +1 -1
  289. package/dist/resource/geometry/TriGeometryResAreaData.js +59 -59
  290. package/dist/resource/geometry/TriGeometryResJointData.js +38 -38
  291. package/dist/resource/geometry/TriGeometryResLodData.js +88 -88
  292. package/dist/resource/geometry/TriGeometryResMeshData.js +63 -63
  293. package/dist/resource/geometry/TriGeometryResSkeletonData.js +34 -34
  294. package/dist/resource/geometry/TriJointBinding.js +38 -38
  295. package/dist/resource/geometry/TriMorphTargetGeometryConstants.js +46 -46
  296. package/dist/resource/geometry/TriRtGeometryConstants.js +88 -88
  297. package/dist/resource/geometry/granny/GStateBindingCallbackData.js +31 -31
  298. package/dist/resource/geometry/granny/Tr2GrannyIntersectionResult.js +60 -60
  299. package/dist/resource/geometry/granny/Tr2GrannyStateRes.js +36 -36
  300. package/dist/resource/geometry/granny/TriGrannyRes.js +35 -35
  301. package/dist/resource/geometry/granny/enums.js +10 -10
  302. package/dist/resource/geometry/granny/index.js +6 -6
  303. package/dist/resource/geometry/index.js +17 -17
  304. package/dist/resource/index.js +54 -54
  305. package/dist/resource/resourceBoundary.js +64 -64
  306. package/dist/resource/shader/Tr2EffectRes.js +336 -336
  307. package/dist/resource/shader/Tr2MaterialArea.js +31 -31
  308. package/dist/resource/shader/Tr2MaterialMesh.js +27 -27
  309. package/dist/resource/shader/Tr2MaterialRes.js +31 -31
  310. package/dist/resource/shader/Tr2Shader.js +283 -283
  311. package/dist/resource/shader/Tr2ShaderPermutation.js +43 -43
  312. package/dist/resource/shader/index.js +17 -17
  313. package/dist/resource/shader/reflection/Tr2EffectConstant.js +143 -143
  314. package/dist/resource/shader/reflection/Tr2EffectDefine.js +30 -30
  315. package/dist/resource/shader/reflection/Tr2EffectDescription.js +114 -114
  316. package/dist/resource/shader/reflection/Tr2EffectLibrary.js +168 -168
  317. package/dist/resource/shader/reflection/Tr2EffectParameterAnnotation.js +125 -125
  318. package/dist/resource/shader/reflection/Tr2EffectResource.js +120 -120
  319. package/dist/resource/shader/reflection/Tr2EffectStageInput.js +372 -372
  320. package/dist/resource/shader/reflection/Tr2EffectTechnique.js +78 -78
  321. package/dist/resource/shader/reflection/Tr2Pass.js +168 -168
  322. package/dist/resource/shader/reflection/carbonRecordFields.js +159 -159
  323. package/dist/resource/shader/reflection/shaderStage.js +22 -22
  324. package/dist/resource/shader/sampler/Tr2SamplerSetup.js +135 -135
  325. package/dist/resource/texture/CjsTextureArrayRes.js +472 -472
  326. package/dist/resource/texture/CjsTextureArrayResParameterProxy.js +179 -179
  327. package/dist/resource/texture/Tr2ImageRes.js +120 -120
  328. package/dist/resource/texture/Tr2TextureLodManager.js +82 -82
  329. package/dist/resource/texture/Tr2TextureLodUpdateRequest.js +37 -37
  330. package/dist/resource/texture/Tr2TexturePackChannel.js +37 -37
  331. package/dist/resource/texture/Tr2TexturePipeline.js +54 -54
  332. package/dist/resource/texture/Tr2TexturePipelineParams.js +34 -34
  333. package/dist/resource/texture/Tr2TexturePipelineStepCompress.js +40 -40
  334. package/dist/resource/texture/Tr2TexturePipelineStepGenerateMips.js +22 -22
  335. package/dist/resource/texture/Tr2TexturePipelineStepLimitSize.js +34 -34
  336. package/dist/resource/texture/Tr2TexturePipelineStepLoad.js +31 -31
  337. package/dist/resource/texture/Tr2TexturePipelineStepPack.js +43 -43
  338. package/dist/resource/texture/TriTextureRes.js +359 -359
  339. package/dist/resource/texture/index.js +15 -15
  340. package/dist/resource/texture/texturePipelineBehavior.js +308 -308
  341. package/dist/worker/CjsResManMainThreadLoader.js +89 -89
  342. package/dist/worker/CjsResManWorker.js +218 -218
  343. package/dist/worker/CjsResManWorkerLoader.js +437 -437
  344. package/dist/worker/protocol.js +12 -12
  345. package/docs/README.md +98 -98
  346. package/docs/architecture.md +118 -118
  347. package/docs/concepts/resource-lifecycle.md +226 -226
  348. package/docs/concepts/shader-resource-model.md +111 -111
  349. package/docs/concepts/writing-an-engine-adapter.md +115 -115
  350. package/docs/formats/README.md +138 -138
  351. package/docs/formats/carbon-effect-container.md +553 -553
  352. package/docs/formats/dxbc/README.md +68 -68
  353. package/docs/formats/dxbc/architecture.md +80 -80
  354. package/docs/formats/dxbc/reference/api.md +105 -77
  355. package/docs/formats/dxbc/reference/classes/README.md +9 -9
  356. package/docs/formats/dxbc/reference/decoded-output.md +122 -122
  357. package/docs/formats/gr2.md +160 -160
  358. package/docs/formats/hlsl/README.md +54 -54
  359. package/docs/formats/hlsl/architecture.md +66 -65
  360. package/docs/formats/hlsl/guides/hydrating-json-output.md +60 -60
  361. package/docs/formats/hlsl/guides/reading-effects.md +68 -64
  362. package/docs/formats/hlsl/reference/advanced-analysis.md +61 -61
  363. package/docs/formats/hlsl/reference/api.md +91 -92
  364. package/docs/formats/hlsl/reference/classes/README.md +11 -11
  365. package/docs/formats/hlsl/reference/json-graph.md +97 -97
  366. package/docs/formats/pickle.md +82 -82
  367. package/docs/formats/provenance.md +196 -196
  368. package/docs/formats/stl.md +37 -37
  369. package/docs/formats/webgl/README.md +115 -115
  370. package/docs/formats/webgl/architecture.md +69 -69
  371. package/docs/formats/webgl/carbon-constant-layouts.md +326 -326
  372. package/docs/formats/webgl/decl-io.md +1234 -1234
  373. package/docs/formats/webgl/memory-structured.md +890 -890
  374. package/docs/formats/webgl/reference/classes/README.md +9 -9
  375. package/docs/formats/webgl/texture-sample.md +964 -964
  376. package/docs/formats/webgpu/README.md +84 -84
  377. package/docs/formats/webgpu/architecture.md +95 -95
  378. package/docs/formats/webgpu/formats/carbon-webgpu.md +215 -215
  379. package/docs/formats/webgpu/guides/effect-packaging.md +189 -189
  380. package/docs/formats/webgpu/reference/api.md +196 -196
  381. package/docs/formats/webgpu/reference/classes/README.md +9 -9
  382. package/docs/formats/webgpu/reference/wgsl-compatibility.md +1546 -1546
  383. package/docs/formats/wwise.md +146 -146
  384. package/docs/reference/classes/README.md +35 -35
  385. package/docs/reference/classes/audio.md +30 -30
  386. package/docs/reference/classes/core.md +216 -216
  387. package/docs/reference/classes/dropped.md +46 -46
  388. package/docs/reference/classes/formats.md +944 -944
  389. package/docs/reference/classes/resources.md +456 -456
  390. package/docs/reference/classes/texture.md +26 -26
  391. package/docs/reference/events.md +117 -117
  392. package/docs/reference/motherlode-cache.md +275 -275
  393. package/docs/reference/queues.md +194 -194
  394. package/docs/reference/reload.md +107 -107
  395. package/docs/reference/texture-arrays.md +113 -113
  396. package/docs/reference/texture-pipeline.md +53 -53
  397. package/docs/reference/workers.md +142 -142
  398. package/docs/roadmap.md +150 -150
  399. package/format-notices/black/LICENSE +21 -21
  400. package/format-notices/black/NOTICE +47 -47
  401. package/format-notices/bnk/LICENSE +21 -21
  402. package/format-notices/bnk/NOTICE +21 -21
  403. package/format-notices/cmf/LICENSE +21 -21
  404. package/format-notices/cmf/NOTICE +36 -36
  405. package/format-notices/dds/LICENSE +21 -21
  406. package/format-notices/dds/NOTICE +14 -14
  407. package/format-notices/dxbc/LICENSE +21 -21
  408. package/format-notices/dxbc/NOTICE +20 -20
  409. package/format-notices/fbx/LICENSE +21 -21
  410. package/format-notices/fbx/NOTICE +14 -14
  411. package/format-notices/flac/LICENSE +21 -21
  412. package/format-notices/flac/NOTICE +14 -14
  413. package/format-notices/gif/LICENSE +21 -21
  414. package/format-notices/gif/NOTICE +14 -14
  415. package/format-notices/gltf/LICENSE +21 -21
  416. package/format-notices/gltf/NOTICE +27 -27
  417. package/format-notices/gr2/LICENSE +21 -21
  418. package/format-notices/gr2/NOTICE +60 -60
  419. package/format-notices/gr2/THIRD-PARTY-NOTICES.md +93 -93
  420. package/format-notices/hlsl/LICENSE +21 -21
  421. package/format-notices/hlsl/NOTICE +25 -25
  422. package/format-notices/jpeg/LICENSE +21 -21
  423. package/format-notices/jpeg/NOTICE +14 -14
  424. package/format-notices/mp3/LICENSE +21 -21
  425. package/format-notices/mp3/NOTICE +14 -14
  426. package/format-notices/mp4/LICENSE +21 -21
  427. package/format-notices/mp4/NOTICE +14 -14
  428. package/format-notices/obj/LICENSE +21 -21
  429. package/format-notices/obj/NOTICE +26 -26
  430. package/format-notices/ogg/LICENSE +21 -21
  431. package/format-notices/ogg/NOTICE +28 -28
  432. package/format-notices/png/LICENSE +21 -21
  433. package/format-notices/png/NOTICE +14 -14
  434. package/format-notices/red/LICENSE +21 -21
  435. package/format-notices/red/NOTICE +31 -31
  436. package/format-notices/stl/LICENSE +21 -21
  437. package/format-notices/stl/NOTICE +21 -21
  438. package/format-notices/tga/LICENSE +21 -21
  439. package/format-notices/tga/NOTICE +14 -14
  440. package/format-notices/wav/LICENSE +21 -21
  441. package/format-notices/wav/NOTICE +14 -14
  442. package/format-notices/webgl/LICENSE +21 -21
  443. package/format-notices/webgl/NOTICE +35 -35
  444. package/format-notices/webgpu/LICENSE +21 -21
  445. package/format-notices/webgpu/NOTICE +31 -31
  446. package/format-notices/webm/LICENSE +21 -21
  447. package/format-notices/webm/NOTICE +14 -14
  448. package/format-notices/webp/LICENSE +21 -21
  449. package/format-notices/webp/NOTICE +14 -14
  450. package/format-notices/wem/LICENSE +57 -57
  451. package/format-notices/wem/NOTICE +33 -33
  452. package/format-notices/yaml/LICENSE +21 -21
  453. package/format-notices/yaml/NOTICE +44 -44
  454. package/package.json +63 -63
@@ -1,850 +1,850 @@
1
- import { CjsFormatReadError } from '../../../format/CjsFormatError.js';
2
- import { HlslEffectConstant } from './tr2/shader/HlslEffectConstant.js';
3
- import { HlslEffectLibrary } from './tr2/shader/HlslEffectLibrary.js';
4
- import { HlslEffectParameterAnnotation } from './tr2/shader/HlslEffectParameterAnnotation.js';
5
- import { HlslEffectResource } from './tr2/shader/HlslEffectResource.js';
6
- import { HlslEffectStageInput } from './tr2/shader/HlslEffectStageInput.js';
7
- import { HlslEffectStateManager } from './HlslEffectStateManager.js';
8
- import { HlslEffectTechnique } from './tr2/shader/HlslEffectTechnique.js';
9
- import { HlslPass } from './tr2/shader/HlslPass.js';
10
- import { HlslShaderBytecode } from './HlslShaderBytecode.js';
11
- import { HlslRenderContextEnum, HlslUsageCodeNames } from './tr2/HlslRenderContextEnum.js';
12
- import { HlslRenderStateSetup } from './HlslRenderStateSetup.js';
13
- import { HlslResourceSetDescription } from './HlslResourceSetDescription.js';
14
- import { HlslSamplerDescription } from './tr2/shader/HlslSamplerDescription.js';
15
- import { HlslSamplerSetup } from './tr2/shader/HlslSamplerSetup.js';
16
-
17
- /**
18
- * Rebuilds the runtime effect-description shape from a Carbon record tree.
19
- *
20
- * This is a **shape adapter and nothing else**. It adds no semantics: its whole
21
- * job is to turn the parsed container records into the object graph
22
- * `HlslEffectBindingManifest.fromEffectDescription` already consumes, so that
23
- * `buildEffectAnalysis` runs unchanged on a container-derived description. The
24
- * derived view stays the same function it has always been rather than a
25
- * reimplementation free to drift from it.
26
- *
27
- * ## Why this is not a field copy
28
- *
29
- * The wire shape and the runtime shape are genuinely different shapes, and every
30
- * difference is a place a copying adapter produces something that reads as
31
- * plausible and is wrong:
32
- *
33
- * | wire | runtime | conversion |
34
- * |---|---|---|
35
- * | `name: {offset, value}` | `name: "NormalMap"` | unwrap the arena string reference |
36
- * | `count` | `arrayElements` | **renamed** — see `mapTextureRecord` |
37
- * | `isSRGB: 0` | `isSRGB: false` | integer to boolean |
38
- * | flat sampler fields | `{name, sampler: {...}}` | **re-nested** — see `mapSamplerRecord` |
39
- * | UAV has no `isSRGB` | `isSRGB: false` | **synthesised** — see `mapUavRecord` |
40
- * | `registerIndex` field | map key | consumed as the key, not a payload field |
41
- *
42
- * Three of those are silent when wrong. `arrayElements` is read at
43
- * `packageHelpers.js:869` and a rename yields `undefined` there. `isSRGB` as `0`
44
- * is *accidentally correct* — `0` is falsy, `1` is truthy — so it survives every
45
- * behavioural test and only a structural diff sees it. A flat sampler puts all
46
- * fourteen descriptor fields at the wrong depth at once.
47
- *
48
- * ## The tables are closed
49
- *
50
- * Every record is built through `mapClosed`, which walks the **source** keys and
51
- * throws on any key with no rule. Nothing is spread and nothing is copied
52
- * wholesale. That converts "did we enumerate every field?" — a question whose
53
- * wrong answer shows up months later as `undefined` in the engine — into an error
54
- * the first time the adapter meets a record it does not fully understand.
55
- *
56
- * This is deliberately redundant with the two-sided diff in
57
- * `test/formats/webgpu/carbon-analysis-adapter.test.mjs`, and neither replaces the
58
- * other. The table catches *the wire has something we do not handle*; the diff
59
- * catches *our output differs from the reference*. A complete table can still map
60
- * a field wrongly, and a passing diff on one fixture says nothing about a key that
61
- * fixture never exercises.
62
- *
63
- * ## What is derived rather than stored
64
- *
65
- * `m_shader`, `pass.shaderProgram` and `pass.renderStates` are registration
66
- * handles from `HlslEffectStateManager`, which are monotonic counters and
67
- * therefore reproduce exactly when registration happens in the same order. That
68
- * is why stages are walked in **wire array order** rather than by ascending
69
- * stage type: the source reader registers them in the order the file lists them.
70
- * `resourceSetDesc` and its `heapViews` are likewise rebuilt by running the same
71
- * derivation the source reader runs, not carried on the wire.
72
- */
73
-
74
- /** Carbon annotation type for a string-valued annotation. */
75
- const ANNOTATION_TYPE_STRING = HlslEffectParameterAnnotation.Type.STRING;
76
- const rawView = new DataView(new ArrayBuffer(4));
77
-
78
- /**
79
- * Unwraps an arena string reference to its text.
80
- *
81
- * @param {{offset:number, value:string}|null} reference Wire string reference.
82
- * @returns {string} The referenced text.
83
- */
84
- function text(reference) {
85
- return typeof reference?.value === "string" ? reference.value : "";
86
- }
87
-
88
- /**
89
- * Converts a wire `u8` flag to the boolean the runtime shape carries.
90
- *
91
- * @param {number} value Wire flag.
92
- * @returns {boolean} Boolean form.
93
- */
94
- function flag(value) {
95
- return Boolean(value);
96
- }
97
-
98
- /**
99
- * Reads four wire bytes as the little-endian `u32` the runtime annotation holds.
100
- *
101
- * @param {Uint8Array|null} bytes Four raw bytes.
102
- * @returns {number} Unsigned 32-bit value.
103
- */
104
- function rawUint32(bytes) {
105
- if (!bytes || bytes.length < 4) return 0;
106
- rawView.setUint8(0, bytes[0]);
107
- rawView.setUint8(1, bytes[1]);
108
- rawView.setUint8(2, bytes[2]);
109
- rawView.setUint8(3, bytes[3]);
110
- return rawView.getUint32(0, true);
111
- }
112
-
113
- /**
114
- * Reinterprets a `u32` bit pattern as the float it encodes.
115
- *
116
- * @param {number} bits Raw 32-bit pattern.
117
- * @returns {number} The float those bits encode.
118
- */
119
- function floatFromBits(bits) {
120
- rawView.setUint32(0, bits >>> 0, true);
121
- return rawView.getFloat32(0, true);
122
- }
123
-
124
- /**
125
- * Builds an object from a record by walking the record's own keys against a
126
- * closed rule table, throwing on any key the table does not name.
127
- *
128
- * Walking the **source** keys is the point. A table walked from its own entries
129
- * would silently ignore a field the wire gained, which is exactly the failure
130
- * this exists to make loud.
131
- *
132
- * @param {object} record Source wire record.
133
- * @param {object} rules Rule table keyed by source field name.
134
- * @param {object} target Object to populate.
135
- * @param {string} what Record kind, for the error message.
136
- * @returns {object} The populated target.
137
- */
138
- function mapClosed(record, rules, target, what) {
139
- for (const key of Object.keys(record)) {
140
- const rule = rules[key];
141
- if (!rule) {
142
- throw new CjsFormatReadError(`Carbon ${what} record carries field "${key}" with no mapping rule`, {
143
- record: what,
144
- field: key
145
- });
146
- }
147
- rule(target, record[key], record);
148
- }
149
- return target;
150
- }
151
-
152
- /** Consumes a field that is deliberately not part of the runtime payload. */
153
- const consumed = () => {};
154
-
155
- /** Texture record rules. `count` is Carbon's name for `arrayElements`. */
156
- const TEXTURE_RULES = Object.freeze({
157
- // Carried as the map key by the caller, not as a payload field.
158
- registerIndex: consumed,
159
- name: (target, value) => {
160
- target.name = text(value);
161
- },
162
- type: (target, value) => {
163
- target.type = value;
164
- },
165
- // RENAME: the wire calls this `count`; the runtime calls it `arrayElements`.
166
- // Copying the field name yields `arrayElements: undefined`, read silently at
167
- // `packageHelpers.js:869`.
168
- count: (target, value) => {
169
- target.arrayElements = value;
170
- },
171
- isSRGB: (target, value) => {
172
- target.isSRGB = flag(value);
173
- },
174
- isAutoregister: (target, value) => {
175
- target.isAutoregister = flag(value);
176
- }
177
- });
178
-
179
- /** UAV record rules. A UAV record has no `isSRGB`; it is synthesised. */
180
- const UAV_RULES = Object.freeze({
181
- registerIndex: consumed,
182
- name: (target, value) => {
183
- target.name = text(value);
184
- },
185
- type: (target, value) => {
186
- target.type = value;
187
- },
188
- // RENAME: same as the texture record.
189
- count: (target, value) => {
190
- target.arrayElements = value;
191
- },
192
- isAutoregister: (target, value) => {
193
- target.isAutoregister = flag(value);
194
- }
195
- });
196
-
197
- /** Sampler record rules. The wire record is flat; the runtime shape is nested. */
198
- const SAMPLER_RULES = Object.freeze({
199
- registerIndex: consumed,
200
- // Handled after the walk: the name depends on `isDynamic`, which the walk
201
- // may not have reached yet.
202
- name: consumed,
203
- isDynamic: (target, value) => {
204
- target.sampler.isDynamic = flag(value);
205
- },
206
- comparison: (target, value) => {
207
- target.sampler.comparison = flag(value);
208
- },
209
- minFilter: (target, value) => {
210
- target.sampler.minFilter = value;
211
- },
212
- magFilter: (target, value) => {
213
- target.sampler.magFilter = value;
214
- },
215
- mipFilter: (target, value) => {
216
- target.sampler.mipFilter = value;
217
- },
218
- addressU: (target, value) => {
219
- target.sampler.addressU = value;
220
- },
221
- addressV: (target, value) => {
222
- target.sampler.addressV = value;
223
- },
224
- addressW: (target, value) => {
225
- target.sampler.addressW = value;
226
- },
227
- mipLODBias: (target, value) => {
228
- target.sampler.mipLODBias = value;
229
- },
230
- maxAnisotropy: (target, value) => {
231
- target.sampler.maxAnisotropy = value;
232
- },
233
- comparisonFunc: (target, value) => {
234
- target.sampler.comparisonFunc = value;
235
- },
236
- borderColor: (target, value) => {
237
- target.sampler.borderColor = value.slice(0, 4);
238
- },
239
- minLOD: (target, value) => {
240
- target.sampler.minLOD = value;
241
- },
242
- maxLOD: (target, value) => {
243
- target.sampler.maxLOD = value;
244
- }
245
- });
246
-
247
- /** Static sampler rules. `borderColor` is a one-byte enum here, not four floats. */
248
- const STATIC_SAMPLER_RULES = Object.freeze({
249
- registerIndex: (target, value) => {
250
- target.registerIndex = value;
251
- },
252
- registerSpace: (target, value) => {
253
- target.registerSpace = value;
254
- },
255
- comparison: (target, value) => {
256
- target.sampler.comparison = flag(value);
257
- },
258
- minFilter: (target, value) => {
259
- target.sampler.minFilter = value;
260
- },
261
- magFilter: (target, value) => {
262
- target.sampler.magFilter = value;
263
- },
264
- mipFilter: (target, value) => {
265
- target.sampler.mipFilter = value;
266
- },
267
- addressU: (target, value) => {
268
- target.sampler.addressU = value;
269
- },
270
- addressV: (target, value) => {
271
- target.sampler.addressV = value;
272
- },
273
- addressW: (target, value) => {
274
- target.sampler.addressW = value;
275
- },
276
- mipLODBias: (target, value) => {
277
- target.sampler.mipLODBias = value;
278
- },
279
- maxAnisotropy: (target, value) => {
280
- target.sampler.maxAnisotropy = value;
281
- },
282
- comparisonFunc: (target, value) => {
283
- target.sampler.comparisonFunc = value;
284
- },
285
- borderColor: (target, value) => {
286
- target.sampler.borderColor = value;
287
- },
288
- minLOD: (target, value) => {
289
- target.sampler.minLOD = value;
290
- },
291
- maxLOD: (target, value) => {
292
- target.sampler.maxLOD = value;
293
- }
294
- });
295
-
296
- /** Constant record rules. */
297
- const CONSTANT_RULES = Object.freeze({
298
- name: (target, value) => {
299
- target.name = text(value);
300
- },
301
- offset: (target, value) => {
302
- target.offset = value;
303
- },
304
- size: (target, value) => {
305
- target.size = value;
306
- },
307
- type: (target, value) => {
308
- target.type = value;
309
- },
310
- dimension: (target, value) => {
311
- target.dimension = value;
312
- },
313
- elements: (target, value) => {
314
- target.elements = value;
315
- },
316
- isSRGB: (target, value) => {
317
- target.isSRGB = flag(value);
318
- },
319
- isAutoregister: (target, value) => {
320
- target.isAutoregister = flag(value);
321
- }
322
- });
323
-
324
- /** Register declaration rules. */
325
- const REGISTER_RULES = Object.freeze({
326
- registerType: (target, value) => {
327
- target.registerType = value;
328
- },
329
- registerIndex: (target, value) => {
330
- target.registerIndex = value;
331
- },
332
- // Carbon stores one field its reader calls `arrayCount` and its writer calls
333
- // `registerCount`. The runtime shape carries both names, always equal — the
334
- // producer refuses to write them when they disagree.
335
- registerCount: (target, value) => {
336
- target.registerCount = value;
337
- target.arrayCount = value;
338
- },
339
- registerSpace: (target, value) => {
340
- target.registerSpace = value;
341
- }
342
- });
343
-
344
- /**
345
- * Pipeline input rules.
346
- *
347
- * `usageName` is derived from the `usage` byte rather than carried: it is a
348
- * display name looked up from a table, exactly as Carbon derives it through
349
- * `GetStringForUsageCode` (`EffectData.h:86`). Nothing goes on the wire for it.
350
- */
351
- const PIPELINE_INPUT_RULES = Object.freeze({
352
- usage: (target, value) => {
353
- target.usage = value;
354
- target.usageName = HlslUsageCodeNames[value] || `USAGE_${value}`;
355
- },
356
- registerIndex: (target, value) => {
357
- target.registerIndex = value;
358
- },
359
- usageIndex: (target, value) => {
360
- target.usageIndex = value;
361
- },
362
- usedMask: (target, value) => {
363
- target.usedMask = value;
364
- },
365
- type: (target, value) => {
366
- target.type = value;
367
- },
368
- dimension: (target, value) => {
369
- target.dimension = value;
370
- }
371
- });
372
-
373
- /** Annotation rules. */
374
- const ANNOTATION_RULES = Object.freeze({
375
- name: (target, value) => {
376
- target.name = text(value);
377
- },
378
- type: (target, value) => {
379
- target.type = value;
380
- },
381
- stringValue: (target, value) => {
382
- if (value) target.stringValue = text(value);
383
- },
384
- // A non-string annotation value is four raw bytes: Carbon writes it through a
385
- // float union and reads it through a different one, so the bytes are the only
386
- // faithful form. The three typed views are derived from those bytes, one per
387
- // union member Carbon reads back through.
388
- rawValue: (target, value, record) => {
389
- if (record.type === ANNOTATION_TYPE_STRING) return;
390
- const bits = rawUint32(value);
391
- target.rawValue = bits;
392
- target.boolValue = bits !== 0;
393
- target.intValue = bits | 0;
394
- target.floatValue = floatFromBits(bits);
395
- }
396
- });
397
-
398
- /**
399
- * Maps one texture record onto its runtime resource object.
400
- *
401
- * @param {object} record Wire texture record.
402
- * @returns {HlslEffectResource} Runtime resource.
403
- */
404
- function mapTextureRecord(record) {
405
- return mapClosed(record, TEXTURE_RULES, new HlslEffectResource(), "texture");
406
- }
407
-
408
- /**
409
- * Maps one UAV record onto its runtime resource object.
410
- *
411
- * A UAV record is one byte shorter than a texture record: it carries no
412
- * `isSRGB`. Carbon's reader hardcodes it false (`Tr2EffectDescription.cpp:450`),
413
- * so the runtime object's
414
- * constructor default is restored explicitly rather than left to chance —
415
- * `metadata.toJSON()` emits the key for a UAV even though the wire never carries
416
- * it, because both kinds share `HlslEffectResource`.
417
- *
418
- * @param {object} record Wire UAV record.
419
- * @returns {HlslEffectResource} Runtime resource.
420
- */
421
- function mapUavRecord(record) {
422
- const resource = mapClosed(record, UAV_RULES, new HlslEffectResource(), "uav");
423
- resource.isSRGB = false;
424
- return resource;
425
- }
426
-
427
- /**
428
- * Maps one sampler record onto its runtime sampler setup.
429
- *
430
- * Two conversions beyond the flat-to-nested reshape:
431
- *
432
- * - Carbon nulls a sampler's name when it is not dynamic
433
- * (`Tr2EffectDescription.cpp:430-433`), so the wire's empty string must become
434
- * `null` again. A pre-v13 record carries no `isDynamic` at all; the class
435
- * default (dynamic) then keeps the name, matching the legacy reader, which
436
- * never assigned the flag for those versions. Like `isSRGB`, the nulling is
437
- * *accidentally correct* if left alone —
438
- * `""` and `null` are both falsy, so `metadataName` and the heap-view lookup
439
- * behave identically — and only a structural diff catches it.
440
- * - `comparison` and `isDynamic` are `u8` on the wire and boolean at runtime.
441
- *
442
- * @param {object} record Wire sampler record.
443
- * @returns {HlslSamplerSetup} Runtime sampler setup.
444
- */
445
- function mapSamplerRecord(record) {
446
- const setup = new HlslSamplerSetup();
447
- setup.sampler = new HlslSamplerDescription();
448
- mapClosed(record, SAMPLER_RULES, setup, "sampler");
449
- setup.name = setup.sampler.isDynamic ? text(record.name) : null;
450
- return setup;
451
- }
452
-
453
- /**
454
- * Maps one static sampler record onto its runtime signature entry.
455
- *
456
- * The runtime shape keeps the `*Raw` companions non-enumerable, so a
457
- * `cloneJson` of the descriptor sees the value form only.
458
- *
459
- * @param {object} record Wire static sampler record.
460
- * @returns {object} Runtime static sampler entry.
461
- */
462
- function mapStaticSamplerRecord(record) {
463
- const entry = {
464
- registerIndex: 0,
465
- registerSpace: 0,
466
- sampler: {
467
- comparison: false,
468
- minFilter: 0,
469
- magFilter: 0,
470
- mipFilter: 0,
471
- addressU: 0,
472
- addressV: 0,
473
- addressW: 0,
474
- mipLODBias: 0,
475
- maxAnisotropy: 0,
476
- comparisonFunc: 0,
477
- borderColor: 0,
478
- minLOD: 0,
479
- maxLOD: 0
480
- }
481
- };
482
- mapClosed(record, STATIC_SAMPLER_RULES, entry, "static sampler");
483
- Object.defineProperties(entry.sampler, {
484
- mipLODBiasRaw: {
485
- value: 0,
486
- writable: true
487
- },
488
- minLODRaw: {
489
- value: 0,
490
- writable: true
491
- },
492
- maxLODRaw: {
493
- value: 0,
494
- writable: true
495
- }
496
- });
497
- return entry;
498
- }
499
-
500
- /**
501
- * Maps one constant record onto its runtime constant object.
502
- *
503
- * @param {object} record Wire constant record.
504
- * @returns {HlslEffectConstant} Runtime constant.
505
- */
506
- function mapConstantRecord(record) {
507
- return mapClosed(record, CONSTANT_RULES, new HlslEffectConstant(), "constant");
508
- }
509
-
510
- /**
511
- * Maps one annotation record onto its runtime annotation object.
512
- *
513
- * @param {object} record Wire annotation record.
514
- * @returns {HlslEffectParameterAnnotation} Runtime annotation.
515
- */
516
- function mapAnnotationRecord(record) {
517
- return mapClosed(record, ANNOTATION_RULES, new HlslEffectParameterAnnotation(), "annotation");
518
- }
519
-
520
- /**
521
- * Restores the `dynamic` flag the source reader derives per register.
522
- *
523
- * Reproduced rather than stored: it is a function of the register type, the
524
- * stage type and the caller's per-frame start registers, none of which the
525
- * container needs to carry.
526
- *
527
- * @param {object} register Runtime register declaration.
528
- * @param {number} stageType Stage enum value.
529
- * @param {object} context Adapter context carrying the per-frame registers.
530
- * @returns {boolean} True when the register is dynamic.
531
- */
532
- function isRegisterDynamic(register, stageType, context) {
533
- if (register.registerType !== 0) return true;
534
- if (stageType === HlslRenderContextEnum.VERTEX_SHADER && register.registerIndex === context.perFrameVSStartRegister) return false;
535
- if (stageType === HlslRenderContextEnum.PIXEL_SHADER && register.registerIndex === context.perFramePSStartRegister) return false;
536
- return true;
537
- }
538
-
539
- /**
540
- * Populates one runtime stage input from a wire `StageData` block.
541
- *
542
- * @param {HlslEffectStageInput} input Destination stage input.
543
- * @param {object} data Wire stage data.
544
- * @param {number} stageType Stage enum value.
545
- * @param {object} context Adapter context.
546
- */
547
- function applyStageData(input, data, stageType, context) {
548
- input.signature.registers = (data.registers ?? []).map(record => {
549
- const register = mapClosed(record, REGISTER_RULES, {}, "register");
550
- register.dynamic = isRegisterDynamic(register, stageType, context);
551
- return register;
552
- });
553
- input.signature.samplers = (data.staticSamplers ?? []).map(mapStaticSamplerRecord);
554
- input.constants = (data.constants ?? []).map(mapConstantRecord);
555
-
556
- // The declared size is the unclamped one; the runtime clamps it to
557
- // SHADER_CONSTANTS_MAX and slices the payload to match, as Carbon does
558
- // (`Tr2EffectDescription.h:160`). `packMaterial` allocates an
559
- // ArrayBuffer of exactly this size, so restoring the unclamped value would
560
- // write past the layout the shader expects — on any effect above 4096 bytes
561
- // of constants, which is precisely the size a small fixture never reaches.
562
- const declaredSize = data.defaultValues?.size ?? 0;
563
- input.sourceConstantValueSize = declaredSize;
564
- input.sourceConstantValues = Uint8Array.from(data.defaultValues?.bytes ?? new Uint8Array(0));
565
- input.m_constantValueSize = Math.min(declaredSize, HlslEffectStageInput.SHADER_CONSTANTS_MAX);
566
- input.constantValues = input.sourceConstantValues.slice(0, input.m_constantValueSize);
567
- input.resources = new Map((data.textures ?? []).map(record => [record.registerIndex, mapTextureRecord(record)]));
568
- input.samplers = new Map((data.samplers ?? []).map(record => [record.registerIndex, mapSamplerRecord(record)]));
569
- input.uavs = new Map((data.uavs ?? []).map(record => [record.registerIndex, mapUavRecord(record)]));
570
- input.annotation = (data.annotations ?? []).map(mapAnnotationRecord);
571
-
572
- // Runs last, because it needs the sampler map. See the function's own note
573
- // for why it exists.
574
- for (const constant of input.constants) patchSamplerHeapIndexConstant(input, constant);
575
- }
576
-
577
- /**
578
- * Grows the constant block to cover a sampler heap-index constant.
579
- *
580
- * Applied to every constant once samplers are known, as Carbon's reader does:
581
- * a `UINT`/dimension-1 constant whose name matches a sampler is a heap index,
582
- * and the declared constant-value size can be smaller than the offset it sits
583
- * at. The block is extended rather than read out of bounds.
584
- *
585
- * **This is derived, not stored, and missing it is not cosmetic.** `packMaterial`
586
- * allocates `new ArrayBuffer(constantValueSize)`, so an unpatched size
587
- * under-allocates and the write runs past the end of the buffer the shader
588
- * expects. It appears only on dx12 -- the whole dx11 corpus is unaffected --
589
- * which is exactly why the analysis diff had to cover dx12 before this was
590
- * trustworthy. On `quaddetailv5.sm_depth` the declared 608 becomes 620.
591
- *
592
- * @param {object} input Runtime stage input, with samplers already populated.
593
- * @param {object} constant Runtime constant record.
594
- */
595
- function patchSamplerHeapIndexConstant(input, constant) {
596
- if (constant.type !== HlslEffectConstant.Type.UINT || constant.dimension !== 1) return;
597
- for (const sampler of input.samplers.values()) {
598
- if (sampler.name !== constant.name) continue;
599
- const neededSize = constant.offset + constant.size;
600
- if (neededSize > input.m_constantValueSize) {
601
- const next = new Uint8Array(neededSize);
602
- next.set(input.constantValues);
603
- input.constantValues = next;
604
- input.m_constantValueSize = neededSize;
605
- }
606
- break;
607
- }
608
- }
609
-
610
- /**
611
- * Rebuilds one runtime pass from a wire pass record.
612
- *
613
- * @param {object} record Wire pass record.
614
- * @param {object} context Adapter context.
615
- * @returns {HlslPass} Runtime pass.
616
- */
617
- function buildPass(record, context) {
618
- const pass = new HlslPass();
619
- const shaderTypes = [];
620
- const signatures = [];
621
- const shaderHandles = [];
622
-
623
- // Wire array order, not ascending stage type. The source reader registers
624
- // shaders in the order the file lists its stages, and the state manager's
625
- // handles are monotonic counters, so any other order reproduces the shape
626
- // with the handles permuted.
627
- for (const stage of record.stages ?? []) {
628
- const stageType = stage.type;
629
- const input = pass.stageInputs[stageType];
630
- if (!input) {
631
- throw new CjsFormatReadError(`Carbon stage record declares stage type ${stageType}, outside the runtime stage range`, {
632
- stageType
633
- });
634
- }
635
- if (input.m_exists) {
636
- throw new CjsFormatReadError(`Carbon pass declares stage type ${stageType} twice; the later stage would clobber the earlier`, {
637
- stageType
638
- });
639
- }
640
- input.m_exists = true;
641
- input.signature.threadGroupSize = {
642
- x: stage.threadGroupSize[0],
643
- y: stage.threadGroupSize[1],
644
- z: stage.threadGroupSize[2]
645
- };
646
- input.signature.pipelineInputs = (stage.pipelineInputs ?? []).map(entry => mapClosed(entry, PIPELINE_INPUT_RULES, {}, "pipeline input"));
647
- applyStageData(input, stage, stageType, context);
648
- input.cjsShaderBytecode = context.bytecodeFor ? context.bytecodeFor(stage, stageType, pass) : null;
649
- input.m_shader = context.effectStateManager.RegisterShader(stageType, input.cjsShaderBytecode, input.signature, context.effectName);
650
- shaderHandles.push(input.m_shader);
651
- shaderTypes.push(stageType);
652
- signatures.push(input.signature);
653
- pass.shaderTypeMask |= 1 << stageType;
654
- }
655
- pass.resourceSetDesc = new HlslResourceSetDescription(shaderTypes, signatures);
656
- for (let stageType = 0; stageType < HlslRenderContextEnum.SHADER_TYPE_COUNT; stageType += 1) {
657
- const input = pass.stageInputs[stageType];
658
- if (!input?.m_exists) continue;
659
- for (const [registerIndex, sampler] of input.samplers.entries()) {
660
- pass.resourceSetDesc.SetSampler(stageType, registerIndex, sampler.sampler);
661
- }
662
- }
663
- pass.shaderProgram = context.effectStateManager.RegisterShaderProgram(shaderHandles, shaderHandles.length);
664
- const states = new Map();
665
- for (const entry of record.renderStates ?? []) {
666
- if (states.has(entry.state)) {
667
- throw new CjsFormatReadError(`Carbon pass declares render state ${entry.state} twice`, {
668
- state: entry.state
669
- });
670
- }
671
- states.set(entry.state, entry.value);
672
- }
673
- pass.cjsRenderStateSetup = new HlslRenderStateSetup(states);
674
- pass.renderStates = context.effectStateManager.RegisterRenderStateSetup(pass.cjsRenderStateSetup);
675
- return pass;
676
- }
677
-
678
- /** Names an export slot per Carbon's raytracing export type codes. */
679
- const LIBRARY_EXPORT_NAME_FIELDS = Object.freeze(["rayGenName", "missName", "closestHitName", "anyHitName", "intersectionName"]);
680
-
681
- /** Library record rules; the nested pieces are handled by `buildLibrary`. */
682
- const LIBRARY_RULES = Object.freeze({
683
- payloadSize: (target, value) => {
684
- target.payloadSize = value;
685
- },
686
- hitGroupName: (target, value) => {
687
- target.hitGroupName = text(value);
688
- },
689
- // Consumed by buildLibrary: the blob becomes the registered bytecode.
690
- shaderData: consumed,
691
- // Consumed by buildLibrary: exports carry per-type name routing.
692
- exports: consumed,
693
- globalInputs: consumed,
694
- localInputs: consumed
695
- });
696
-
697
- /**
698
- * Rebuilds one runtime shader library from a wire library record.
699
- *
700
- * The two stage-data blocks reuse `applyStageData`, so a library's constants,
701
- * defaults, resources, samplers and UAVs go through exactly the rules a pass
702
- * stage goes through. The library bytecode is registered the way the runtime
703
- * registers it: a compute-typed `HlslShaderBytecode` under the state manager's
704
- * library registry, whose handles are a separate monotonic counter — adding
705
- * libraries does not shift any shader or program handle.
706
- *
707
- * @param {object} record Wire library record.
708
- * @param {object} context Adapter context.
709
- * @returns {HlslEffectLibrary} Runtime library.
710
- */
711
- function buildLibrary(record, context) {
712
- const library = mapClosed(record, LIBRARY_RULES, new HlslEffectLibrary(), "library");
713
- const shaderType = HlslRenderContextEnum.COMPUTE_SHADER;
714
- library.cjsShaderBytecode = new HlslShaderBytecode({
715
- stageType: shaderType,
716
- stageName: "library",
717
- bytes: record.shaderData?.bytes ?? new Uint8Array(0),
718
- shaderSize: record.shaderData?.size ?? 0,
719
- stringTableOffset: record.shaderData?.offset ?? null
720
- });
721
- library.libraryHandle = context.effectStateManager.RegisterShaderLibrary(library.cjsShaderBytecode);
722
- for (const entry of record.exports ?? []) {
723
- const name = text(entry.name);
724
- library.exports.push({
725
- type: entry.type,
726
- name
727
- });
728
- const field = LIBRARY_EXPORT_NAME_FIELDS[entry.type];
729
- if (field) library[field] = name;
730
- }
731
- applyStageData(library.globalInput, record.globalInputs ?? {}, shaderType, context);
732
- library.globalResourceSetDesc = new HlslResourceSetDescription([shaderType], [library.globalInput.signature]);
733
- for (const [registerIndex, sampler] of library.globalInput.samplers.entries()) {
734
- library.globalResourceSetDesc.SetSampler(shaderType, registerIndex, sampler.sampler);
735
- }
736
- applyStageData(library.localInput, record.localInputs ?? {}, shaderType, context);
737
- return library;
738
- }
739
-
740
- /**
741
- * Applies the `IsHeapView` annotations to the rebuilt resource-set descriptions.
742
- *
743
- * Derived rather than carried, over the annotations the container holds,
744
- * exactly as Carbon derives it after reading
745
- * (`Tr2EffectDescription.cpp:474-530`): a parameter whose top-level
746
- * annotations contain a true BOOL `IsHeapView` marks its register as a heap
747
- * view in the owning resource-set description, for library global inputs as
748
- * well as pass stages.
749
- *
750
- * @param {object} effectDescription Rebuilt effect description.
751
- */
752
- function applyHeapViewAnnotations(effectDescription) {
753
- const isHeapView = name => {
754
- if (!name) return false;
755
- const annotations = effectDescription.annotations.get(name) || [];
756
- return annotations.some(annotation => annotation.name === "IsHeapView" && annotation.type === HlslEffectParameterAnnotation.Type.BOOL && annotation.boolValue);
757
- };
758
- for (const technique of effectDescription.techniques) {
759
- for (const library of technique.libraries ?? []) {
760
- const shaderType = HlslRenderContextEnum.COMPUTE_SHADER;
761
- for (const [registerIndex, resource] of library.globalInput.resources.entries()) {
762
- if (isHeapView(resource.name)) library.globalResourceSetDesc?.SetSrvHeapView(shaderType, registerIndex);
763
- }
764
- for (const [registerIndex, resource] of library.globalInput.uavs.entries()) {
765
- if (isHeapView(resource.name)) library.globalResourceSetDesc?.SetUavHeapView(shaderType, registerIndex);
766
- }
767
- for (const [registerIndex, sampler] of library.globalInput.samplers.entries()) {
768
- if (isHeapView(sampler.name)) library.globalResourceSetDesc?.SetSamplerHeapView(shaderType, registerIndex);
769
- }
770
- }
771
- for (const pass of technique.passes) {
772
- for (let stageType = 0; stageType < pass.stageInputs.length; stageType += 1) {
773
- const stage = pass.stageInputs[stageType];
774
- if (!stage?.m_exists) continue;
775
- for (const [registerIndex, resource] of stage.resources.entries()) {
776
- if (isHeapView(resource.name)) pass.resourceSetDesc?.SetSrvHeapView(stageType, registerIndex);
777
- }
778
- for (const [registerIndex, resource] of stage.uavs.entries()) {
779
- if (isHeapView(resource.name)) pass.resourceSetDesc?.SetUavHeapView(stageType, registerIndex);
780
- }
781
- for (const [registerIndex, sampler] of stage.samplers.entries()) {
782
- if (isHeapView(sampler.name)) pass.resourceSetDesc?.SetSamplerHeapView(stageType, registerIndex);
783
- }
784
- }
785
- }
786
- }
787
- }
788
-
789
- /**
790
- * Rebuilds the runtime effect-description shape from a Carbon record tree.
791
- *
792
- * @param {object} description Parsed Carbon description record tree.
793
- * @param {object} [options] Adapter options.
794
- * @param {string} [options.effectName] Effect name or source path.
795
- * @param {number} [options.version] Carbon effect-data version.
796
- * @param {number} [options.perFrameVSStartRegister] Per-frame vertex start register.
797
- * @param {number} [options.perFramePSStartRegister] Per-frame pixel start register.
798
- * @param {Function} [options.bytecodeFor] Supplies `cjsShaderBytecode` per stage.
799
- * @param {HlslEffectStateManager} [options.effectStateManager] Registry override.
800
- * @returns {object} Runtime-shaped effect description.
801
- */
802
- function runtimeDescriptionFromCarbon(description, options = {}) {
803
- if (!description?.techniques) {
804
- throw new CjsFormatReadError("Carbon description has no techniques", {});
805
- }
806
- const context = {
807
- effectName: options.effectName ?? "",
808
- effectStateManager: options.effectStateManager ?? new HlslEffectStateManager(),
809
- bytecodeFor: options.bytecodeFor ?? null,
810
- perFrameVSStartRegister: Number.isInteger(options.perFrameVSStartRegister) ? options.perFrameVSStartRegister : null,
811
- perFramePSStartRegister: Number.isInteger(options.perFramePSStartRegister) ? options.perFramePSStartRegister : null
812
- };
813
- const effectDescription = {
814
- effectName: context.effectName,
815
- version: options.version ?? 15,
816
- techniques: [],
817
- annotations: new Map(),
818
- effectStateManager: context.effectStateManager
819
- };
820
- for (const record of description.techniques) {
821
- const technique = new HlslEffectTechnique();
822
- technique.name = text(record.name);
823
- technique.passes = (record.passes ?? []).map(pass => buildPass(pass, context));
824
- for (const pass of technique.passes) technique.shaderTypeMask |= pass.shaderTypeMask;
825
- // Raytracing libraries were once deliberately dropped here, when this
826
- // adapter served only `buildEffectAnalysis` — which reaches libraries
827
- // through no path, a claim the dx12 corpus diff measured (every body
828
- // of `unpacked_quadv5.sm_hi` carries an `RtShadow` library, and the
829
- // diff stayed green). Since the runtime read path converged on this
830
- // adapter, that scope no longer holds: `metadata.js` and `json.js`
831
- // emit `technique.libraries`, and the effect-resource contract
832
- // requires every library's exports, inputs and payload preserved.
833
- technique.libraries = (record.libraries ?? []).map(library => buildLibrary(library, context));
834
- effectDescription.techniques.push(technique);
835
- }
836
- for (const group of description.annotations ?? []) {
837
- const name = text(group.name);
838
- if (effectDescription.annotations.has(name)) {
839
- throw new CjsFormatReadError(`Duplicate effect parameter annotation group ${name}`, {
840
- name
841
- });
842
- }
843
- effectDescription.annotations.set(name, (group.annotations ?? []).map(mapAnnotationRecord));
844
- }
845
- applyHeapViewAnnotations(effectDescription);
846
- return effectDescription;
847
- }
848
-
849
- export { runtimeDescriptionFromCarbon };
850
- //# sourceMappingURL=carbonDescriptionToRuntime.js.map
1
+ import { CjsFormatReadError } from '../../../format/CjsFormatError.js';
2
+ import { HlslEffectConstant } from './tr2/shader/HlslEffectConstant.js';
3
+ import { HlslEffectLibrary } from './tr2/shader/HlslEffectLibrary.js';
4
+ import { HlslEffectParameterAnnotation } from './tr2/shader/HlslEffectParameterAnnotation.js';
5
+ import { HlslEffectResource } from './tr2/shader/HlslEffectResource.js';
6
+ import { HlslEffectStageInput } from './tr2/shader/HlslEffectStageInput.js';
7
+ import { HlslEffectStateManager } from './HlslEffectStateManager.js';
8
+ import { HlslEffectTechnique } from './tr2/shader/HlslEffectTechnique.js';
9
+ import { HlslPass } from './tr2/shader/HlslPass.js';
10
+ import { HlslShaderBytecode } from './HlslShaderBytecode.js';
11
+ import { HlslRenderContextEnum, HlslUsageCodeNames } from './tr2/HlslRenderContextEnum.js';
12
+ import { HlslRenderStateSetup } from './HlslRenderStateSetup.js';
13
+ import { HlslResourceSetDescription } from './HlslResourceSetDescription.js';
14
+ import { HlslSamplerDescription } from './tr2/shader/HlslSamplerDescription.js';
15
+ import { HlslSamplerSetup } from './tr2/shader/HlslSamplerSetup.js';
16
+
17
+ /**
18
+ * Rebuilds the runtime effect-description shape from a Carbon record tree.
19
+ *
20
+ * This is a **shape adapter and nothing else**. It adds no semantics: its whole
21
+ * job is to turn the parsed container records into the object graph
22
+ * `HlslEffectBindingManifest.fromEffectDescription` already consumes, so that
23
+ * `buildEffectAnalysis` runs unchanged on a container-derived description. The
24
+ * derived view stays the same function it has always been rather than a
25
+ * reimplementation free to drift from it.
26
+ *
27
+ * ## Why this is not a field copy
28
+ *
29
+ * The wire shape and the runtime shape are genuinely different shapes, and every
30
+ * difference is a place a copying adapter produces something that reads as
31
+ * plausible and is wrong:
32
+ *
33
+ * | wire | runtime | conversion |
34
+ * |---|---|---|
35
+ * | `name: {offset, value}` | `name: "NormalMap"` | unwrap the arena string reference |
36
+ * | `count` | `arrayElements` | **renamed** — see `mapTextureRecord` |
37
+ * | `isSRGB: 0` | `isSRGB: false` | integer to boolean |
38
+ * | flat sampler fields | `{name, sampler: {...}}` | **re-nested** — see `mapSamplerRecord` |
39
+ * | UAV has no `isSRGB` | `isSRGB: false` | **synthesised** — see `mapUavRecord` |
40
+ * | `registerIndex` field | map key | consumed as the key, not a payload field |
41
+ *
42
+ * Three of those are silent when wrong. `arrayElements` is read at
43
+ * `packageHelpers.js:869` and a rename yields `undefined` there. `isSRGB` as `0`
44
+ * is *accidentally correct* — `0` is falsy, `1` is truthy — so it survives every
45
+ * behavioural test and only a structural diff sees it. A flat sampler puts all
46
+ * fourteen descriptor fields at the wrong depth at once.
47
+ *
48
+ * ## The tables are closed
49
+ *
50
+ * Every record is built through `mapClosed`, which walks the **source** keys and
51
+ * throws on any key with no rule. Nothing is spread and nothing is copied
52
+ * wholesale. That converts "did we enumerate every field?" — a question whose
53
+ * wrong answer shows up months later as `undefined` in the engine — into an error
54
+ * the first time the adapter meets a record it does not fully understand.
55
+ *
56
+ * This is deliberately redundant with the two-sided diff in
57
+ * `test/formats/webgpu/carbon-analysis-adapter.test.mjs`, and neither replaces the
58
+ * other. The table catches *the wire has something we do not handle*; the diff
59
+ * catches *our output differs from the reference*. A complete table can still map
60
+ * a field wrongly, and a passing diff on one fixture says nothing about a key that
61
+ * fixture never exercises.
62
+ *
63
+ * ## What is derived rather than stored
64
+ *
65
+ * `m_shader`, `pass.shaderProgram` and `pass.renderStates` are registration
66
+ * handles from `HlslEffectStateManager`, which are monotonic counters and
67
+ * therefore reproduce exactly when registration happens in the same order. That
68
+ * is why stages are walked in **wire array order** rather than by ascending
69
+ * stage type: the source reader registers them in the order the file lists them.
70
+ * `resourceSetDesc` and its `heapViews` are likewise rebuilt by running the same
71
+ * derivation the source reader runs, not carried on the wire.
72
+ */
73
+
74
+ /** Carbon annotation type for a string-valued annotation. */
75
+ const ANNOTATION_TYPE_STRING = HlslEffectParameterAnnotation.Type.STRING;
76
+ const rawView = new DataView(new ArrayBuffer(4));
77
+
78
+ /**
79
+ * Unwraps an arena string reference to its text.
80
+ *
81
+ * @param {{offset:number, value:string}|null} reference Wire string reference.
82
+ * @returns {string} The referenced text.
83
+ */
84
+ function text(reference) {
85
+ return typeof reference?.value === "string" ? reference.value : "";
86
+ }
87
+
88
+ /**
89
+ * Converts a wire `u8` flag to the boolean the runtime shape carries.
90
+ *
91
+ * @param {number} value Wire flag.
92
+ * @returns {boolean} Boolean form.
93
+ */
94
+ function flag(value) {
95
+ return Boolean(value);
96
+ }
97
+
98
+ /**
99
+ * Reads four wire bytes as the little-endian `u32` the runtime annotation holds.
100
+ *
101
+ * @param {Uint8Array|null} bytes Four raw bytes.
102
+ * @returns {number} Unsigned 32-bit value.
103
+ */
104
+ function rawUint32(bytes) {
105
+ if (!bytes || bytes.length < 4) return 0;
106
+ rawView.setUint8(0, bytes[0]);
107
+ rawView.setUint8(1, bytes[1]);
108
+ rawView.setUint8(2, bytes[2]);
109
+ rawView.setUint8(3, bytes[3]);
110
+ return rawView.getUint32(0, true);
111
+ }
112
+
113
+ /**
114
+ * Reinterprets a `u32` bit pattern as the float it encodes.
115
+ *
116
+ * @param {number} bits Raw 32-bit pattern.
117
+ * @returns {number} The float those bits encode.
118
+ */
119
+ function floatFromBits(bits) {
120
+ rawView.setUint32(0, bits >>> 0, true);
121
+ return rawView.getFloat32(0, true);
122
+ }
123
+
124
+ /**
125
+ * Builds an object from a record by walking the record's own keys against a
126
+ * closed rule table, throwing on any key the table does not name.
127
+ *
128
+ * Walking the **source** keys is the point. A table walked from its own entries
129
+ * would silently ignore a field the wire gained, which is exactly the failure
130
+ * this exists to make loud.
131
+ *
132
+ * @param {object} record Source wire record.
133
+ * @param {object} rules Rule table keyed by source field name.
134
+ * @param {object} target Object to populate.
135
+ * @param {string} what Record kind, for the error message.
136
+ * @returns {object} The populated target.
137
+ */
138
+ function mapClosed(record, rules, target, what) {
139
+ for (const key of Object.keys(record)) {
140
+ const rule = rules[key];
141
+ if (!rule) {
142
+ throw new CjsFormatReadError(`Carbon ${what} record carries field "${key}" with no mapping rule`, {
143
+ record: what,
144
+ field: key
145
+ });
146
+ }
147
+ rule(target, record[key], record);
148
+ }
149
+ return target;
150
+ }
151
+
152
+ /** Consumes a field that is deliberately not part of the runtime payload. */
153
+ const consumed = () => {};
154
+
155
+ /** Texture record rules. `count` is Carbon's name for `arrayElements`. */
156
+ const TEXTURE_RULES = Object.freeze({
157
+ // Carried as the map key by the caller, not as a payload field.
158
+ registerIndex: consumed,
159
+ name: (target, value) => {
160
+ target.name = text(value);
161
+ },
162
+ type: (target, value) => {
163
+ target.type = value;
164
+ },
165
+ // RENAME: the wire calls this `count`; the runtime calls it `arrayElements`.
166
+ // Copying the field name yields `arrayElements: undefined`, read silently at
167
+ // `packageHelpers.js:869`.
168
+ count: (target, value) => {
169
+ target.arrayElements = value;
170
+ },
171
+ isSRGB: (target, value) => {
172
+ target.isSRGB = flag(value);
173
+ },
174
+ isAutoregister: (target, value) => {
175
+ target.isAutoregister = flag(value);
176
+ }
177
+ });
178
+
179
+ /** UAV record rules. A UAV record has no `isSRGB`; it is synthesised. */
180
+ const UAV_RULES = Object.freeze({
181
+ registerIndex: consumed,
182
+ name: (target, value) => {
183
+ target.name = text(value);
184
+ },
185
+ type: (target, value) => {
186
+ target.type = value;
187
+ },
188
+ // RENAME: same as the texture record.
189
+ count: (target, value) => {
190
+ target.arrayElements = value;
191
+ },
192
+ isAutoregister: (target, value) => {
193
+ target.isAutoregister = flag(value);
194
+ }
195
+ });
196
+
197
+ /** Sampler record rules. The wire record is flat; the runtime shape is nested. */
198
+ const SAMPLER_RULES = Object.freeze({
199
+ registerIndex: consumed,
200
+ // Handled after the walk: the name depends on `isDynamic`, which the walk
201
+ // may not have reached yet.
202
+ name: consumed,
203
+ isDynamic: (target, value) => {
204
+ target.sampler.isDynamic = flag(value);
205
+ },
206
+ comparison: (target, value) => {
207
+ target.sampler.comparison = flag(value);
208
+ },
209
+ minFilter: (target, value) => {
210
+ target.sampler.minFilter = value;
211
+ },
212
+ magFilter: (target, value) => {
213
+ target.sampler.magFilter = value;
214
+ },
215
+ mipFilter: (target, value) => {
216
+ target.sampler.mipFilter = value;
217
+ },
218
+ addressU: (target, value) => {
219
+ target.sampler.addressU = value;
220
+ },
221
+ addressV: (target, value) => {
222
+ target.sampler.addressV = value;
223
+ },
224
+ addressW: (target, value) => {
225
+ target.sampler.addressW = value;
226
+ },
227
+ mipLODBias: (target, value) => {
228
+ target.sampler.mipLODBias = value;
229
+ },
230
+ maxAnisotropy: (target, value) => {
231
+ target.sampler.maxAnisotropy = value;
232
+ },
233
+ comparisonFunc: (target, value) => {
234
+ target.sampler.comparisonFunc = value;
235
+ },
236
+ borderColor: (target, value) => {
237
+ target.sampler.borderColor = value.slice(0, 4);
238
+ },
239
+ minLOD: (target, value) => {
240
+ target.sampler.minLOD = value;
241
+ },
242
+ maxLOD: (target, value) => {
243
+ target.sampler.maxLOD = value;
244
+ }
245
+ });
246
+
247
+ /** Static sampler rules. `borderColor` is a one-byte enum here, not four floats. */
248
+ const STATIC_SAMPLER_RULES = Object.freeze({
249
+ registerIndex: (target, value) => {
250
+ target.registerIndex = value;
251
+ },
252
+ registerSpace: (target, value) => {
253
+ target.registerSpace = value;
254
+ },
255
+ comparison: (target, value) => {
256
+ target.sampler.comparison = flag(value);
257
+ },
258
+ minFilter: (target, value) => {
259
+ target.sampler.minFilter = value;
260
+ },
261
+ magFilter: (target, value) => {
262
+ target.sampler.magFilter = value;
263
+ },
264
+ mipFilter: (target, value) => {
265
+ target.sampler.mipFilter = value;
266
+ },
267
+ addressU: (target, value) => {
268
+ target.sampler.addressU = value;
269
+ },
270
+ addressV: (target, value) => {
271
+ target.sampler.addressV = value;
272
+ },
273
+ addressW: (target, value) => {
274
+ target.sampler.addressW = value;
275
+ },
276
+ mipLODBias: (target, value) => {
277
+ target.sampler.mipLODBias = value;
278
+ },
279
+ maxAnisotropy: (target, value) => {
280
+ target.sampler.maxAnisotropy = value;
281
+ },
282
+ comparisonFunc: (target, value) => {
283
+ target.sampler.comparisonFunc = value;
284
+ },
285
+ borderColor: (target, value) => {
286
+ target.sampler.borderColor = value;
287
+ },
288
+ minLOD: (target, value) => {
289
+ target.sampler.minLOD = value;
290
+ },
291
+ maxLOD: (target, value) => {
292
+ target.sampler.maxLOD = value;
293
+ }
294
+ });
295
+
296
+ /** Constant record rules. */
297
+ const CONSTANT_RULES = Object.freeze({
298
+ name: (target, value) => {
299
+ target.name = text(value);
300
+ },
301
+ offset: (target, value) => {
302
+ target.offset = value;
303
+ },
304
+ size: (target, value) => {
305
+ target.size = value;
306
+ },
307
+ type: (target, value) => {
308
+ target.type = value;
309
+ },
310
+ dimension: (target, value) => {
311
+ target.dimension = value;
312
+ },
313
+ elements: (target, value) => {
314
+ target.elements = value;
315
+ },
316
+ isSRGB: (target, value) => {
317
+ target.isSRGB = flag(value);
318
+ },
319
+ isAutoregister: (target, value) => {
320
+ target.isAutoregister = flag(value);
321
+ }
322
+ });
323
+
324
+ /** Register declaration rules. */
325
+ const REGISTER_RULES = Object.freeze({
326
+ registerType: (target, value) => {
327
+ target.registerType = value;
328
+ },
329
+ registerIndex: (target, value) => {
330
+ target.registerIndex = value;
331
+ },
332
+ // Carbon stores one field its reader calls `arrayCount` and its writer calls
333
+ // `registerCount`. The runtime shape carries both names, always equal — the
334
+ // producer refuses to write them when they disagree.
335
+ registerCount: (target, value) => {
336
+ target.registerCount = value;
337
+ target.arrayCount = value;
338
+ },
339
+ registerSpace: (target, value) => {
340
+ target.registerSpace = value;
341
+ }
342
+ });
343
+
344
+ /**
345
+ * Pipeline input rules.
346
+ *
347
+ * `usageName` is derived from the `usage` byte rather than carried: it is a
348
+ * display name looked up from a table, exactly as Carbon derives it through
349
+ * `GetStringForUsageCode` (`EffectData.h:86`). Nothing goes on the wire for it.
350
+ */
351
+ const PIPELINE_INPUT_RULES = Object.freeze({
352
+ usage: (target, value) => {
353
+ target.usage = value;
354
+ target.usageName = HlslUsageCodeNames[value] || `USAGE_${value}`;
355
+ },
356
+ registerIndex: (target, value) => {
357
+ target.registerIndex = value;
358
+ },
359
+ usageIndex: (target, value) => {
360
+ target.usageIndex = value;
361
+ },
362
+ usedMask: (target, value) => {
363
+ target.usedMask = value;
364
+ },
365
+ type: (target, value) => {
366
+ target.type = value;
367
+ },
368
+ dimension: (target, value) => {
369
+ target.dimension = value;
370
+ }
371
+ });
372
+
373
+ /** Annotation rules. */
374
+ const ANNOTATION_RULES = Object.freeze({
375
+ name: (target, value) => {
376
+ target.name = text(value);
377
+ },
378
+ type: (target, value) => {
379
+ target.type = value;
380
+ },
381
+ stringValue: (target, value) => {
382
+ if (value) target.stringValue = text(value);
383
+ },
384
+ // A non-string annotation value is four raw bytes: Carbon writes it through a
385
+ // float union and reads it through a different one, so the bytes are the only
386
+ // faithful form. The three typed views are derived from those bytes, one per
387
+ // union member Carbon reads back through.
388
+ rawValue: (target, value, record) => {
389
+ if (record.type === ANNOTATION_TYPE_STRING) return;
390
+ const bits = rawUint32(value);
391
+ target.rawValue = bits;
392
+ target.boolValue = bits !== 0;
393
+ target.intValue = bits | 0;
394
+ target.floatValue = floatFromBits(bits);
395
+ }
396
+ });
397
+
398
+ /**
399
+ * Maps one texture record onto its runtime resource object.
400
+ *
401
+ * @param {object} record Wire texture record.
402
+ * @returns {HlslEffectResource} Runtime resource.
403
+ */
404
+ function mapTextureRecord(record) {
405
+ return mapClosed(record, TEXTURE_RULES, new HlslEffectResource(), "texture");
406
+ }
407
+
408
+ /**
409
+ * Maps one UAV record onto its runtime resource object.
410
+ *
411
+ * A UAV record is one byte shorter than a texture record: it carries no
412
+ * `isSRGB`. Carbon's reader hardcodes it false (`Tr2EffectDescription.cpp:450`),
413
+ * so the runtime object's
414
+ * constructor default is restored explicitly rather than left to chance —
415
+ * `metadata.toJSON()` emits the key for a UAV even though the wire never carries
416
+ * it, because both kinds share `HlslEffectResource`.
417
+ *
418
+ * @param {object} record Wire UAV record.
419
+ * @returns {HlslEffectResource} Runtime resource.
420
+ */
421
+ function mapUavRecord(record) {
422
+ const resource = mapClosed(record, UAV_RULES, new HlslEffectResource(), "uav");
423
+ resource.isSRGB = false;
424
+ return resource;
425
+ }
426
+
427
+ /**
428
+ * Maps one sampler record onto its runtime sampler setup.
429
+ *
430
+ * Two conversions beyond the flat-to-nested reshape:
431
+ *
432
+ * - Carbon nulls a sampler's name when it is not dynamic
433
+ * (`Tr2EffectDescription.cpp:430-433`), so the wire's empty string must become
434
+ * `null` again. A pre-v13 record carries no `isDynamic` at all; the class
435
+ * default (dynamic) then keeps the name, matching the legacy reader, which
436
+ * never assigned the flag for those versions. Like `isSRGB`, the nulling is
437
+ * *accidentally correct* if left alone —
438
+ * `""` and `null` are both falsy, so `metadataName` and the heap-view lookup
439
+ * behave identically — and only a structural diff catches it.
440
+ * - `comparison` and `isDynamic` are `u8` on the wire and boolean at runtime.
441
+ *
442
+ * @param {object} record Wire sampler record.
443
+ * @returns {HlslSamplerSetup} Runtime sampler setup.
444
+ */
445
+ function mapSamplerRecord(record) {
446
+ const setup = new HlslSamplerSetup();
447
+ setup.sampler = new HlslSamplerDescription();
448
+ mapClosed(record, SAMPLER_RULES, setup, "sampler");
449
+ setup.name = setup.sampler.isDynamic ? text(record.name) : null;
450
+ return setup;
451
+ }
452
+
453
+ /**
454
+ * Maps one static sampler record onto its runtime signature entry.
455
+ *
456
+ * The runtime shape keeps the `*Raw` companions non-enumerable, so a
457
+ * `cloneJson` of the descriptor sees the value form only.
458
+ *
459
+ * @param {object} record Wire static sampler record.
460
+ * @returns {object} Runtime static sampler entry.
461
+ */
462
+ function mapStaticSamplerRecord(record) {
463
+ const entry = {
464
+ registerIndex: 0,
465
+ registerSpace: 0,
466
+ sampler: {
467
+ comparison: false,
468
+ minFilter: 0,
469
+ magFilter: 0,
470
+ mipFilter: 0,
471
+ addressU: 0,
472
+ addressV: 0,
473
+ addressW: 0,
474
+ mipLODBias: 0,
475
+ maxAnisotropy: 0,
476
+ comparisonFunc: 0,
477
+ borderColor: 0,
478
+ minLOD: 0,
479
+ maxLOD: 0
480
+ }
481
+ };
482
+ mapClosed(record, STATIC_SAMPLER_RULES, entry, "static sampler");
483
+ Object.defineProperties(entry.sampler, {
484
+ mipLODBiasRaw: {
485
+ value: 0,
486
+ writable: true
487
+ },
488
+ minLODRaw: {
489
+ value: 0,
490
+ writable: true
491
+ },
492
+ maxLODRaw: {
493
+ value: 0,
494
+ writable: true
495
+ }
496
+ });
497
+ return entry;
498
+ }
499
+
500
+ /**
501
+ * Maps one constant record onto its runtime constant object.
502
+ *
503
+ * @param {object} record Wire constant record.
504
+ * @returns {HlslEffectConstant} Runtime constant.
505
+ */
506
+ function mapConstantRecord(record) {
507
+ return mapClosed(record, CONSTANT_RULES, new HlslEffectConstant(), "constant");
508
+ }
509
+
510
+ /**
511
+ * Maps one annotation record onto its runtime annotation object.
512
+ *
513
+ * @param {object} record Wire annotation record.
514
+ * @returns {HlslEffectParameterAnnotation} Runtime annotation.
515
+ */
516
+ function mapAnnotationRecord(record) {
517
+ return mapClosed(record, ANNOTATION_RULES, new HlslEffectParameterAnnotation(), "annotation");
518
+ }
519
+
520
+ /**
521
+ * Restores the `dynamic` flag the source reader derives per register.
522
+ *
523
+ * Reproduced rather than stored: it is a function of the register type, the
524
+ * stage type and the caller's per-frame start registers, none of which the
525
+ * container needs to carry.
526
+ *
527
+ * @param {object} register Runtime register declaration.
528
+ * @param {number} stageType Stage enum value.
529
+ * @param {object} context Adapter context carrying the per-frame registers.
530
+ * @returns {boolean} True when the register is dynamic.
531
+ */
532
+ function isRegisterDynamic(register, stageType, context) {
533
+ if (register.registerType !== 0) return true;
534
+ if (stageType === HlslRenderContextEnum.VERTEX_SHADER && register.registerIndex === context.perFrameVSStartRegister) return false;
535
+ if (stageType === HlslRenderContextEnum.PIXEL_SHADER && register.registerIndex === context.perFramePSStartRegister) return false;
536
+ return true;
537
+ }
538
+
539
+ /**
540
+ * Populates one runtime stage input from a wire `StageData` block.
541
+ *
542
+ * @param {HlslEffectStageInput} input Destination stage input.
543
+ * @param {object} data Wire stage data.
544
+ * @param {number} stageType Stage enum value.
545
+ * @param {object} context Adapter context.
546
+ */
547
+ function applyStageData(input, data, stageType, context) {
548
+ input.signature.registers = (data.registers ?? []).map(record => {
549
+ const register = mapClosed(record, REGISTER_RULES, {}, "register");
550
+ register.dynamic = isRegisterDynamic(register, stageType, context);
551
+ return register;
552
+ });
553
+ input.signature.samplers = (data.staticSamplers ?? []).map(mapStaticSamplerRecord);
554
+ input.constants = (data.constants ?? []).map(mapConstantRecord);
555
+
556
+ // The declared size is the unclamped one; the runtime clamps it to
557
+ // SHADER_CONSTANTS_MAX and slices the payload to match, as Carbon does
558
+ // (`Tr2EffectDescription.h:160`). `packMaterial` allocates an
559
+ // ArrayBuffer of exactly this size, so restoring the unclamped value would
560
+ // write past the layout the shader expects — on any effect above 4096 bytes
561
+ // of constants, which is precisely the size a small fixture never reaches.
562
+ const declaredSize = data.defaultValues?.size ?? 0;
563
+ input.sourceConstantValueSize = declaredSize;
564
+ input.sourceConstantValues = Uint8Array.from(data.defaultValues?.bytes ?? new Uint8Array(0));
565
+ input.m_constantValueSize = Math.min(declaredSize, HlslEffectStageInput.SHADER_CONSTANTS_MAX);
566
+ input.constantValues = input.sourceConstantValues.slice(0, input.m_constantValueSize);
567
+ input.resources = new Map((data.textures ?? []).map(record => [record.registerIndex, mapTextureRecord(record)]));
568
+ input.samplers = new Map((data.samplers ?? []).map(record => [record.registerIndex, mapSamplerRecord(record)]));
569
+ input.uavs = new Map((data.uavs ?? []).map(record => [record.registerIndex, mapUavRecord(record)]));
570
+ input.annotation = (data.annotations ?? []).map(mapAnnotationRecord);
571
+
572
+ // Runs last, because it needs the sampler map. See the function's own note
573
+ // for why it exists.
574
+ for (const constant of input.constants) patchSamplerHeapIndexConstant(input, constant);
575
+ }
576
+
577
+ /**
578
+ * Grows the constant block to cover a sampler heap-index constant.
579
+ *
580
+ * Applied to every constant once samplers are known, as Carbon's reader does:
581
+ * a `UINT`/dimension-1 constant whose name matches a sampler is a heap index,
582
+ * and the declared constant-value size can be smaller than the offset it sits
583
+ * at. The block is extended rather than read out of bounds.
584
+ *
585
+ * **This is derived, not stored, and missing it is not cosmetic.** `packMaterial`
586
+ * allocates `new ArrayBuffer(constantValueSize)`, so an unpatched size
587
+ * under-allocates and the write runs past the end of the buffer the shader
588
+ * expects. It appears only on dx12 -- the whole dx11 corpus is unaffected --
589
+ * which is exactly why the analysis diff had to cover dx12 before this was
590
+ * trustworthy. On `quaddetailv5.sm_depth` the declared 608 becomes 620.
591
+ *
592
+ * @param {object} input Runtime stage input, with samplers already populated.
593
+ * @param {object} constant Runtime constant record.
594
+ */
595
+ function patchSamplerHeapIndexConstant(input, constant) {
596
+ if (constant.type !== HlslEffectConstant.Type.UINT || constant.dimension !== 1) return;
597
+ for (const sampler of input.samplers.values()) {
598
+ if (sampler.name !== constant.name) continue;
599
+ const neededSize = constant.offset + constant.size;
600
+ if (neededSize > input.m_constantValueSize) {
601
+ const next = new Uint8Array(neededSize);
602
+ next.set(input.constantValues);
603
+ input.constantValues = next;
604
+ input.m_constantValueSize = neededSize;
605
+ }
606
+ break;
607
+ }
608
+ }
609
+
610
+ /**
611
+ * Rebuilds one runtime pass from a wire pass record.
612
+ *
613
+ * @param {object} record Wire pass record.
614
+ * @param {object} context Adapter context.
615
+ * @returns {HlslPass} Runtime pass.
616
+ */
617
+ function buildPass(record, context) {
618
+ const pass = new HlslPass();
619
+ const shaderTypes = [];
620
+ const signatures = [];
621
+ const shaderHandles = [];
622
+
623
+ // Wire array order, not ascending stage type. The source reader registers
624
+ // shaders in the order the file lists its stages, and the state manager's
625
+ // handles are monotonic counters, so any other order reproduces the shape
626
+ // with the handles permuted.
627
+ for (const stage of record.stages ?? []) {
628
+ const stageType = stage.type;
629
+ const input = pass.stageInputs[stageType];
630
+ if (!input) {
631
+ throw new CjsFormatReadError(`Carbon stage record declares stage type ${stageType}, outside the runtime stage range`, {
632
+ stageType
633
+ });
634
+ }
635
+ if (input.m_exists) {
636
+ throw new CjsFormatReadError(`Carbon pass declares stage type ${stageType} twice; the later stage would clobber the earlier`, {
637
+ stageType
638
+ });
639
+ }
640
+ input.m_exists = true;
641
+ input.signature.threadGroupSize = {
642
+ x: stage.threadGroupSize[0],
643
+ y: stage.threadGroupSize[1],
644
+ z: stage.threadGroupSize[2]
645
+ };
646
+ input.signature.pipelineInputs = (stage.pipelineInputs ?? []).map(entry => mapClosed(entry, PIPELINE_INPUT_RULES, {}, "pipeline input"));
647
+ applyStageData(input, stage, stageType, context);
648
+ input.cjsShaderBytecode = context.bytecodeFor ? context.bytecodeFor(stage, stageType, pass) : null;
649
+ input.m_shader = context.effectStateManager.RegisterShader(stageType, input.cjsShaderBytecode, input.signature, context.effectName);
650
+ shaderHandles.push(input.m_shader);
651
+ shaderTypes.push(stageType);
652
+ signatures.push(input.signature);
653
+ pass.shaderTypeMask |= 1 << stageType;
654
+ }
655
+ pass.resourceSetDesc = new HlslResourceSetDescription(shaderTypes, signatures);
656
+ for (let stageType = 0; stageType < HlslRenderContextEnum.SHADER_TYPE_COUNT; stageType += 1) {
657
+ const input = pass.stageInputs[stageType];
658
+ if (!input?.m_exists) continue;
659
+ for (const [registerIndex, sampler] of input.samplers.entries()) {
660
+ pass.resourceSetDesc.SetSampler(stageType, registerIndex, sampler.sampler);
661
+ }
662
+ }
663
+ pass.shaderProgram = context.effectStateManager.RegisterShaderProgram(shaderHandles, shaderHandles.length);
664
+ const states = new Map();
665
+ for (const entry of record.renderStates ?? []) {
666
+ if (states.has(entry.state)) {
667
+ throw new CjsFormatReadError(`Carbon pass declares render state ${entry.state} twice`, {
668
+ state: entry.state
669
+ });
670
+ }
671
+ states.set(entry.state, entry.value);
672
+ }
673
+ pass.cjsRenderStateSetup = new HlslRenderStateSetup(states);
674
+ pass.renderStates = context.effectStateManager.RegisterRenderStateSetup(pass.cjsRenderStateSetup);
675
+ return pass;
676
+ }
677
+
678
+ /** Names an export slot per Carbon's raytracing export type codes. */
679
+ const LIBRARY_EXPORT_NAME_FIELDS = Object.freeze(["rayGenName", "missName", "closestHitName", "anyHitName", "intersectionName"]);
680
+
681
+ /** Library record rules; the nested pieces are handled by `buildLibrary`. */
682
+ const LIBRARY_RULES = Object.freeze({
683
+ payloadSize: (target, value) => {
684
+ target.payloadSize = value;
685
+ },
686
+ hitGroupName: (target, value) => {
687
+ target.hitGroupName = text(value);
688
+ },
689
+ // Consumed by buildLibrary: the blob becomes the registered bytecode.
690
+ shaderData: consumed,
691
+ // Consumed by buildLibrary: exports carry per-type name routing.
692
+ exports: consumed,
693
+ globalInputs: consumed,
694
+ localInputs: consumed
695
+ });
696
+
697
+ /**
698
+ * Rebuilds one runtime shader library from a wire library record.
699
+ *
700
+ * The two stage-data blocks reuse `applyStageData`, so a library's constants,
701
+ * defaults, resources, samplers and UAVs go through exactly the rules a pass
702
+ * stage goes through. The library bytecode is registered the way the runtime
703
+ * registers it: a compute-typed `HlslShaderBytecode` under the state manager's
704
+ * library registry, whose handles are a separate monotonic counter — adding
705
+ * libraries does not shift any shader or program handle.
706
+ *
707
+ * @param {object} record Wire library record.
708
+ * @param {object} context Adapter context.
709
+ * @returns {HlslEffectLibrary} Runtime library.
710
+ */
711
+ function buildLibrary(record, context) {
712
+ const library = mapClosed(record, LIBRARY_RULES, new HlslEffectLibrary(), "library");
713
+ const shaderType = HlslRenderContextEnum.COMPUTE_SHADER;
714
+ library.cjsShaderBytecode = new HlslShaderBytecode({
715
+ stageType: shaderType,
716
+ stageName: "library",
717
+ bytes: record.shaderData?.bytes ?? new Uint8Array(0),
718
+ shaderSize: record.shaderData?.size ?? 0,
719
+ stringTableOffset: record.shaderData?.offset ?? null
720
+ });
721
+ library.libraryHandle = context.effectStateManager.RegisterShaderLibrary(library.cjsShaderBytecode);
722
+ for (const entry of record.exports ?? []) {
723
+ const name = text(entry.name);
724
+ library.exports.push({
725
+ type: entry.type,
726
+ name
727
+ });
728
+ const field = LIBRARY_EXPORT_NAME_FIELDS[entry.type];
729
+ if (field) library[field] = name;
730
+ }
731
+ applyStageData(library.globalInput, record.globalInputs ?? {}, shaderType, context);
732
+ library.globalResourceSetDesc = new HlslResourceSetDescription([shaderType], [library.globalInput.signature]);
733
+ for (const [registerIndex, sampler] of library.globalInput.samplers.entries()) {
734
+ library.globalResourceSetDesc.SetSampler(shaderType, registerIndex, sampler.sampler);
735
+ }
736
+ applyStageData(library.localInput, record.localInputs ?? {}, shaderType, context);
737
+ return library;
738
+ }
739
+
740
+ /**
741
+ * Applies the `IsHeapView` annotations to the rebuilt resource-set descriptions.
742
+ *
743
+ * Derived rather than carried, over the annotations the container holds,
744
+ * exactly as Carbon derives it after reading
745
+ * (`Tr2EffectDescription.cpp:474-530`): a parameter whose top-level
746
+ * annotations contain a true BOOL `IsHeapView` marks its register as a heap
747
+ * view in the owning resource-set description, for library global inputs as
748
+ * well as pass stages.
749
+ *
750
+ * @param {object} effectDescription Rebuilt effect description.
751
+ */
752
+ function applyHeapViewAnnotations(effectDescription) {
753
+ const isHeapView = name => {
754
+ if (!name) return false;
755
+ const annotations = effectDescription.annotations.get(name) || [];
756
+ return annotations.some(annotation => annotation.name === "IsHeapView" && annotation.type === HlslEffectParameterAnnotation.Type.BOOL && annotation.boolValue);
757
+ };
758
+ for (const technique of effectDescription.techniques) {
759
+ for (const library of technique.libraries ?? []) {
760
+ const shaderType = HlslRenderContextEnum.COMPUTE_SHADER;
761
+ for (const [registerIndex, resource] of library.globalInput.resources.entries()) {
762
+ if (isHeapView(resource.name)) library.globalResourceSetDesc?.SetSrvHeapView(shaderType, registerIndex);
763
+ }
764
+ for (const [registerIndex, resource] of library.globalInput.uavs.entries()) {
765
+ if (isHeapView(resource.name)) library.globalResourceSetDesc?.SetUavHeapView(shaderType, registerIndex);
766
+ }
767
+ for (const [registerIndex, sampler] of library.globalInput.samplers.entries()) {
768
+ if (isHeapView(sampler.name)) library.globalResourceSetDesc?.SetSamplerHeapView(shaderType, registerIndex);
769
+ }
770
+ }
771
+ for (const pass of technique.passes) {
772
+ for (let stageType = 0; stageType < pass.stageInputs.length; stageType += 1) {
773
+ const stage = pass.stageInputs[stageType];
774
+ if (!stage?.m_exists) continue;
775
+ for (const [registerIndex, resource] of stage.resources.entries()) {
776
+ if (isHeapView(resource.name)) pass.resourceSetDesc?.SetSrvHeapView(stageType, registerIndex);
777
+ }
778
+ for (const [registerIndex, resource] of stage.uavs.entries()) {
779
+ if (isHeapView(resource.name)) pass.resourceSetDesc?.SetUavHeapView(stageType, registerIndex);
780
+ }
781
+ for (const [registerIndex, sampler] of stage.samplers.entries()) {
782
+ if (isHeapView(sampler.name)) pass.resourceSetDesc?.SetSamplerHeapView(stageType, registerIndex);
783
+ }
784
+ }
785
+ }
786
+ }
787
+ }
788
+
789
+ /**
790
+ * Rebuilds the runtime effect-description shape from a Carbon record tree.
791
+ *
792
+ * @param {object} description Parsed Carbon description record tree.
793
+ * @param {object} [options] Adapter options.
794
+ * @param {string} [options.effectName] Effect name or source path.
795
+ * @param {number} [options.version] Carbon effect-data version.
796
+ * @param {number} [options.perFrameVSStartRegister] Per-frame vertex start register.
797
+ * @param {number} [options.perFramePSStartRegister] Per-frame pixel start register.
798
+ * @param {Function} [options.bytecodeFor] Supplies `cjsShaderBytecode` per stage.
799
+ * @param {HlslEffectStateManager} [options.effectStateManager] Registry override.
800
+ * @returns {object} Runtime-shaped effect description.
801
+ */
802
+ function runtimeDescriptionFromCarbon(description, options = {}) {
803
+ if (!description?.techniques) {
804
+ throw new CjsFormatReadError("Carbon description has no techniques", {});
805
+ }
806
+ const context = {
807
+ effectName: options.effectName ?? "",
808
+ effectStateManager: options.effectStateManager ?? new HlslEffectStateManager(),
809
+ bytecodeFor: options.bytecodeFor ?? null,
810
+ perFrameVSStartRegister: Number.isInteger(options.perFrameVSStartRegister) ? options.perFrameVSStartRegister : null,
811
+ perFramePSStartRegister: Number.isInteger(options.perFramePSStartRegister) ? options.perFramePSStartRegister : null
812
+ };
813
+ const effectDescription = {
814
+ effectName: context.effectName,
815
+ version: options.version ?? 15,
816
+ techniques: [],
817
+ annotations: new Map(),
818
+ effectStateManager: context.effectStateManager
819
+ };
820
+ for (const record of description.techniques) {
821
+ const technique = new HlslEffectTechnique();
822
+ technique.name = text(record.name);
823
+ technique.passes = (record.passes ?? []).map(pass => buildPass(pass, context));
824
+ for (const pass of technique.passes) technique.shaderTypeMask |= pass.shaderTypeMask;
825
+ // Raytracing libraries were once deliberately dropped here, when this
826
+ // adapter served only `buildEffectAnalysis` — which reaches libraries
827
+ // through no path, a claim the dx12 corpus diff measured (every body
828
+ // of `unpacked_quadv5.sm_hi` carries an `RtShadow` library, and the
829
+ // diff stayed green). Since the runtime read path converged on this
830
+ // adapter, that scope no longer holds: `metadata.js` and `json.js`
831
+ // emit `technique.libraries`, and the effect-resource contract
832
+ // requires every library's exports, inputs and payload preserved.
833
+ technique.libraries = (record.libraries ?? []).map(library => buildLibrary(library, context));
834
+ effectDescription.techniques.push(technique);
835
+ }
836
+ for (const group of description.annotations ?? []) {
837
+ const name = text(group.name);
838
+ if (effectDescription.annotations.has(name)) {
839
+ throw new CjsFormatReadError(`Duplicate effect parameter annotation group ${name}`, {
840
+ name
841
+ });
842
+ }
843
+ effectDescription.annotations.set(name, (group.annotations ?? []).map(mapAnnotationRecord));
844
+ }
845
+ applyHeapViewAnnotations(effectDescription);
846
+ return effectDescription;
847
+ }
848
+
849
+ export { runtimeDescriptionFromCarbon };
850
+ //# sourceMappingURL=carbonDescriptionToRuntime.js.map