@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,900 +1,900 @@
1
- import { CjsHlslFormat } from '../../hlsl/CjsHlslFormat.js';
2
- import { HlslRenderContextEnum, hlslShaderStageName } from '../../hlsl/core/tr2/HlslRenderContextEnum.js';
3
- import '@carbonenginejs/runtime-utils/bytes';
4
- import '../../hlsl/core/carbonDescriptionToRuntime.js';
5
- import '../../../format/CjsByteReader.js';
6
- import '../../../format/compareUtf8.js';
7
- import { HlslEffectBindingManifest } from '../../hlsl/core/tr2/shader/HlslEffectBindingManifest.js';
8
- import { buildEffectPermutationGraph, EFFECT_PERMUTATION_GRAPH_VERSION, EFFECT_PERMUTATION_GRAPH_FORMAT, EFFECT_PERMUTATION_GRAPH_CHUNK } from '../../../format/effect/effectPermutationGraph.js';
9
- import { emitGlslWithOptions } from './helpers.js';
10
- import { inspectGlslEffectContainer } from './inspectGlslEffectContainer.js';
11
- import { inspectRasterCompleteness } from './glslEffectCompleteness.js';
12
- import { recogniseDetailMapFamily } from '../../hlsl/core/detailMapFamily.js';
13
- import { stripLocalLightBindings, recogniseLocalLightFamily } from '../../hlsl/core/localLightFamily.js';
14
- import { buildGlslBackendBodySet } from './glslBackendBodySet.js';
15
- import { buildGlslEffectContainer } from './buildGlslEffectContainer.js';
16
- import { sha256Utf8, sha256Bytes } from '../../../format/effect/sha256.js';
17
-
18
- /**
19
- * INFO record version for the in-memory build result.
20
- *
21
- * This lived in effectPackageValidation.js, which validated a written chunk
22
- * package by reading it back. There is no chunk package to read back, so that
23
- * file is gone and its one surviving constant lives with its only user.
24
- */
25
- const EFFECT_INFO_VERSION = 3;
26
- const PACKAGE_VERSION = "0.11.1";
27
-
28
- /**
29
- * Builds a complete Carbon WebGL package from compiled Tr2 effect bytes.
30
- *
31
- * This browser-safe path owns whole-effect selection, stage translation,
32
- * package assembly, and structural qualification. Filesystem and native-tool
33
- * concerns remain in Node callers.
34
- *
35
- * @param {Uint8Array|ArrayBuffer|ArrayBufferView} input Compiled effect bytes.
36
- * @param {object} [options] Selection, provenance, and emitter policy.
37
- * @returns {object} Package bytes plus inspection and qualification records.
38
- */
39
- function buildEffectPackage(input, options = {}) {
40
- const values = normalizeOptions(input, options);
41
- const effectRes = CjsHlslFormat.read(values.sourceBytes, {
42
- emit: CjsHlslFormat.OUTPUT_RAW,
43
- source: values.source
44
- });
45
- if (!effectRes.IsGood()) {
46
- throw effectRes.loadError || new Error("Tr2EffectRes failed to load input");
47
- }
48
- const sourceIdentity = normalizeSourceIdentity(values);
49
- // One INFO version means one contract, and that contract requires complete
50
- // source reflection, which only version-15 input can supply.
51
- if (effectRes.m_version !== 15) {
52
- throw new Error("Effect package requires a version-15 compiled effect, got version " + (effectRes.m_version ?? "unknown"));
53
- }
54
- const permutationGraph = buildEffectPermutationGraph(effectRes);
55
- const variants = buildExportVariants(effectRes, values.allPermutations);
56
- const bodyMap = new Map();
57
- const stageMap = new Map();
58
- const shaderMap = new Map();
59
- for (const variant of variants) {
60
- if (bodyMap.has(variant.bodyKey)) {
61
- continue;
62
- }
63
- const shader = effectRes.GetShader(toShaderOptions(variant.options));
64
- if (!shader) {
65
- bodyMap.set(variant.bodyKey, {
66
- key: variant.bodyKey,
67
- bodyOffset: variant.bodyOffset,
68
- bodySize: variant.bodySize,
69
- firstVariantKey: variant.key,
70
- error: "Tr2EffectRes.GetShader returned null",
71
- manifest: null,
72
- stages: []
73
- });
74
- continue;
75
- }
76
- const effectDescription = shader.GetEffectDescription();
77
- const manifest = HlslEffectBindingManifest.fromEffectDescription(effectDescription);
78
- const collection = collectStages(effectDescription, values.selection);
79
- const body = {
80
- key: variant.bodyKey,
81
- bodyOffset: variant.bodyOffset,
82
- bodySize: variant.bodySize,
83
- firstVariantKey: variant.key,
84
- error: collection.errors.length ? collection.errors.join("; ") : null,
85
- // Dropping the light family removes its declarations from the
86
- // shader, so the manifest must stop advertising them too.
87
- manifest: values.localLights === "drop" ? stripLocalLightBindings(manifest.toJSON()) : manifest.toJSON(),
88
- stages: []
89
- };
90
- for (const stage of collection.stages) {
91
- const stageKey = `${variant.bodyKey}.${stage.key}`;
92
- const shaderKey = `shader_${stageKey}`;
93
- const contract = buildStageContract(stage);
94
- const stageRecord = {
95
- key: stageKey,
96
- bodyKey: variant.bodyKey,
97
- localKey: stage.key,
98
- techniqueName: stage.techniqueName,
99
- passIndex: stage.passIndex,
100
- stageType: stage.stageType,
101
- stageName: stage.stageName,
102
- shaderHandle: stage.shaderHandle,
103
- shaderSize: stage.bytecode.shaderSize,
104
- stringTableOffset: stage.bytecode.stringTableOffset,
105
- shaderKey,
106
- contract
107
- };
108
- stageMap.set(stageKey, stageRecord);
109
- body.stages.push(stageKey);
110
- shaderMap.set(shaderKey, {
111
- key: shaderKey,
112
- firstStageKey: stageKey,
113
- firstBodyKey: variant.bodyKey,
114
- stageName: stage.stageName,
115
- shaderSize: stage.bytecode.shaderSize,
116
- stringTableOffset: stage.bytecode.stringTableOffset,
117
- bytes: stage.bytecode.bytes,
118
- detailMapArray: stage.detailMapArray,
119
- localLights: stage.localLights,
120
- contracts: [{
121
- stageKey,
122
- techniqueName: stage.techniqueName,
123
- passIndex: stage.passIndex,
124
- stageName: stage.stageName,
125
- contract
126
- }]
127
- });
128
- }
129
- bodyMap.set(variant.bodyKey, body);
130
- }
131
- translateStages(shaderMap, stageMap, values);
132
- const bodies = Array.from(bodyMap.values());
133
- const stages = Array.from(stageMap.values());
134
- const translatedShaders = Array.from(shaderMap.values()).map(record => {
135
- const {
136
- bytes,
137
- emit,
138
- ...output
139
- } = record;
140
- output.primaryContract = mergeShaderContracts(output.contracts);
141
- return output;
142
- });
143
- const failedShaders = translatedShaders.filter(record => !record.hlsl2webgl?.ok && !record.excluded);
144
- const excludedShaders = translatedShaders.filter(record => record.excluded);
145
- const failedBodies = bodies.filter(body => body.error);
146
- // The same rule the validator applies to a finished file. This function used
147
- // to carry its own copy, and the two had already drifted: the local one had
148
- // dropped `hlsl2webgl.reason` from its reason chain, so the library and the
149
- // validator could describe one incomplete pass two different ways. If two
150
- // places must agree, one of them calls the other.
151
- const rasterCompleteness = inspectRasterCompleteness(stages, translatedShaders);
152
- const availableShaderCount = translatedShaders.filter(record => record.hlsl2webgl?.ok && record.source).length;
153
- const info = {
154
- format: "CARBON_WEBGL",
155
- formatVersion: EFFECT_INFO_VERSION,
156
- packageKind: values.allPermutations ? "tr2-effect-webgl-permutations" : "tr2-effect-webgl",
157
- targetBackend: "webgl",
158
- backendPackage: "@carbonenginejs/runtime-resource/formats/webgl",
159
- backendPackageVersion: PACKAGE_VERSION,
160
- generatedAt: values.generatedAt,
161
- sourcePath: values.source,
162
- outputPath: values.outputPath,
163
- sourceByteLength: sourceIdentity.byteLength,
164
- sourceMd5: sourceIdentity.md5,
165
- sourceSha256: sourceIdentity.sha256,
166
- sourceIdentity,
167
- translator: "dxbc-js-emitter",
168
- translatorVersion: PACKAGE_VERSION,
169
- language: "es300",
170
- flags: null,
171
- selection: values.selection,
172
- permutationMode: values.allPermutations ? "all" : "selected",
173
- defaultPermutationIndex: defaultPermutationIndex(effectRes.m_permutations),
174
- sourceEffectVersion: effectRes.m_version,
175
- sourceBodyCoverage: "all-unique",
176
- backendBodyCoverage: values.allPermutations ? "all" : "selected",
177
- backendProgramCoverage: selectionCoversWholeEffect(values.selection) ? "all-stages" : "filtered",
178
- permutationCount: variants.length,
179
- uniqueBodyCount: bodies.length,
180
- sourcePermutationCount: permutationGraph.variants.length,
181
- sourceUniqueBodyCount: permutationGraph.bodies.length,
182
- permutationGraph: {
183
- chunk: EFFECT_PERMUTATION_GRAPH_CHUNK,
184
- format: EFFECT_PERMUTATION_GRAPH_FORMAT,
185
- formatVersion: EFFECT_PERMUTATION_GRAPH_VERSION,
186
- sha256: sha256Utf8(`${JSON.stringify(permutationGraph)}\n`),
187
- permutationCount: permutationGraph.variants.length,
188
- uniqueBodyCount: permutationGraph.bodies.length
189
- },
190
- bodyStageCount: stages.length,
191
- uniqueShaderCount: translatedShaders.length,
192
- translatedShaderCount: translatedShaders.length - failedShaders.length - excludedShaders.length,
193
- excludedShaderCount: excludedShaders.length,
194
- failedShaderCount: failedShaders.length,
195
- failedBodyCount: failedBodies.length,
196
- expectedRasterPassCount: rasterCompleteness.expectedPassCount,
197
- completeRasterPassCount: rasterCompleteness.completePassCount,
198
- incompleteRasterPassCount: rasterCompleteness.incompletePasses.length,
199
- availableShaderCount,
200
- allowFailures: values.allowFailures,
201
- completeness: {
202
- packageValid: true,
203
- sourceComplete: effectRes.m_version === 15,
204
- backendComplete: false,
205
- runtimeComplete: false
206
- }
207
- };
208
- const metadata = {
209
- generatedAt: values.generatedAt,
210
- sourcePath: values.source,
211
- effectResource: effectRes.toJSON(),
212
- permutations: effectRes.GetPermutationDescription(),
213
- variants,
214
- bodies: bodies.map(body => ({
215
- key: body.key,
216
- bodyOffset: body.bodyOffset,
217
- bodySize: body.bodySize,
218
- firstVariantKey: body.firstVariantKey,
219
- error: body.error,
220
- manifest: body.manifest
221
- }))
222
- };
223
- const glsl = {
224
- format: "CARBON_WEBGL_GLSL_SET",
225
- formatVersion: 1,
226
- language: "es300",
227
- permutationMode: info.permutationMode,
228
- selection: values.selection,
229
- variants: variants.map(variant => ({
230
- key: variant.key,
231
- permutationIndex: variant.permutationIndex,
232
- bodyKey: variant.bodyKey
233
- })),
234
- bodies: bodies.map(body => ({
235
- key: body.key,
236
- error: body.error,
237
- stages: body.stages
238
- })),
239
- stages,
240
- shaders: translatedShaders
241
- };
242
- const qualification = qualifyEffectPackage({
243
- info,
244
- metadata,
245
- glsl,
246
- failedShaders,
247
- excludedShaders,
248
- failedBodies,
249
- rasterCompleteness,
250
- availableShaderCount
251
- });
252
- if (!qualification.ok && !values.allowFailures) {
253
- throw new Error(`Carbon WebGL target is incomplete; output was not built. ${qualification.errors.join("; ")}`);
254
- }
255
-
256
- // The container is the effect. `bytes` is its bytes, and there is no second
257
- // artifact — the chunk package this function used to build alongside it is
258
- // gone, along with the chunk assembly that produced it.
259
- //
260
- // `info`, `metadata`, `glsl` and `permutationGraph` are still returned.
261
- // They are the in-memory build result, which is richer than
262
- // anything the wire carries: the reasons a translation failed live there and
263
- // nowhere else. What changed is that they are no longer *also* serialised
264
- // into tagged chunks beside the container.
265
- const backendBodySet = buildGlslBackendBodySet({
266
- bodies,
267
- stages,
268
- shaders: translatedShaders,
269
- variants,
270
- permutationGraph
271
- });
272
- const container = buildGlslEffectContainer(effectRes, permutationGraph, backendBodySet, {
273
- compilerVersion: effectRes.m_compilerVersionBytes
274
- });
275
- const bytes = container.bytes;
276
- const inspection = inspectGlslEffectContainer(bytes, {
277
- source: values.source
278
- });
279
- return Object.freeze({
280
- bytes,
281
- permutationCount: container.permutationCount,
282
- bodyCount: container.bodyCount,
283
- backendBodySet,
284
- info: Object.freeze(info),
285
- metadata: Object.freeze(metadata),
286
- permutationGraph,
287
- glsl: Object.freeze(glsl),
288
- inspection: Object.freeze(inspection),
289
- qualification: Object.freeze(qualification)
290
- });
291
- }
292
- function normalizeOptions(input, options) {
293
- if (!options || typeof options !== "object" || Array.isArray(options)) {
294
- throw new TypeError("Carbon WebGL effect options must be an object");
295
- }
296
- const sourceBytes = toBytes(input);
297
- const source = String(options.source ?? "memory").trim() || "memory";
298
- const selection = Object.freeze({
299
- technique: options.technique === undefined || options.technique === null ? null : String(options.technique),
300
- pass: options.pass === undefined || options.pass === null ? null : Number(options.pass),
301
- stage: options.stage === undefined || options.stage === null ? null : String(options.stage).toLowerCase()
302
- });
303
- if (selection.pass !== null && (!Number.isSafeInteger(selection.pass) || selection.pass < 0)) {
304
- throw new TypeError("Carbon WebGL effect pass must be a non-negative integer or null");
305
- }
306
- if (selection.stage !== null && !["vertex", "pixel", "compute"].includes(selection.stage)) {
307
- throw new TypeError(`Unsupported Carbon WebGL effect stage: ${selection.stage}`);
308
- }
309
- if (options.emitterOptions !== undefined && (!options.emitterOptions || typeof options.emitterOptions !== "object" || Array.isArray(options.emitterOptions))) {
310
- throw new TypeError("Carbon WebGL emitterOptions must be an object");
311
- }
312
- return {
313
- sourceBytes,
314
- source,
315
- outputPath: normalizeOptionalString(options.outputPath, "Carbon WebGL outputPath"),
316
- sourceIdentity: options.sourceIdentity ?? null,
317
- generatedAt: options.generatedAt === undefined || options.generatedAt === null ? null : new Date(options.generatedAt).toISOString(),
318
- allPermutations: options.allPermutations !== false,
319
- allowFailures: options.allowFailures === true,
320
- selection,
321
- // How to lower a recognised local-light family. Defaults to leaving it
322
- // alone, so a caller that does not ask gets the shader's own resources
323
- // and the honest texture count.
324
- localLights: normalizeLocalLightMode(options.localLights),
325
- // Whether to keep `LightProfileArray`. Defaults to dropping it, because
326
- // it costs a fragment sampler unit that the quad family does not have
327
- // to spare, and because nothing currently selects a profile: the index
328
- // lives in flags bits 4-15 and every `GetCarbonLightData()` writes only
329
- // bit 0, so the shader's own guard skips the lookup for every light. A
330
- // dropped profile is therefore observationally identical today and a
331
- // real loss only once profile indices are written.
332
- // See /docs/contracts/carbon-light-data.md.
333
- lightProfile: normalizeLightProfileMode(options.lightProfile),
334
- emitterOptions: {
335
- ...(options.emitterOptions ?? {})
336
- }
337
- };
338
- }
339
- function normalizeOptionalString(value, name) {
340
- if (value === undefined || value === null) {
341
- return null;
342
- }
343
- const result = String(value).trim();
344
- if (!result) {
345
- throw new TypeError(`${name} must be a non-empty string or null`);
346
- }
347
- return result;
348
- }
349
- function selectionCoversWholeEffect(selection) {
350
- return selection.technique === null && selection.pass === null && selection.stage === null;
351
- }
352
- function toBytes(input) {
353
- if (input instanceof Uint8Array) {
354
- return input;
355
- }
356
- if (input instanceof ArrayBuffer) {
357
- return new Uint8Array(input);
358
- }
359
- if (ArrayBuffer.isView(input)) {
360
- return new Uint8Array(input.buffer, input.byteOffset, input.byteLength);
361
- }
362
- throw new TypeError("Carbon WebGL effect input must be Uint8Array, ArrayBuffer, or ArrayBufferView bytes");
363
- }
364
- function defaultPermutationIndex(permutations) {
365
- let multiplier = 1;
366
- let index = 0;
367
- for (const permutation of permutations) {
368
- index += (permutation.defaultOption || 0) * multiplier;
369
- multiplier *= permutation.options.length || 1;
370
- }
371
- return index;
372
- }
373
- function bodyKey(record) {
374
- return `body_${record.offset}_${record.size}`;
375
- }
376
- function decodePermutationOptions(permutations, permutationIndex) {
377
- let remaining = permutationIndex;
378
- return permutations.map(permutation => {
379
- const optionCount = permutation.options.length || 1;
380
- const optionIndex = optionCount ? remaining % optionCount : 0;
381
- remaining = Math.floor(remaining / optionCount);
382
- return {
383
- name: permutation.name,
384
- value: permutation.options[optionIndex] || "",
385
- optionIndex,
386
- defaultOption: permutation.defaultOption
387
- };
388
- });
389
- }
390
- function toShaderOptions(options) {
391
- return options.map(option => ({
392
- name: option.name,
393
- value: option.value
394
- }));
395
- }
396
- function buildExportVariants(effectRes, allPermutations) {
397
- if (allPermutations) {
398
- return effectRes.m_offsets.map((record, variantIndex) => {
399
- const permutationIndex = Number.isInteger(record.index) ? record.index : variantIndex;
400
- return {
401
- key: `variant_${permutationIndex}`,
402
- variantIndex,
403
- permutationIndex,
404
- tableIndex: variantIndex,
405
- bodyKey: bodyKey(record),
406
- bodyOffset: record.offset,
407
- bodySize: record.size,
408
- options: decodePermutationOptions(effectRes.m_permutations, permutationIndex),
409
- tableIndexMatchesPermutationIndex: variantIndex === permutationIndex
410
- };
411
- });
412
- }
413
- const permutationIndex = defaultPermutationIndex(effectRes.m_permutations);
414
- const record = effectRes.m_offsets[permutationIndex];
415
- if (!record) {
416
- throw new Error(`Default permutation index ${permutationIndex} is not present`);
417
- }
418
- return [{
419
- key: `variant_${permutationIndex}`,
420
- variantIndex: permutationIndex,
421
- permutationIndex,
422
- tableIndex: permutationIndex,
423
- bodyKey: bodyKey(record),
424
- bodyOffset: record.offset,
425
- bodySize: record.size,
426
- options: decodePermutationOptions(effectRes.m_permutations, permutationIndex),
427
- tableIndexMatchesPermutationIndex: Number.isInteger(record.index) ? record.index === permutationIndex : true
428
- }];
429
- }
430
- function collectStages(effectDescription, selection) {
431
- const stages = [];
432
- const errors = [];
433
- for (const technique of effectDescription.techniques ?? []) {
434
- if (selection.technique && technique.name !== selection.technique) {
435
- continue;
436
- }
437
- if (!selection.stage && !Number.isInteger(selection.pass) && technique.passes.length === 0) {
438
- errors.push(`${technique.name} declares no passes`);
439
- }
440
- for (let passIndex = 0; passIndex < technique.passes.length; passIndex++) {
441
- if (Number.isInteger(selection.pass) && passIndex !== selection.pass) {
442
- continue;
443
- }
444
- const pass = technique.passes[passIndex];
445
- let declaredStageCount = 0;
446
- for (let stageType = 0; stageType < HlslRenderContextEnum.SHADER_TYPE_COUNT; stageType++) {
447
- const stageInput = pass.stageInputs[stageType];
448
- if (!stageInput?.m_exists) {
449
- continue;
450
- }
451
- declaredStageCount++;
452
- const stageName = hlslShaderStageName(stageType);
453
- if (selection.stage && stageName !== selection.stage) {
454
- continue;
455
- }
456
- if (!stageInput.cjsShaderBytecode) {
457
- errors.push(`${technique.name}.pass${passIndex}.${stageName} declares shader handle ` + `${stageInput.m_shader ?? "unknown"} but has no shader bytecode`);
458
- continue;
459
- }
460
- stages.push({
461
- key: `${technique.name}.pass${passIndex}.${stageName}`,
462
- techniqueName: technique.name,
463
- passIndex,
464
- stageType,
465
- stageName,
466
- shaderHandle: stageInput.m_shader,
467
- bytecode: stageInput.cjsShaderBytecode,
468
- pipelineInputs: cloneJson(stageInput.signature?.pipelineInputs ?? []),
469
- registers: cloneJson(stageInput.signature?.registers ?? []),
470
- resources: mapToJson(stageInput.resources),
471
- samplers: mapToJson(stageInput.samplers),
472
- uavs: mapToJson(stageInput.uavs),
473
- constants: cloneJson(stageInput.constants ?? []),
474
- // Recognised from reflection here, applied by the emitter.
475
- // The recogniser is shared with WebGPU so both backends
476
- // merge exactly the same registers.
477
- detailMapArray: recogniseDetailMapFamily(mapToJson(stageInput.resources)),
478
- localLights: recogniseLocalLightFamily(mapToJson(stageInput.resources))
479
- });
480
- }
481
- if (!selection.stage && declaredStageCount === 0) {
482
- errors.push(`${technique.name}.pass${passIndex} declares no shader stages`);
483
- }
484
- }
485
- }
486
- return {
487
- stages,
488
- errors
489
- };
490
- }
491
-
492
- /** Local-light lowering modes this packager accepts. */
493
- const LOCAL_LIGHT_MODES = Object.freeze(["none", "packed-texture", "constant-buffer", "drop"]);
494
-
495
- /** How `LightProfileArray` is treated. */
496
- const LIGHT_PROFILE_MODES = Object.freeze(["drop", "keep"]);
497
-
498
- /**
499
- * Normalizes the light-profile mode.
500
- *
501
- * @param {string|undefined|null} value Requested mode.
502
- * @returns {string} Normalized mode.
503
- */
504
- function normalizeLightProfileMode(value) {
505
- const mode = value === undefined || value === null ? "drop" : String(value);
506
- if (!LIGHT_PROFILE_MODES.includes(mode)) {
507
- throw new TypeError(`Carbon WebGL lightProfile must be one of ${LIGHT_PROFILE_MODES.join(", ")}; got "${mode}"`);
508
- }
509
- return mode;
510
- }
511
-
512
- /**
513
- * Emitter options that drop `LightProfileArray` and neutralise its samples.
514
- *
515
- * Only applies when the local-light family is left alone. `packed-texture`,
516
- * `constant-buffer` and `drop` each already decide what happens to the profile
517
- * register, and asking for it twice would either be redundant or fight them.
518
- *
519
- * @param {object|null} plan Recognised local-light family, if any.
520
- * @param {string} localLightMode Normalized local-light mode.
521
- * @param {string} profileMode Normalized light-profile mode.
522
- * @returns {object|null} Emitter options, or null when nothing to do.
523
- */
524
- function lightProfileEmitterOptions(plan, localLightMode, profileMode) {
525
- if (profileMode !== "drop" || localLightMode !== "none") return null;
526
- if (!Number.isInteger(plan?.profileRegister)) return null;
527
- return {
528
- neutralResourceRegisters: [plan.profileRegister]
529
- };
530
- }
531
-
532
- /**
533
- * Normalizes the local-light lowering mode.
534
- *
535
- * @param {string|undefined|null} value Requested mode.
536
- * @returns {string} Normalized mode.
537
- */
538
- function normalizeLocalLightMode(value) {
539
- if (value === undefined || value === null) return "none";
540
- const mode = String(value);
541
- if (!LOCAL_LIGHT_MODES.includes(mode)) {
542
- throw new TypeError(`Carbon WebGL localLights must be one of ${LOCAL_LIGHT_MODES.join(", ")}; got "${mode}"`);
543
- }
544
- return mode;
545
- }
546
-
547
- /**
548
- * Builds the emitter profile that lowers a recognised local-light family.
549
- *
550
- * Carbon's local lights are two structured buffers plus an optional profile
551
- * texture. WebGL 2 has no structured buffers, so one of these lowerings is
552
- * required for the shader to bind its lights at all; WebGPU needs none of it and
553
- * binds them natively.
554
- *
555
- * The constants here match the CLI packager's resolvers exactly, so the two
556
- * pipelines produce identical output while they still both exist. They are not
557
- * endorsements: `dataTexelBase` and `capacity` are values that happened to work,
558
- * and the constant-buffer route is known to fail on light count.
559
- *
560
- * @param {object} plan Recognised local-light family.
561
- * @param {string} mode Lowering mode.
562
- * @returns {object|null} Emitter options fragment, or null when not lowering.
563
- */
564
- function localLightEmitterOptions(plan, mode) {
565
- if (!plan || mode === "none") return null;
566
- if (mode === "drop") {
567
- // No lighting at all: the declarations go and every read lowers to zero.
568
- // Kept because isolating a lighting problem is easier without lights,
569
- // not because the texture budget needs it any more.
570
- return {
571
- stubResourceRegisters: plan.registers
572
- };
573
- }
574
- if (mode === "packed-texture") {
575
- return {
576
- lightPackedTexture: {
577
- indexRegister: plan.indexRegister,
578
- dataRegister: plan.dataRegister,
579
- profileRegister: plan.profileRegister,
580
- registerIndex: plan.indexRegister,
581
- name: "cjsLocalLightTexture",
582
- dataTexelBase: 131072
583
- }
584
- };
585
- }
586
- if (mode === "constant-buffer") {
587
- // Slot 6 is `g_uiTransforms` in the constant-buffer slot contract. There
588
- // is no collision on space-object shaders, which carry no UI transforms,
589
- // but this is squatting on a reserved number and should move.
590
- return {
591
- lightConstantBuffer: {
592
- indexRegister: plan.indexRegister,
593
- dataRegister: plan.dataRegister,
594
- profileRegister: plan.profileRegister,
595
- registerIndex: 6,
596
- name: "cb6",
597
- capacity: 40
598
- }
599
- };
600
- }
601
- throw new Error(`Unknown local-light lowering mode "${mode}"`);
602
- }
603
- function translateStages(shaderMap, stageMap, values) {
604
- const emitInto = (record, pairVaryings) => {
605
- try {
606
- const profileNeutral = lightProfileEmitterOptions(record.localLights, values.localLights, values.lightProfile);
607
- // Remembered on the record so the body set can emit the resource
608
- // transform that accounts for the dropped resource. The transform's
609
- // identity includes the pass key, which is not known here.
610
- if (profileNeutral) record.lightProfileNeutral = record.localLights;
611
- const result = emitGlslWithOptions(record.bytes, {
612
- ...values.emitterOptions,
613
- source: `${values.source}#${record.firstStageKey}`,
614
- ...(pairVaryings?.length ? {
615
- pairVaryings
616
- } : {}),
617
- ...(record.detailMapArray ? {
618
- detailMapArrayRegisters: record.detailMapArray.registers
619
- } : {}),
620
- ...(localLightEmitterOptions(record.localLights, values.localLights) ?? {}),
621
- ...(profileNeutral ?? {})
622
- });
623
- const stageInterface = normalizeBitangentStageInterface(result, record);
624
- record.emit = {
625
- ...result,
626
- source: stageInterface.source,
627
- inputs: stageInterface.inputs
628
- };
629
- record.source = stageInterface.source;
630
- record.bindings = result.bindings;
631
- record.stageInputs = stageInterface.inputs;
632
- record.stageOutputs = result.outputs;
633
- record.emitWarnings = result.warnings;
634
- record.translator = "dxbc-js-emitter";
635
- record.hlsl2webgl = {
636
- ok: true,
637
- mode: "js-emitter"
638
- };
639
- if (result.stageName === "compute") {
640
- record.computeFragment = result.computeFragment;
641
- }
642
- const issue = validateStageSourceShape(record);
643
- if (issue) {
644
- record.hlsl2webgl = {
645
- ok: false,
646
- validationError: issue
647
- };
648
- record.source = null;
649
- }
650
- } catch (error) {
651
- const message = error?.message || String(error);
652
- record.hlsl2webgl = {
653
- ok: false,
654
- error: message,
655
- details: error?.details ?? null
656
- };
657
- if (/not supported|No GLSL lowering|unimplementable/iu.test(message)) {
658
- record.excluded = {
659
- reason: message,
660
- ...(error?.details?.opcodeName ? {
661
- opcodeName: error.details.opcodeName
662
- } : {}),
663
- ...(error?.details?.dimensionName ? {
664
- dimensionName: error.details.dimensionName
665
- } : {})
666
- };
667
- }
668
- }
669
- };
670
- for (const record of shaderMap.values()) {
671
- if (record.stageName !== "vertex") {
672
- emitInto(record, null);
673
- }
674
- }
675
- const pixelVaryingsByPass = new Map();
676
- for (const stage of stageMap.values()) {
677
- if (stage.stageName !== "pixel") {
678
- continue;
679
- }
680
- const record = shaderMap.get(stage.shaderKey);
681
- if (!record?.emit) {
682
- continue;
683
- }
684
- pixelVaryingsByPass.set(`${stage.bodyKey}|${stage.techniqueName}|${stage.passIndex}`, record.emit.inputs.filter(input => typeof input.name === "string" && input.name.startsWith("vs_r")).map(input => input.register).sort((left, right) => left - right));
685
- }
686
- for (const stage of stageMap.values()) {
687
- if (stage.stageName !== "vertex") {
688
- continue;
689
- }
690
- const record = shaderMap.get(stage.shaderKey);
691
- const varyings = pixelVaryingsByPass.get(`${stage.bodyKey}|${stage.techniqueName}|${stage.passIndex}`) ?? [];
692
- if (record) {
693
- record.pairVaryings = varyings;
694
- emitInto(record, varyings);
695
- }
696
- }
697
- }
698
- function cloneJson(value) {
699
- if (value === undefined || value === null) {
700
- return value;
701
- }
702
- return JSON.parse(JSON.stringify(value));
703
- }
704
- function mapToJson(map) {
705
- if (!(map instanceof Map)) {
706
- return [];
707
- }
708
- return Array.from(map.entries()).map(([registerIndex, value]) => ({
709
- registerIndex,
710
- ...cloneJson(value)
711
- }));
712
- }
713
- function buildStageContract(stage) {
714
- const pipelineInputs = cloneJson(stage.pipelineInputs ?? []);
715
- const inputSemantics = pipelineInputs.map(input => ({
716
- semantic: `${input.usageName || `USAGE_${input.usage}`}${input.usageIndex || ""}`,
717
- usage: input.usage,
718
- usageName: input.usageName,
719
- usageIndex: input.usageIndex,
720
- registerIndex: input.registerIndex,
721
- usedMask: input.usedMask,
722
- type: input.type,
723
- dimension: input.dimension
724
- }));
725
- const inputNames = new Set(inputSemantics.map(input => input.usageName));
726
- const hasNormal = inputNames.has("NORMAL");
727
- const hasTangent = inputNames.has("TANGENT");
728
- const hasBinormal = inputNames.has("BINORMAL") || inputNames.has("BITANGENT");
729
- const hasBlendIndices = inputNames.has("BLENDINDICES") || inputNames.has("BLENDINDICE");
730
- let tangentContract = "none";
731
- if (hasNormal && hasTangent && hasBinormal) {
732
- tangentContract = "split_tbn";
733
- } else if (!hasNormal && hasTangent) {
734
- tangentContract = "packed_tangent_or_tangent_only";
735
- } else if (hasNormal || hasTangent || hasBinormal) {
736
- tangentContract = "partial_tbn";
737
- }
738
- const resources = cloneJson(stage.resources ?? []);
739
- const samplers = cloneJson(stage.samplers ?? []);
740
- const uavs = cloneJson(stage.uavs ?? []);
741
- const constants = cloneJson(stage.constants ?? []);
742
- const resourceNames = resources.map(entry => entry.name).filter(Boolean);
743
- return {
744
- stageName: stage.stageName,
745
- stageType: stage.stageType,
746
- vertex: stage.stageName === "vertex" ? {
747
- inputs: inputSemantics,
748
- tangentContract,
749
- requiresSplitTbn: tangentContract === "split_tbn",
750
- requiresPackedTangent: tangentContract === "packed_tangent_or_tangent_only",
751
- requiresSkinning: hasBlendIndices || resourceNames.includes("BoneTransforms"),
752
- hasBlendIndices
753
- } : null,
754
- texturePacking: classifyTexturePacking(resourceNames),
755
- constantBuffers: (stage.registers ?? []).filter(entry => entry.registerType === 0).map(entry => ({
756
- registerIndex: entry.registerIndex,
757
- registerSpace: entry.registerSpace,
758
- registerCount: entry.registerCount,
759
- arrayCount: entry.arrayCount,
760
- dynamic: Boolean(entry.dynamic)
761
- })),
762
- resources,
763
- samplers,
764
- uavs,
765
- constants
766
- };
767
- }
768
- function classifyTexturePacking(names) {
769
- const values = new Set(names);
770
- if (["NoMap", "PmdgMap", "ArMap"].some(name => values.has(name))) {
771
- return "packed_textures";
772
- }
773
- if (["NormalMap", "RoughnessMap", "MaterialMap", "AlbedoMap", "AoMap", "PaintMaskMap"].some(name => values.has(name))) {
774
- return "unpacked_textures";
775
- }
776
- return "unknown";
777
- }
778
- function mergeShaderContracts(contracts) {
779
- const first = contracts?.[0]?.contract ?? null;
780
- if (!first) {
781
- return null;
782
- }
783
- return {
784
- stageName: first.stageName,
785
- stageType: first.stageType,
786
- vertex: first.vertex ? cloneJson(first.vertex) : null,
787
- texturePacking: first.texturePacking,
788
- constantBuffers: cloneJson(first.constantBuffers ?? []),
789
- resourceNames: (first.resources ?? []).map(entry => entry.name).filter(Boolean),
790
- samplerNames: (first.samplers ?? []).map(entry => entry.name).filter(Boolean),
791
- sharedByStageCount: contracts.length
792
- };
793
- }
794
- function normalizeBitangentStageInterface(result, shaderRecord) {
795
- if (shaderRecord?.stageName !== "vertex") {
796
- return {
797
- source: result.source,
798
- inputs: result.inputs
799
- };
800
- }
801
- const bitangentRegisters = new Set((shaderRecord.contracts ?? []).flatMap(entry => entry.contract?.vertex?.inputs ?? []).filter(input => input.usageName === "BITANGENT").map(input => input.registerIndex));
802
- let source = result.source;
803
- const inputs = result.inputs.map(input => {
804
- if (!bitangentRegisters.has(input.register) || input.semanticName !== "BINORMAL") {
805
- return input;
806
- }
807
- const name = `in_BITANGENT${input.semanticIndex}`;
808
- source = source.replaceAll(input.name, name);
809
- return {
810
- ...input,
811
- name,
812
- semanticName: "BITANGENT"
813
- };
814
- });
815
- return {
816
- source,
817
- inputs
818
- };
819
- }
820
- function validateStageSourceShape(record) {
821
- const source = record?.source ?? "";
822
- if (!source) {
823
- return null;
824
- }
825
- const hasVertexOutput = /\bgl_Position\b/u.test(source);
826
- const hasVertexInterface = /\bin\s+(?:lowp|mediump|highp)?\s*\w+\s+attr\d+\b/u.test(source) || /\bout\s+(?:lowp|mediump|highp)?\s*\w+\s+vs_TEXCOORD\d+\b/u.test(source) || /\bin_[A-Z]+[0-9]+\b/u.test(source);
827
- const hasFragmentOutput = /\bout\s+(?:lowp|mediump|highp)?\s*vec4\s+SV_Target\d+\b/u.test(source) || /\bgl_FragColor\b/u.test(source);
828
- if (record.stageName === "vertex" && !hasVertexOutput) {
829
- return "vertex stage source does not write gl_Position";
830
- }
831
- if (record.stageName === "pixel" && (hasVertexOutput || hasVertexInterface) && !hasFragmentOutput) {
832
- return "pixel stage source looks like vertex GLSL";
833
- }
834
- if (record.stageName === "compute" && !/\bcjsUav\d+(_s\d+)?\b/u.test(source)) {
835
- return "compute stage source does not write any cjsUav output";
836
- }
837
- return null;
838
- }
839
- function normalizeSourceIdentity(values) {
840
- const identity = values.sourceIdentity;
841
- if (identity !== null && (!identity || typeof identity !== "object" || Array.isArray(identity))) {
842
- throw new TypeError("Carbon WebGL sourceIdentity must be an object");
843
- }
844
- const sha256 = sha256Bytes(values.sourceBytes);
845
- if (identity?.sha256 !== undefined && identity?.sha256 !== null && identity.sha256 !== sha256) {
846
- throw new Error("Carbon WebGL sourceIdentity.sha256 does not match the exact effect input bytes");
847
- }
848
- return Object.freeze({
849
- filePath: identity?.filePath ?? values.source,
850
- logicalPath: identity?.logicalPath ?? values.source,
851
- game: identity?.game ?? null,
852
- client: identity?.client ?? null,
853
- build: identity?.build === undefined || identity?.build === null ? null : String(identity.build),
854
- byteLength: values.sourceBytes.byteLength,
855
- md5: identity?.md5 ?? null,
856
- sha256
857
- });
858
- }
859
- function qualifyEffectPackage({
860
- info,
861
- metadata,
862
- glsl,
863
- failedShaders,
864
- excludedShaders,
865
- failedBodies,
866
- rasterCompleteness,
867
- availableShaderCount
868
- }) {
869
- const errors = [];
870
- if (info.format !== "CARBON_WEBGL" || glsl.format !== "CARBON_WEBGL_GLSL_SET") {
871
- errors.push("invalid Carbon WebGL package envelope");
872
- }
873
- if (!Array.isArray(metadata.variants) || !Array.isArray(glsl.shaders)) {
874
- errors.push("missing Carbon WebGL graph arrays");
875
- }
876
- if (failedShaders.length) {
877
- errors.push(`${failedShaders.length} shader translation(s) failed`);
878
- }
879
- if (excludedShaders.length) {
880
- errors.push(`${excludedShaders.length} shader translation(s) are unsupported`);
881
- }
882
- if (failedBodies.length) {
883
- errors.push(`${failedBodies.length} effect body/bodies failed`);
884
- }
885
- if (rasterCompleteness.incompletePasses.length) {
886
- errors.push(`${rasterCompleteness.incompletePasses.length} raster pass(es) are incomplete`);
887
- }
888
- if (!availableShaderCount) {
889
- errors.push("no translated shaders are available");
890
- }
891
- return {
892
- ok: errors.length === 0,
893
- level: errors.length ? "diagnostic" : "structural",
894
- errors: Object.freeze(errors),
895
- incompletePasses: Object.freeze(rasterCompleteness.incompletePasses)
896
- };
897
- }
898
-
899
- export { buildEffectPackage };
900
- //# sourceMappingURL=effectPackage.js.map
1
+ import { CjsHlslFormat } from '../../hlsl/CjsHlslFormat.js';
2
+ import { HlslRenderContextEnum, hlslShaderStageName } from '../../hlsl/core/tr2/HlslRenderContextEnum.js';
3
+ import '@carbonenginejs/runtime-utils/bytes';
4
+ import '../../hlsl/core/carbonDescriptionToRuntime.js';
5
+ import '../../../format/CjsByteReader.js';
6
+ import '../../../format/compareUtf8.js';
7
+ import { HlslEffectBindingManifest } from '../../hlsl/core/tr2/shader/HlslEffectBindingManifest.js';
8
+ import { buildEffectPermutationGraph, EFFECT_PERMUTATION_GRAPH_VERSION, EFFECT_PERMUTATION_GRAPH_FORMAT, EFFECT_PERMUTATION_GRAPH_CHUNK } from '../../../format/effect/effectPermutationGraph.js';
9
+ import { emitGlslWithOptions } from './helpers.js';
10
+ import { inspectGlslEffectContainer } from './inspectGlslEffectContainer.js';
11
+ import { inspectRasterCompleteness } from './glslEffectCompleteness.js';
12
+ import { recogniseDetailMapFamily } from '../../hlsl/core/detailMapFamily.js';
13
+ import { stripLocalLightBindings, recogniseLocalLightFamily } from '../../hlsl/core/localLightFamily.js';
14
+ import { buildGlslBackendBodySet } from './glslBackendBodySet.js';
15
+ import { buildGlslEffectContainer } from './buildGlslEffectContainer.js';
16
+ import { sha256Utf8, sha256Bytes } from '../../../format/effect/sha256.js';
17
+
18
+ /**
19
+ * INFO record version for the in-memory build result.
20
+ *
21
+ * This lived in effectPackageValidation.js, which validated a written chunk
22
+ * package by reading it back. There is no chunk package to read back, so that
23
+ * file is gone and its one surviving constant lives with its only user.
24
+ */
25
+ const EFFECT_INFO_VERSION = 3;
26
+ const PACKAGE_VERSION = "0.11.1";
27
+
28
+ /**
29
+ * Builds a complete Carbon WebGL package from compiled Tr2 effect bytes.
30
+ *
31
+ * This browser-safe path owns whole-effect selection, stage translation,
32
+ * package assembly, and structural qualification. Filesystem and native-tool
33
+ * concerns remain in Node callers.
34
+ *
35
+ * @param {Uint8Array|ArrayBuffer|ArrayBufferView} input Compiled effect bytes.
36
+ * @param {object} [options] Selection, provenance, and emitter policy.
37
+ * @returns {object} Package bytes plus inspection and qualification records.
38
+ */
39
+ function buildEffectPackage(input, options = {}) {
40
+ const values = normalizeOptions(input, options);
41
+ const effectRes = CjsHlslFormat.read(values.sourceBytes, {
42
+ emit: CjsHlslFormat.OUTPUT_RAW,
43
+ source: values.source
44
+ });
45
+ if (!effectRes.IsGood()) {
46
+ throw effectRes.loadError || new Error("Tr2EffectRes failed to load input");
47
+ }
48
+ const sourceIdentity = normalizeSourceIdentity(values);
49
+ // One INFO version means one contract, and that contract requires complete
50
+ // source reflection, which only version-15 input can supply.
51
+ if (effectRes.m_version !== 15) {
52
+ throw new Error("Effect package requires a version-15 compiled effect, got version " + (effectRes.m_version ?? "unknown"));
53
+ }
54
+ const permutationGraph = buildEffectPermutationGraph(effectRes);
55
+ const variants = buildExportVariants(effectRes, values.allPermutations);
56
+ const bodyMap = new Map();
57
+ const stageMap = new Map();
58
+ const shaderMap = new Map();
59
+ for (const variant of variants) {
60
+ if (bodyMap.has(variant.bodyKey)) {
61
+ continue;
62
+ }
63
+ const shader = effectRes.GetShader(toShaderOptions(variant.options));
64
+ if (!shader) {
65
+ bodyMap.set(variant.bodyKey, {
66
+ key: variant.bodyKey,
67
+ bodyOffset: variant.bodyOffset,
68
+ bodySize: variant.bodySize,
69
+ firstVariantKey: variant.key,
70
+ error: "Tr2EffectRes.GetShader returned null",
71
+ manifest: null,
72
+ stages: []
73
+ });
74
+ continue;
75
+ }
76
+ const effectDescription = shader.GetEffectDescription();
77
+ const manifest = HlslEffectBindingManifest.fromEffectDescription(effectDescription);
78
+ const collection = collectStages(effectDescription, values.selection);
79
+ const body = {
80
+ key: variant.bodyKey,
81
+ bodyOffset: variant.bodyOffset,
82
+ bodySize: variant.bodySize,
83
+ firstVariantKey: variant.key,
84
+ error: collection.errors.length ? collection.errors.join("; ") : null,
85
+ // Dropping the light family removes its declarations from the
86
+ // shader, so the manifest must stop advertising them too.
87
+ manifest: values.localLights === "drop" ? stripLocalLightBindings(manifest.toJSON()) : manifest.toJSON(),
88
+ stages: []
89
+ };
90
+ for (const stage of collection.stages) {
91
+ const stageKey = `${variant.bodyKey}.${stage.key}`;
92
+ const shaderKey = `shader_${stageKey}`;
93
+ const contract = buildStageContract(stage);
94
+ const stageRecord = {
95
+ key: stageKey,
96
+ bodyKey: variant.bodyKey,
97
+ localKey: stage.key,
98
+ techniqueName: stage.techniqueName,
99
+ passIndex: stage.passIndex,
100
+ stageType: stage.stageType,
101
+ stageName: stage.stageName,
102
+ shaderHandle: stage.shaderHandle,
103
+ shaderSize: stage.bytecode.shaderSize,
104
+ stringTableOffset: stage.bytecode.stringTableOffset,
105
+ shaderKey,
106
+ contract
107
+ };
108
+ stageMap.set(stageKey, stageRecord);
109
+ body.stages.push(stageKey);
110
+ shaderMap.set(shaderKey, {
111
+ key: shaderKey,
112
+ firstStageKey: stageKey,
113
+ firstBodyKey: variant.bodyKey,
114
+ stageName: stage.stageName,
115
+ shaderSize: stage.bytecode.shaderSize,
116
+ stringTableOffset: stage.bytecode.stringTableOffset,
117
+ bytes: stage.bytecode.bytes,
118
+ detailMapArray: stage.detailMapArray,
119
+ localLights: stage.localLights,
120
+ contracts: [{
121
+ stageKey,
122
+ techniqueName: stage.techniqueName,
123
+ passIndex: stage.passIndex,
124
+ stageName: stage.stageName,
125
+ contract
126
+ }]
127
+ });
128
+ }
129
+ bodyMap.set(variant.bodyKey, body);
130
+ }
131
+ translateStages(shaderMap, stageMap, values);
132
+ const bodies = Array.from(bodyMap.values());
133
+ const stages = Array.from(stageMap.values());
134
+ const translatedShaders = Array.from(shaderMap.values()).map(record => {
135
+ const {
136
+ bytes,
137
+ emit,
138
+ ...output
139
+ } = record;
140
+ output.primaryContract = mergeShaderContracts(output.contracts);
141
+ return output;
142
+ });
143
+ const failedShaders = translatedShaders.filter(record => !record.hlsl2webgl?.ok && !record.excluded);
144
+ const excludedShaders = translatedShaders.filter(record => record.excluded);
145
+ const failedBodies = bodies.filter(body => body.error);
146
+ // The same rule the validator applies to a finished file. This function used
147
+ // to carry its own copy, and the two had already drifted: the local one had
148
+ // dropped `hlsl2webgl.reason` from its reason chain, so the library and the
149
+ // validator could describe one incomplete pass two different ways. If two
150
+ // places must agree, one of them calls the other.
151
+ const rasterCompleteness = inspectRasterCompleteness(stages, translatedShaders);
152
+ const availableShaderCount = translatedShaders.filter(record => record.hlsl2webgl?.ok && record.source).length;
153
+ const info = {
154
+ format: "CARBON_WEBGL",
155
+ formatVersion: EFFECT_INFO_VERSION,
156
+ packageKind: values.allPermutations ? "tr2-effect-webgl-permutations" : "tr2-effect-webgl",
157
+ targetBackend: "webgl",
158
+ backendPackage: "@carbonenginejs/runtime-resource/formats/webgl",
159
+ backendPackageVersion: PACKAGE_VERSION,
160
+ generatedAt: values.generatedAt,
161
+ sourcePath: values.source,
162
+ outputPath: values.outputPath,
163
+ sourceByteLength: sourceIdentity.byteLength,
164
+ sourceMd5: sourceIdentity.md5,
165
+ sourceSha256: sourceIdentity.sha256,
166
+ sourceIdentity,
167
+ translator: "dxbc-js-emitter",
168
+ translatorVersion: PACKAGE_VERSION,
169
+ language: "es300",
170
+ flags: null,
171
+ selection: values.selection,
172
+ permutationMode: values.allPermutations ? "all" : "selected",
173
+ defaultPermutationIndex: defaultPermutationIndex(effectRes.m_permutations),
174
+ sourceEffectVersion: effectRes.m_version,
175
+ sourceBodyCoverage: "all-unique",
176
+ backendBodyCoverage: values.allPermutations ? "all" : "selected",
177
+ backendProgramCoverage: selectionCoversWholeEffect(values.selection) ? "all-stages" : "filtered",
178
+ permutationCount: variants.length,
179
+ uniqueBodyCount: bodies.length,
180
+ sourcePermutationCount: permutationGraph.variants.length,
181
+ sourceUniqueBodyCount: permutationGraph.bodies.length,
182
+ permutationGraph: {
183
+ chunk: EFFECT_PERMUTATION_GRAPH_CHUNK,
184
+ format: EFFECT_PERMUTATION_GRAPH_FORMAT,
185
+ formatVersion: EFFECT_PERMUTATION_GRAPH_VERSION,
186
+ sha256: sha256Utf8(`${JSON.stringify(permutationGraph)}\n`),
187
+ permutationCount: permutationGraph.variants.length,
188
+ uniqueBodyCount: permutationGraph.bodies.length
189
+ },
190
+ bodyStageCount: stages.length,
191
+ uniqueShaderCount: translatedShaders.length,
192
+ translatedShaderCount: translatedShaders.length - failedShaders.length - excludedShaders.length,
193
+ excludedShaderCount: excludedShaders.length,
194
+ failedShaderCount: failedShaders.length,
195
+ failedBodyCount: failedBodies.length,
196
+ expectedRasterPassCount: rasterCompleteness.expectedPassCount,
197
+ completeRasterPassCount: rasterCompleteness.completePassCount,
198
+ incompleteRasterPassCount: rasterCompleteness.incompletePasses.length,
199
+ availableShaderCount,
200
+ allowFailures: values.allowFailures,
201
+ completeness: {
202
+ packageValid: true,
203
+ sourceComplete: effectRes.m_version === 15,
204
+ backendComplete: false,
205
+ runtimeComplete: false
206
+ }
207
+ };
208
+ const metadata = {
209
+ generatedAt: values.generatedAt,
210
+ sourcePath: values.source,
211
+ effectResource: effectRes.toJSON(),
212
+ permutations: effectRes.GetPermutationDescription(),
213
+ variants,
214
+ bodies: bodies.map(body => ({
215
+ key: body.key,
216
+ bodyOffset: body.bodyOffset,
217
+ bodySize: body.bodySize,
218
+ firstVariantKey: body.firstVariantKey,
219
+ error: body.error,
220
+ manifest: body.manifest
221
+ }))
222
+ };
223
+ const glsl = {
224
+ format: "CARBON_WEBGL_GLSL_SET",
225
+ formatVersion: 1,
226
+ language: "es300",
227
+ permutationMode: info.permutationMode,
228
+ selection: values.selection,
229
+ variants: variants.map(variant => ({
230
+ key: variant.key,
231
+ permutationIndex: variant.permutationIndex,
232
+ bodyKey: variant.bodyKey
233
+ })),
234
+ bodies: bodies.map(body => ({
235
+ key: body.key,
236
+ error: body.error,
237
+ stages: body.stages
238
+ })),
239
+ stages,
240
+ shaders: translatedShaders
241
+ };
242
+ const qualification = qualifyEffectPackage({
243
+ info,
244
+ metadata,
245
+ glsl,
246
+ failedShaders,
247
+ excludedShaders,
248
+ failedBodies,
249
+ rasterCompleteness,
250
+ availableShaderCount
251
+ });
252
+ if (!qualification.ok && !values.allowFailures) {
253
+ throw new Error(`Carbon WebGL target is incomplete; output was not built. ${qualification.errors.join("; ")}`);
254
+ }
255
+
256
+ // The container is the effect. `bytes` is its bytes, and there is no second
257
+ // artifact — the chunk package this function used to build alongside it is
258
+ // gone, along with the chunk assembly that produced it.
259
+ //
260
+ // `info`, `metadata`, `glsl` and `permutationGraph` are still returned.
261
+ // They are the in-memory build result, which is richer than
262
+ // anything the wire carries: the reasons a translation failed live there and
263
+ // nowhere else. What changed is that they are no longer *also* serialised
264
+ // into tagged chunks beside the container.
265
+ const backendBodySet = buildGlslBackendBodySet({
266
+ bodies,
267
+ stages,
268
+ shaders: translatedShaders,
269
+ variants,
270
+ permutationGraph
271
+ });
272
+ const container = buildGlslEffectContainer(effectRes, permutationGraph, backendBodySet, {
273
+ compilerVersion: effectRes.m_compilerVersionBytes
274
+ });
275
+ const bytes = container.bytes;
276
+ const inspection = inspectGlslEffectContainer(bytes, {
277
+ source: values.source
278
+ });
279
+ return Object.freeze({
280
+ bytes,
281
+ permutationCount: container.permutationCount,
282
+ bodyCount: container.bodyCount,
283
+ backendBodySet,
284
+ info: Object.freeze(info),
285
+ metadata: Object.freeze(metadata),
286
+ permutationGraph,
287
+ glsl: Object.freeze(glsl),
288
+ inspection: Object.freeze(inspection),
289
+ qualification: Object.freeze(qualification)
290
+ });
291
+ }
292
+ function normalizeOptions(input, options) {
293
+ if (!options || typeof options !== "object" || Array.isArray(options)) {
294
+ throw new TypeError("Carbon WebGL effect options must be an object");
295
+ }
296
+ const sourceBytes = toBytes(input);
297
+ const source = String(options.source ?? "memory").trim() || "memory";
298
+ const selection = Object.freeze({
299
+ technique: options.technique === undefined || options.technique === null ? null : String(options.technique),
300
+ pass: options.pass === undefined || options.pass === null ? null : Number(options.pass),
301
+ stage: options.stage === undefined || options.stage === null ? null : String(options.stage).toLowerCase()
302
+ });
303
+ if (selection.pass !== null && (!Number.isSafeInteger(selection.pass) || selection.pass < 0)) {
304
+ throw new TypeError("Carbon WebGL effect pass must be a non-negative integer or null");
305
+ }
306
+ if (selection.stage !== null && !["vertex", "pixel", "compute"].includes(selection.stage)) {
307
+ throw new TypeError(`Unsupported Carbon WebGL effect stage: ${selection.stage}`);
308
+ }
309
+ if (options.emitterOptions !== undefined && (!options.emitterOptions || typeof options.emitterOptions !== "object" || Array.isArray(options.emitterOptions))) {
310
+ throw new TypeError("Carbon WebGL emitterOptions must be an object");
311
+ }
312
+ return {
313
+ sourceBytes,
314
+ source,
315
+ outputPath: normalizeOptionalString(options.outputPath, "Carbon WebGL outputPath"),
316
+ sourceIdentity: options.sourceIdentity ?? null,
317
+ generatedAt: options.generatedAt === undefined || options.generatedAt === null ? null : new Date(options.generatedAt).toISOString(),
318
+ allPermutations: options.allPermutations !== false,
319
+ allowFailures: options.allowFailures === true,
320
+ selection,
321
+ // How to lower a recognised local-light family. Defaults to leaving it
322
+ // alone, so a caller that does not ask gets the shader's own resources
323
+ // and the honest texture count.
324
+ localLights: normalizeLocalLightMode(options.localLights),
325
+ // Whether to keep `LightProfileArray`. Defaults to dropping it, because
326
+ // it costs a fragment sampler unit that the quad family does not have
327
+ // to spare, and because nothing currently selects a profile: the index
328
+ // lives in flags bits 4-15 and every `GetCarbonLightData()` writes only
329
+ // bit 0, so the shader's own guard skips the lookup for every light. A
330
+ // dropped profile is therefore observationally identical today and a
331
+ // real loss only once profile indices are written.
332
+ // See /docs/contracts/carbon-light-data.md.
333
+ lightProfile: normalizeLightProfileMode(options.lightProfile),
334
+ emitterOptions: {
335
+ ...(options.emitterOptions ?? {})
336
+ }
337
+ };
338
+ }
339
+ function normalizeOptionalString(value, name) {
340
+ if (value === undefined || value === null) {
341
+ return null;
342
+ }
343
+ const result = String(value).trim();
344
+ if (!result) {
345
+ throw new TypeError(`${name} must be a non-empty string or null`);
346
+ }
347
+ return result;
348
+ }
349
+ function selectionCoversWholeEffect(selection) {
350
+ return selection.technique === null && selection.pass === null && selection.stage === null;
351
+ }
352
+ function toBytes(input) {
353
+ if (input instanceof Uint8Array) {
354
+ return input;
355
+ }
356
+ if (input instanceof ArrayBuffer) {
357
+ return new Uint8Array(input);
358
+ }
359
+ if (ArrayBuffer.isView(input)) {
360
+ return new Uint8Array(input.buffer, input.byteOffset, input.byteLength);
361
+ }
362
+ throw new TypeError("Carbon WebGL effect input must be Uint8Array, ArrayBuffer, or ArrayBufferView bytes");
363
+ }
364
+ function defaultPermutationIndex(permutations) {
365
+ let multiplier = 1;
366
+ let index = 0;
367
+ for (const permutation of permutations) {
368
+ index += (permutation.defaultOption || 0) * multiplier;
369
+ multiplier *= permutation.options.length || 1;
370
+ }
371
+ return index;
372
+ }
373
+ function bodyKey(record) {
374
+ return `body_${record.offset}_${record.size}`;
375
+ }
376
+ function decodePermutationOptions(permutations, permutationIndex) {
377
+ let remaining = permutationIndex;
378
+ return permutations.map(permutation => {
379
+ const optionCount = permutation.options.length || 1;
380
+ const optionIndex = optionCount ? remaining % optionCount : 0;
381
+ remaining = Math.floor(remaining / optionCount);
382
+ return {
383
+ name: permutation.name,
384
+ value: permutation.options[optionIndex] || "",
385
+ optionIndex,
386
+ defaultOption: permutation.defaultOption
387
+ };
388
+ });
389
+ }
390
+ function toShaderOptions(options) {
391
+ return options.map(option => ({
392
+ name: option.name,
393
+ value: option.value
394
+ }));
395
+ }
396
+ function buildExportVariants(effectRes, allPermutations) {
397
+ if (allPermutations) {
398
+ return effectRes.m_offsets.map((record, variantIndex) => {
399
+ const permutationIndex = Number.isInteger(record.index) ? record.index : variantIndex;
400
+ return {
401
+ key: `variant_${permutationIndex}`,
402
+ variantIndex,
403
+ permutationIndex,
404
+ tableIndex: variantIndex,
405
+ bodyKey: bodyKey(record),
406
+ bodyOffset: record.offset,
407
+ bodySize: record.size,
408
+ options: decodePermutationOptions(effectRes.m_permutations, permutationIndex),
409
+ tableIndexMatchesPermutationIndex: variantIndex === permutationIndex
410
+ };
411
+ });
412
+ }
413
+ const permutationIndex = defaultPermutationIndex(effectRes.m_permutations);
414
+ const record = effectRes.m_offsets[permutationIndex];
415
+ if (!record) {
416
+ throw new Error(`Default permutation index ${permutationIndex} is not present`);
417
+ }
418
+ return [{
419
+ key: `variant_${permutationIndex}`,
420
+ variantIndex: permutationIndex,
421
+ permutationIndex,
422
+ tableIndex: permutationIndex,
423
+ bodyKey: bodyKey(record),
424
+ bodyOffset: record.offset,
425
+ bodySize: record.size,
426
+ options: decodePermutationOptions(effectRes.m_permutations, permutationIndex),
427
+ tableIndexMatchesPermutationIndex: Number.isInteger(record.index) ? record.index === permutationIndex : true
428
+ }];
429
+ }
430
+ function collectStages(effectDescription, selection) {
431
+ const stages = [];
432
+ const errors = [];
433
+ for (const technique of effectDescription.techniques ?? []) {
434
+ if (selection.technique && technique.name !== selection.technique) {
435
+ continue;
436
+ }
437
+ if (!selection.stage && !Number.isInteger(selection.pass) && technique.passes.length === 0) {
438
+ errors.push(`${technique.name} declares no passes`);
439
+ }
440
+ for (let passIndex = 0; passIndex < technique.passes.length; passIndex++) {
441
+ if (Number.isInteger(selection.pass) && passIndex !== selection.pass) {
442
+ continue;
443
+ }
444
+ const pass = technique.passes[passIndex];
445
+ let declaredStageCount = 0;
446
+ for (let stageType = 0; stageType < HlslRenderContextEnum.SHADER_TYPE_COUNT; stageType++) {
447
+ const stageInput = pass.stageInputs[stageType];
448
+ if (!stageInput?.m_exists) {
449
+ continue;
450
+ }
451
+ declaredStageCount++;
452
+ const stageName = hlslShaderStageName(stageType);
453
+ if (selection.stage && stageName !== selection.stage) {
454
+ continue;
455
+ }
456
+ if (!stageInput.cjsShaderBytecode) {
457
+ errors.push(`${technique.name}.pass${passIndex}.${stageName} declares shader handle ` + `${stageInput.m_shader ?? "unknown"} but has no shader bytecode`);
458
+ continue;
459
+ }
460
+ stages.push({
461
+ key: `${technique.name}.pass${passIndex}.${stageName}`,
462
+ techniqueName: technique.name,
463
+ passIndex,
464
+ stageType,
465
+ stageName,
466
+ shaderHandle: stageInput.m_shader,
467
+ bytecode: stageInput.cjsShaderBytecode,
468
+ pipelineInputs: cloneJson(stageInput.signature?.pipelineInputs ?? []),
469
+ registers: cloneJson(stageInput.signature?.registers ?? []),
470
+ resources: mapToJson(stageInput.resources),
471
+ samplers: mapToJson(stageInput.samplers),
472
+ uavs: mapToJson(stageInput.uavs),
473
+ constants: cloneJson(stageInput.constants ?? []),
474
+ // Recognised from reflection here, applied by the emitter.
475
+ // The recogniser is shared with WebGPU so both backends
476
+ // merge exactly the same registers.
477
+ detailMapArray: recogniseDetailMapFamily(mapToJson(stageInput.resources)),
478
+ localLights: recogniseLocalLightFamily(mapToJson(stageInput.resources))
479
+ });
480
+ }
481
+ if (!selection.stage && declaredStageCount === 0) {
482
+ errors.push(`${technique.name}.pass${passIndex} declares no shader stages`);
483
+ }
484
+ }
485
+ }
486
+ return {
487
+ stages,
488
+ errors
489
+ };
490
+ }
491
+
492
+ /** Local-light lowering modes this packager accepts. */
493
+ const LOCAL_LIGHT_MODES = Object.freeze(["none", "packed-texture", "constant-buffer", "drop"]);
494
+
495
+ /** How `LightProfileArray` is treated. */
496
+ const LIGHT_PROFILE_MODES = Object.freeze(["drop", "keep"]);
497
+
498
+ /**
499
+ * Normalizes the light-profile mode.
500
+ *
501
+ * @param {string|undefined|null} value Requested mode.
502
+ * @returns {string} Normalized mode.
503
+ */
504
+ function normalizeLightProfileMode(value) {
505
+ const mode = value === undefined || value === null ? "drop" : String(value);
506
+ if (!LIGHT_PROFILE_MODES.includes(mode)) {
507
+ throw new TypeError(`Carbon WebGL lightProfile must be one of ${LIGHT_PROFILE_MODES.join(", ")}; got "${mode}"`);
508
+ }
509
+ return mode;
510
+ }
511
+
512
+ /**
513
+ * Emitter options that drop `LightProfileArray` and neutralise its samples.
514
+ *
515
+ * Only applies when the local-light family is left alone. `packed-texture`,
516
+ * `constant-buffer` and `drop` each already decide what happens to the profile
517
+ * register, and asking for it twice would either be redundant or fight them.
518
+ *
519
+ * @param {object|null} plan Recognised local-light family, if any.
520
+ * @param {string} localLightMode Normalized local-light mode.
521
+ * @param {string} profileMode Normalized light-profile mode.
522
+ * @returns {object|null} Emitter options, or null when nothing to do.
523
+ */
524
+ function lightProfileEmitterOptions(plan, localLightMode, profileMode) {
525
+ if (profileMode !== "drop" || localLightMode !== "none") return null;
526
+ if (!Number.isInteger(plan?.profileRegister)) return null;
527
+ return {
528
+ neutralResourceRegisters: [plan.profileRegister]
529
+ };
530
+ }
531
+
532
+ /**
533
+ * Normalizes the local-light lowering mode.
534
+ *
535
+ * @param {string|undefined|null} value Requested mode.
536
+ * @returns {string} Normalized mode.
537
+ */
538
+ function normalizeLocalLightMode(value) {
539
+ if (value === undefined || value === null) return "none";
540
+ const mode = String(value);
541
+ if (!LOCAL_LIGHT_MODES.includes(mode)) {
542
+ throw new TypeError(`Carbon WebGL localLights must be one of ${LOCAL_LIGHT_MODES.join(", ")}; got "${mode}"`);
543
+ }
544
+ return mode;
545
+ }
546
+
547
+ /**
548
+ * Builds the emitter profile that lowers a recognised local-light family.
549
+ *
550
+ * Carbon's local lights are two structured buffers plus an optional profile
551
+ * texture. WebGL 2 has no structured buffers, so one of these lowerings is
552
+ * required for the shader to bind its lights at all; WebGPU needs none of it and
553
+ * binds them natively.
554
+ *
555
+ * The constants here match the CLI packager's resolvers exactly, so the two
556
+ * pipelines produce identical output while they still both exist. They are not
557
+ * endorsements: `dataTexelBase` and `capacity` are values that happened to work,
558
+ * and the constant-buffer route is known to fail on light count.
559
+ *
560
+ * @param {object} plan Recognised local-light family.
561
+ * @param {string} mode Lowering mode.
562
+ * @returns {object|null} Emitter options fragment, or null when not lowering.
563
+ */
564
+ function localLightEmitterOptions(plan, mode) {
565
+ if (!plan || mode === "none") return null;
566
+ if (mode === "drop") {
567
+ // No lighting at all: the declarations go and every read lowers to zero.
568
+ // Kept because isolating a lighting problem is easier without lights,
569
+ // not because the texture budget needs it any more.
570
+ return {
571
+ stubResourceRegisters: plan.registers
572
+ };
573
+ }
574
+ if (mode === "packed-texture") {
575
+ return {
576
+ lightPackedTexture: {
577
+ indexRegister: plan.indexRegister,
578
+ dataRegister: plan.dataRegister,
579
+ profileRegister: plan.profileRegister,
580
+ registerIndex: plan.indexRegister,
581
+ name: "cjsLocalLightTexture",
582
+ dataTexelBase: 131072
583
+ }
584
+ };
585
+ }
586
+ if (mode === "constant-buffer") {
587
+ // Slot 6 is `g_uiTransforms` in the constant-buffer slot contract. There
588
+ // is no collision on space-object shaders, which carry no UI transforms,
589
+ // but this is squatting on a reserved number and should move.
590
+ return {
591
+ lightConstantBuffer: {
592
+ indexRegister: plan.indexRegister,
593
+ dataRegister: plan.dataRegister,
594
+ profileRegister: plan.profileRegister,
595
+ registerIndex: 6,
596
+ name: "cb6",
597
+ capacity: 40
598
+ }
599
+ };
600
+ }
601
+ throw new Error(`Unknown local-light lowering mode "${mode}"`);
602
+ }
603
+ function translateStages(shaderMap, stageMap, values) {
604
+ const emitInto = (record, pairVaryings) => {
605
+ try {
606
+ const profileNeutral = lightProfileEmitterOptions(record.localLights, values.localLights, values.lightProfile);
607
+ // Remembered on the record so the body set can emit the resource
608
+ // transform that accounts for the dropped resource. The transform's
609
+ // identity includes the pass key, which is not known here.
610
+ if (profileNeutral) record.lightProfileNeutral = record.localLights;
611
+ const result = emitGlslWithOptions(record.bytes, {
612
+ ...values.emitterOptions,
613
+ source: `${values.source}#${record.firstStageKey}`,
614
+ ...(pairVaryings?.length ? {
615
+ pairVaryings
616
+ } : {}),
617
+ ...(record.detailMapArray ? {
618
+ detailMapArrayRegisters: record.detailMapArray.registers
619
+ } : {}),
620
+ ...(localLightEmitterOptions(record.localLights, values.localLights) ?? {}),
621
+ ...(profileNeutral ?? {})
622
+ });
623
+ const stageInterface = normalizeBitangentStageInterface(result, record);
624
+ record.emit = {
625
+ ...result,
626
+ source: stageInterface.source,
627
+ inputs: stageInterface.inputs
628
+ };
629
+ record.source = stageInterface.source;
630
+ record.bindings = result.bindings;
631
+ record.stageInputs = stageInterface.inputs;
632
+ record.stageOutputs = result.outputs;
633
+ record.emitWarnings = result.warnings;
634
+ record.translator = "dxbc-js-emitter";
635
+ record.hlsl2webgl = {
636
+ ok: true,
637
+ mode: "js-emitter"
638
+ };
639
+ if (result.stageName === "compute") {
640
+ record.computeFragment = result.computeFragment;
641
+ }
642
+ const issue = validateStageSourceShape(record);
643
+ if (issue) {
644
+ record.hlsl2webgl = {
645
+ ok: false,
646
+ validationError: issue
647
+ };
648
+ record.source = null;
649
+ }
650
+ } catch (error) {
651
+ const message = error?.message || String(error);
652
+ record.hlsl2webgl = {
653
+ ok: false,
654
+ error: message,
655
+ details: error?.details ?? null
656
+ };
657
+ if (/not supported|No GLSL lowering|unimplementable/iu.test(message)) {
658
+ record.excluded = {
659
+ reason: message,
660
+ ...(error?.details?.opcodeName ? {
661
+ opcodeName: error.details.opcodeName
662
+ } : {}),
663
+ ...(error?.details?.dimensionName ? {
664
+ dimensionName: error.details.dimensionName
665
+ } : {})
666
+ };
667
+ }
668
+ }
669
+ };
670
+ for (const record of shaderMap.values()) {
671
+ if (record.stageName !== "vertex") {
672
+ emitInto(record, null);
673
+ }
674
+ }
675
+ const pixelVaryingsByPass = new Map();
676
+ for (const stage of stageMap.values()) {
677
+ if (stage.stageName !== "pixel") {
678
+ continue;
679
+ }
680
+ const record = shaderMap.get(stage.shaderKey);
681
+ if (!record?.emit) {
682
+ continue;
683
+ }
684
+ pixelVaryingsByPass.set(`${stage.bodyKey}|${stage.techniqueName}|${stage.passIndex}`, record.emit.inputs.filter(input => typeof input.name === "string" && input.name.startsWith("vs_r")).map(input => input.register).sort((left, right) => left - right));
685
+ }
686
+ for (const stage of stageMap.values()) {
687
+ if (stage.stageName !== "vertex") {
688
+ continue;
689
+ }
690
+ const record = shaderMap.get(stage.shaderKey);
691
+ const varyings = pixelVaryingsByPass.get(`${stage.bodyKey}|${stage.techniqueName}|${stage.passIndex}`) ?? [];
692
+ if (record) {
693
+ record.pairVaryings = varyings;
694
+ emitInto(record, varyings);
695
+ }
696
+ }
697
+ }
698
+ function cloneJson(value) {
699
+ if (value === undefined || value === null) {
700
+ return value;
701
+ }
702
+ return JSON.parse(JSON.stringify(value));
703
+ }
704
+ function mapToJson(map) {
705
+ if (!(map instanceof Map)) {
706
+ return [];
707
+ }
708
+ return Array.from(map.entries()).map(([registerIndex, value]) => ({
709
+ registerIndex,
710
+ ...cloneJson(value)
711
+ }));
712
+ }
713
+ function buildStageContract(stage) {
714
+ const pipelineInputs = cloneJson(stage.pipelineInputs ?? []);
715
+ const inputSemantics = pipelineInputs.map(input => ({
716
+ semantic: `${input.usageName || `USAGE_${input.usage}`}${input.usageIndex || ""}`,
717
+ usage: input.usage,
718
+ usageName: input.usageName,
719
+ usageIndex: input.usageIndex,
720
+ registerIndex: input.registerIndex,
721
+ usedMask: input.usedMask,
722
+ type: input.type,
723
+ dimension: input.dimension
724
+ }));
725
+ const inputNames = new Set(inputSemantics.map(input => input.usageName));
726
+ const hasNormal = inputNames.has("NORMAL");
727
+ const hasTangent = inputNames.has("TANGENT");
728
+ const hasBinormal = inputNames.has("BINORMAL") || inputNames.has("BITANGENT");
729
+ const hasBlendIndices = inputNames.has("BLENDINDICES") || inputNames.has("BLENDINDICE");
730
+ let tangentContract = "none";
731
+ if (hasNormal && hasTangent && hasBinormal) {
732
+ tangentContract = "split_tbn";
733
+ } else if (!hasNormal && hasTangent) {
734
+ tangentContract = "packed_tangent_or_tangent_only";
735
+ } else if (hasNormal || hasTangent || hasBinormal) {
736
+ tangentContract = "partial_tbn";
737
+ }
738
+ const resources = cloneJson(stage.resources ?? []);
739
+ const samplers = cloneJson(stage.samplers ?? []);
740
+ const uavs = cloneJson(stage.uavs ?? []);
741
+ const constants = cloneJson(stage.constants ?? []);
742
+ const resourceNames = resources.map(entry => entry.name).filter(Boolean);
743
+ return {
744
+ stageName: stage.stageName,
745
+ stageType: stage.stageType,
746
+ vertex: stage.stageName === "vertex" ? {
747
+ inputs: inputSemantics,
748
+ tangentContract,
749
+ requiresSplitTbn: tangentContract === "split_tbn",
750
+ requiresPackedTangent: tangentContract === "packed_tangent_or_tangent_only",
751
+ requiresSkinning: hasBlendIndices || resourceNames.includes("BoneTransforms"),
752
+ hasBlendIndices
753
+ } : null,
754
+ texturePacking: classifyTexturePacking(resourceNames),
755
+ constantBuffers: (stage.registers ?? []).filter(entry => entry.registerType === 0).map(entry => ({
756
+ registerIndex: entry.registerIndex,
757
+ registerSpace: entry.registerSpace,
758
+ registerCount: entry.registerCount,
759
+ arrayCount: entry.arrayCount,
760
+ dynamic: Boolean(entry.dynamic)
761
+ })),
762
+ resources,
763
+ samplers,
764
+ uavs,
765
+ constants
766
+ };
767
+ }
768
+ function classifyTexturePacking(names) {
769
+ const values = new Set(names);
770
+ if (["NoMap", "PmdgMap", "ArMap"].some(name => values.has(name))) {
771
+ return "packed_textures";
772
+ }
773
+ if (["NormalMap", "RoughnessMap", "MaterialMap", "AlbedoMap", "AoMap", "PaintMaskMap"].some(name => values.has(name))) {
774
+ return "unpacked_textures";
775
+ }
776
+ return "unknown";
777
+ }
778
+ function mergeShaderContracts(contracts) {
779
+ const first = contracts?.[0]?.contract ?? null;
780
+ if (!first) {
781
+ return null;
782
+ }
783
+ return {
784
+ stageName: first.stageName,
785
+ stageType: first.stageType,
786
+ vertex: first.vertex ? cloneJson(first.vertex) : null,
787
+ texturePacking: first.texturePacking,
788
+ constantBuffers: cloneJson(first.constantBuffers ?? []),
789
+ resourceNames: (first.resources ?? []).map(entry => entry.name).filter(Boolean),
790
+ samplerNames: (first.samplers ?? []).map(entry => entry.name).filter(Boolean),
791
+ sharedByStageCount: contracts.length
792
+ };
793
+ }
794
+ function normalizeBitangentStageInterface(result, shaderRecord) {
795
+ if (shaderRecord?.stageName !== "vertex") {
796
+ return {
797
+ source: result.source,
798
+ inputs: result.inputs
799
+ };
800
+ }
801
+ const bitangentRegisters = new Set((shaderRecord.contracts ?? []).flatMap(entry => entry.contract?.vertex?.inputs ?? []).filter(input => input.usageName === "BITANGENT").map(input => input.registerIndex));
802
+ let source = result.source;
803
+ const inputs = result.inputs.map(input => {
804
+ if (!bitangentRegisters.has(input.register) || input.semanticName !== "BINORMAL") {
805
+ return input;
806
+ }
807
+ const name = `in_BITANGENT${input.semanticIndex}`;
808
+ source = source.replaceAll(input.name, name);
809
+ return {
810
+ ...input,
811
+ name,
812
+ semanticName: "BITANGENT"
813
+ };
814
+ });
815
+ return {
816
+ source,
817
+ inputs
818
+ };
819
+ }
820
+ function validateStageSourceShape(record) {
821
+ const source = record?.source ?? "";
822
+ if (!source) {
823
+ return null;
824
+ }
825
+ const hasVertexOutput = /\bgl_Position\b/u.test(source);
826
+ const hasVertexInterface = /\bin\s+(?:lowp|mediump|highp)?\s*\w+\s+attr\d+\b/u.test(source) || /\bout\s+(?:lowp|mediump|highp)?\s*\w+\s+vs_TEXCOORD\d+\b/u.test(source) || /\bin_[A-Z]+[0-9]+\b/u.test(source);
827
+ const hasFragmentOutput = /\bout\s+(?:lowp|mediump|highp)?\s*vec4\s+SV_Target\d+\b/u.test(source) || /\bgl_FragColor\b/u.test(source);
828
+ if (record.stageName === "vertex" && !hasVertexOutput) {
829
+ return "vertex stage source does not write gl_Position";
830
+ }
831
+ if (record.stageName === "pixel" && (hasVertexOutput || hasVertexInterface) && !hasFragmentOutput) {
832
+ return "pixel stage source looks like vertex GLSL";
833
+ }
834
+ if (record.stageName === "compute" && !/\bcjsUav\d+(_s\d+)?\b/u.test(source)) {
835
+ return "compute stage source does not write any cjsUav output";
836
+ }
837
+ return null;
838
+ }
839
+ function normalizeSourceIdentity(values) {
840
+ const identity = values.sourceIdentity;
841
+ if (identity !== null && (!identity || typeof identity !== "object" || Array.isArray(identity))) {
842
+ throw new TypeError("Carbon WebGL sourceIdentity must be an object");
843
+ }
844
+ const sha256 = sha256Bytes(values.sourceBytes);
845
+ if (identity?.sha256 !== undefined && identity?.sha256 !== null && identity.sha256 !== sha256) {
846
+ throw new Error("Carbon WebGL sourceIdentity.sha256 does not match the exact effect input bytes");
847
+ }
848
+ return Object.freeze({
849
+ filePath: identity?.filePath ?? values.source,
850
+ logicalPath: identity?.logicalPath ?? values.source,
851
+ game: identity?.game ?? null,
852
+ client: identity?.client ?? null,
853
+ build: identity?.build === undefined || identity?.build === null ? null : String(identity.build),
854
+ byteLength: values.sourceBytes.byteLength,
855
+ md5: identity?.md5 ?? null,
856
+ sha256
857
+ });
858
+ }
859
+ function qualifyEffectPackage({
860
+ info,
861
+ metadata,
862
+ glsl,
863
+ failedShaders,
864
+ excludedShaders,
865
+ failedBodies,
866
+ rasterCompleteness,
867
+ availableShaderCount
868
+ }) {
869
+ const errors = [];
870
+ if (info.format !== "CARBON_WEBGL" || glsl.format !== "CARBON_WEBGL_GLSL_SET") {
871
+ errors.push("invalid Carbon WebGL package envelope");
872
+ }
873
+ if (!Array.isArray(metadata.variants) || !Array.isArray(glsl.shaders)) {
874
+ errors.push("missing Carbon WebGL graph arrays");
875
+ }
876
+ if (failedShaders.length) {
877
+ errors.push(`${failedShaders.length} shader translation(s) failed`);
878
+ }
879
+ if (excludedShaders.length) {
880
+ errors.push(`${excludedShaders.length} shader translation(s) are unsupported`);
881
+ }
882
+ if (failedBodies.length) {
883
+ errors.push(`${failedBodies.length} effect body/bodies failed`);
884
+ }
885
+ if (rasterCompleteness.incompletePasses.length) {
886
+ errors.push(`${rasterCompleteness.incompletePasses.length} raster pass(es) are incomplete`);
887
+ }
888
+ if (!availableShaderCount) {
889
+ errors.push("no translated shaders are available");
890
+ }
891
+ return {
892
+ ok: errors.length === 0,
893
+ level: errors.length ? "diagnostic" : "structural",
894
+ errors: Object.freeze(errors),
895
+ incompletePasses: Object.freeze(rasterCompleteness.incompletePasses)
896
+ };
897
+ }
898
+
899
+ export { buildEffectPackage };
900
+ //# sourceMappingURL=effectPackage.js.map