@carbonenginejs/runtime-resource 0.13.0 → 0.14.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 (453) 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 +675 -675
  288. package/dist/resource/geometry/TriGeometryResAreaData.js +59 -59
  289. package/dist/resource/geometry/TriGeometryResJointData.js +38 -38
  290. package/dist/resource/geometry/TriGeometryResLodData.js +88 -88
  291. package/dist/resource/geometry/TriGeometryResMeshData.js +63 -63
  292. package/dist/resource/geometry/TriGeometryResSkeletonData.js +34 -34
  293. package/dist/resource/geometry/TriJointBinding.js +38 -38
  294. package/dist/resource/geometry/TriMorphTargetGeometryConstants.js +46 -46
  295. package/dist/resource/geometry/TriRtGeometryConstants.js +88 -88
  296. package/dist/resource/geometry/granny/GStateBindingCallbackData.js +31 -31
  297. package/dist/resource/geometry/granny/Tr2GrannyIntersectionResult.js +60 -60
  298. package/dist/resource/geometry/granny/Tr2GrannyStateRes.js +36 -36
  299. package/dist/resource/geometry/granny/TriGrannyRes.js +35 -35
  300. package/dist/resource/geometry/granny/enums.js +10 -10
  301. package/dist/resource/geometry/granny/index.js +6 -6
  302. package/dist/resource/geometry/index.js +17 -17
  303. package/dist/resource/index.js +54 -54
  304. package/dist/resource/resourceBoundary.js +64 -64
  305. package/dist/resource/shader/Tr2EffectRes.js +336 -336
  306. package/dist/resource/shader/Tr2MaterialArea.js +31 -31
  307. package/dist/resource/shader/Tr2MaterialMesh.js +27 -27
  308. package/dist/resource/shader/Tr2MaterialRes.js +31 -31
  309. package/dist/resource/shader/Tr2Shader.js +283 -283
  310. package/dist/resource/shader/Tr2ShaderPermutation.js +43 -43
  311. package/dist/resource/shader/index.js +17 -17
  312. package/dist/resource/shader/reflection/Tr2EffectConstant.js +143 -143
  313. package/dist/resource/shader/reflection/Tr2EffectDefine.js +30 -30
  314. package/dist/resource/shader/reflection/Tr2EffectDescription.js +114 -114
  315. package/dist/resource/shader/reflection/Tr2EffectLibrary.js +168 -168
  316. package/dist/resource/shader/reflection/Tr2EffectParameterAnnotation.js +125 -125
  317. package/dist/resource/shader/reflection/Tr2EffectResource.js +120 -120
  318. package/dist/resource/shader/reflection/Tr2EffectStageInput.js +372 -372
  319. package/dist/resource/shader/reflection/Tr2EffectTechnique.js +78 -78
  320. package/dist/resource/shader/reflection/Tr2Pass.js +168 -168
  321. package/dist/resource/shader/reflection/carbonRecordFields.js +159 -159
  322. package/dist/resource/shader/reflection/shaderStage.js +22 -22
  323. package/dist/resource/shader/sampler/Tr2SamplerSetup.js +135 -135
  324. package/dist/resource/texture/CjsTextureArrayRes.js +472 -472
  325. package/dist/resource/texture/CjsTextureArrayResParameterProxy.js +179 -179
  326. package/dist/resource/texture/Tr2ImageRes.js +120 -120
  327. package/dist/resource/texture/Tr2TextureLodManager.js +82 -82
  328. package/dist/resource/texture/Tr2TextureLodUpdateRequest.js +37 -37
  329. package/dist/resource/texture/Tr2TexturePackChannel.js +37 -37
  330. package/dist/resource/texture/Tr2TexturePipeline.js +54 -54
  331. package/dist/resource/texture/Tr2TexturePipelineParams.js +34 -34
  332. package/dist/resource/texture/Tr2TexturePipelineStepCompress.js +40 -40
  333. package/dist/resource/texture/Tr2TexturePipelineStepGenerateMips.js +22 -22
  334. package/dist/resource/texture/Tr2TexturePipelineStepLimitSize.js +34 -34
  335. package/dist/resource/texture/Tr2TexturePipelineStepLoad.js +31 -31
  336. package/dist/resource/texture/Tr2TexturePipelineStepPack.js +43 -43
  337. package/dist/resource/texture/TriTextureRes.js +359 -359
  338. package/dist/resource/texture/index.js +15 -15
  339. package/dist/resource/texture/texturePipelineBehavior.js +308 -308
  340. package/dist/worker/CjsResManMainThreadLoader.js +89 -89
  341. package/dist/worker/CjsResManWorker.js +218 -218
  342. package/dist/worker/CjsResManWorkerLoader.js +437 -437
  343. package/dist/worker/protocol.js +12 -12
  344. package/docs/README.md +98 -98
  345. package/docs/architecture.md +118 -118
  346. package/docs/concepts/resource-lifecycle.md +226 -226
  347. package/docs/concepts/shader-resource-model.md +111 -111
  348. package/docs/concepts/writing-an-engine-adapter.md +115 -115
  349. package/docs/formats/README.md +138 -138
  350. package/docs/formats/carbon-effect-container.md +553 -553
  351. package/docs/formats/dxbc/README.md +68 -68
  352. package/docs/formats/dxbc/architecture.md +80 -80
  353. package/docs/formats/dxbc/reference/api.md +105 -77
  354. package/docs/formats/dxbc/reference/classes/README.md +9 -9
  355. package/docs/formats/dxbc/reference/decoded-output.md +122 -122
  356. package/docs/formats/gr2.md +160 -160
  357. package/docs/formats/hlsl/README.md +54 -54
  358. package/docs/formats/hlsl/architecture.md +66 -65
  359. package/docs/formats/hlsl/guides/hydrating-json-output.md +60 -60
  360. package/docs/formats/hlsl/guides/reading-effects.md +68 -64
  361. package/docs/formats/hlsl/reference/advanced-analysis.md +61 -61
  362. package/docs/formats/hlsl/reference/api.md +91 -92
  363. package/docs/formats/hlsl/reference/classes/README.md +11 -11
  364. package/docs/formats/hlsl/reference/json-graph.md +97 -97
  365. package/docs/formats/pickle.md +82 -82
  366. package/docs/formats/provenance.md +196 -196
  367. package/docs/formats/stl.md +37 -37
  368. package/docs/formats/webgl/README.md +115 -115
  369. package/docs/formats/webgl/architecture.md +69 -69
  370. package/docs/formats/webgl/carbon-constant-layouts.md +326 -326
  371. package/docs/formats/webgl/decl-io.md +1234 -1234
  372. package/docs/formats/webgl/memory-structured.md +890 -890
  373. package/docs/formats/webgl/reference/classes/README.md +9 -9
  374. package/docs/formats/webgl/texture-sample.md +964 -964
  375. package/docs/formats/webgpu/README.md +84 -84
  376. package/docs/formats/webgpu/architecture.md +95 -95
  377. package/docs/formats/webgpu/formats/carbon-webgpu.md +215 -215
  378. package/docs/formats/webgpu/guides/effect-packaging.md +189 -189
  379. package/docs/formats/webgpu/reference/api.md +196 -196
  380. package/docs/formats/webgpu/reference/classes/README.md +9 -9
  381. package/docs/formats/webgpu/reference/wgsl-compatibility.md +1546 -1546
  382. package/docs/formats/wwise.md +146 -146
  383. package/docs/reference/classes/README.md +35 -35
  384. package/docs/reference/classes/audio.md +30 -30
  385. package/docs/reference/classes/core.md +216 -216
  386. package/docs/reference/classes/dropped.md +46 -46
  387. package/docs/reference/classes/formats.md +944 -944
  388. package/docs/reference/classes/resources.md +456 -456
  389. package/docs/reference/classes/texture.md +26 -26
  390. package/docs/reference/events.md +117 -117
  391. package/docs/reference/motherlode-cache.md +275 -275
  392. package/docs/reference/queues.md +194 -194
  393. package/docs/reference/reload.md +107 -107
  394. package/docs/reference/texture-arrays.md +113 -113
  395. package/docs/reference/texture-pipeline.md +53 -53
  396. package/docs/reference/workers.md +142 -142
  397. package/docs/roadmap.md +150 -150
  398. package/format-notices/black/LICENSE +21 -21
  399. package/format-notices/black/NOTICE +47 -47
  400. package/format-notices/bnk/LICENSE +21 -21
  401. package/format-notices/bnk/NOTICE +21 -21
  402. package/format-notices/cmf/LICENSE +21 -21
  403. package/format-notices/cmf/NOTICE +36 -36
  404. package/format-notices/dds/LICENSE +21 -21
  405. package/format-notices/dds/NOTICE +14 -14
  406. package/format-notices/dxbc/LICENSE +21 -21
  407. package/format-notices/dxbc/NOTICE +20 -20
  408. package/format-notices/fbx/LICENSE +21 -21
  409. package/format-notices/fbx/NOTICE +14 -14
  410. package/format-notices/flac/LICENSE +21 -21
  411. package/format-notices/flac/NOTICE +14 -14
  412. package/format-notices/gif/LICENSE +21 -21
  413. package/format-notices/gif/NOTICE +14 -14
  414. package/format-notices/gltf/LICENSE +21 -21
  415. package/format-notices/gltf/NOTICE +27 -27
  416. package/format-notices/gr2/LICENSE +21 -21
  417. package/format-notices/gr2/NOTICE +60 -60
  418. package/format-notices/gr2/THIRD-PARTY-NOTICES.md +93 -93
  419. package/format-notices/hlsl/LICENSE +21 -21
  420. package/format-notices/hlsl/NOTICE +25 -25
  421. package/format-notices/jpeg/LICENSE +21 -21
  422. package/format-notices/jpeg/NOTICE +14 -14
  423. package/format-notices/mp3/LICENSE +21 -21
  424. package/format-notices/mp3/NOTICE +14 -14
  425. package/format-notices/mp4/LICENSE +21 -21
  426. package/format-notices/mp4/NOTICE +14 -14
  427. package/format-notices/obj/LICENSE +21 -21
  428. package/format-notices/obj/NOTICE +26 -26
  429. package/format-notices/ogg/LICENSE +21 -21
  430. package/format-notices/ogg/NOTICE +28 -28
  431. package/format-notices/png/LICENSE +21 -21
  432. package/format-notices/png/NOTICE +14 -14
  433. package/format-notices/red/LICENSE +21 -21
  434. package/format-notices/red/NOTICE +31 -31
  435. package/format-notices/stl/LICENSE +21 -21
  436. package/format-notices/stl/NOTICE +21 -21
  437. package/format-notices/tga/LICENSE +21 -21
  438. package/format-notices/tga/NOTICE +14 -14
  439. package/format-notices/wav/LICENSE +21 -21
  440. package/format-notices/wav/NOTICE +14 -14
  441. package/format-notices/webgl/LICENSE +21 -21
  442. package/format-notices/webgl/NOTICE +35 -35
  443. package/format-notices/webgpu/LICENSE +21 -21
  444. package/format-notices/webgpu/NOTICE +31 -31
  445. package/format-notices/webm/LICENSE +21 -21
  446. package/format-notices/webm/NOTICE +14 -14
  447. package/format-notices/webp/LICENSE +21 -21
  448. package/format-notices/webp/NOTICE +14 -14
  449. package/format-notices/wem/LICENSE +57 -57
  450. package/format-notices/wem/NOTICE +33 -33
  451. package/format-notices/yaml/LICENSE +21 -21
  452. package/format-notices/yaml/NOTICE +44 -44
  453. package/package.json +63 -63
@@ -1,801 +1,801 @@
1
- import { CjsEventEmitter } from '@carbonenginejs/runtime-utils/model';
2
- import { normalizeResourcePath, normalizeResourceExtension, getResourceExtension } from '@carbonenginejs/runtime-utils/path';
3
- import { CjsSchema, carbon, impl, type } from '@carbonenginejs/runtime-utils/schema';
4
- import { ResourceHandlerMode } from './ResourceHandlerMode.js';
5
-
6
- /**
7
- * Deterministic activity values accepted by resource-facing lease methods.
8
- *
9
- * @typedef {object} CjsResourceActivityOptions
10
- * @property {number} [frame] Explicit non-negative activity frame.
11
- * @property {number} [time] Explicit non-negative activity timestamp in milliseconds.
12
- */
13
-
14
- /**
15
- * Manager-owned callbacks attached while a resource has canonical ownership,
16
- * and detached the moment it ends. The controller carries no load, fetch, or
17
- * prepare hook; recovery lives in the separate reload hook, which deliberately
18
- * outlives ownership because losing ownership is exactly when it is needed.
19
- *
20
- * @typedef {object} CjsResourceLifecycleController
21
- * @property {Function} [isCurrent] Tests exact canonical manager ownership without renewing activity.
22
- * @property {Function} [keepAlive] Renews canonical identity activity.
23
- * @property {Function} [keepPayloadAlive] Renews identity and CPU-payload activity.
24
- * @property {Function} [lock] Adds one inactivity-purge lock and returns its count.
25
- * @property {Function} [unlock] Releases one inactivity-purge lock and returns its count.
26
- */
27
-
28
- /**
29
- * ResMan-owned runtime resource.
30
- *
31
- * Resources are not model graph objects: BLACK/RED graphs persist resource
32
- * paths (including empty paths), while CjsResMan constructs, initializes,
33
- * caches, and hydrates the corresponding runtime resource instances.
34
- */
35
- class CjsResource extends CjsEventEmitter {
36
- #payload = null;
37
-
38
- /** Reloads attempted since the last successful load. */
39
- #reloadAttempts = 0;
40
-
41
- /**
42
- * How many times a purged or failed resource reloads itself before giving up.
43
- *
44
- * Per class so a subclass can be more or less patient. Counted per resource
45
- * and reset on every successful load, so this bounds consecutive failures,
46
- * not the lifetime total.
47
- */
48
- static maxReloadAttempts = 3;
49
- path = "";
50
- ext = "";
51
- requirement = "";
52
- state = CjsResource.State.EMPTY;
53
-
54
- /**
55
- * Identifies this class as a runtime resource.
56
- *
57
- * Static, so a schema field declared as `@type.objectRef("TriGeometryRes")`
58
- * can be known to hold a resource without an instance existing - the
59
- * declaration alone is enough, resolved through `CjsSchema.GetConstructor`.
60
- */
61
- static isResource = true;
62
-
63
- /** Declares that extension routes using this handler publish the resource. */
64
- static handlerMode = ResourceHandlerMode.RESOURCE;
65
-
66
- /** Identifies this handle as a runtime resource. */
67
- get isResource() {
68
- return this.constructor.isResource === true;
69
- }
70
-
71
- /**
72
- * Create a detached runtime resource with empty identity and payload state.
73
- * Schema values are applied without attaching manager lifecycle callbacks;
74
- * CjsResMan supplies those callbacks after canonical insertion.
75
- *
76
- * @param {object|null} [values=null] Initial decorated schema-field values.
77
- */
78
- constructor(values = null) {
79
- super();
80
- Object.defineProperty(this, "__adapterResources", {
81
- value: Object.create(null),
82
- enumerable: false,
83
- configurable: true,
84
- writable: true
85
- });
86
- Object.defineProperty(this, "__objectLoader", {
87
- value: null,
88
- enumerable: false,
89
- configurable: true,
90
- writable: true
91
- });
92
- Object.defineProperty(this, "__objectRequest", {
93
- value: null,
94
- enumerable: false,
95
- configurable: true,
96
- writable: true
97
- });
98
- Object.defineProperty(this, "__lifecycleController", {
99
- value: null,
100
- enumerable: false,
101
- configurable: true,
102
- writable: true
103
- });
104
- Object.defineProperty(this, "__reloadHook", {
105
- value: null,
106
- enumerable: false,
107
- configurable: true,
108
- writable: true
109
- });
110
- if (values) {
111
- this.SetValues(values);
112
- }
113
- }
114
-
115
- /**
116
- * Apply resource identity or metadata values without model graph semantics.
117
- *
118
- * @param {object|null} values
119
- * @returns {CjsResource}
120
- */
121
- SetValues(values = null) {
122
- if (!values || typeof values !== "object") return this;
123
- const fields = CjsSchema.getSchema(this.constructor).fields;
124
- for (const field of fields) {
125
- if (Object.prototype.hasOwnProperty.call(values, field.name)) {
126
- this[field.name] = values[field.name];
127
- }
128
- }
129
- return this;
130
- }
131
-
132
- /**
133
- * Export resource identity and schema metadata. Runtime state is not a model
134
- * graph node; graph fields normally persist only their resource path.
135
- *
136
- * @returns {object}
137
- */
138
- GetValues() {
139
- const result = {};
140
- for (const field of CjsSchema.getSchema(this.constructor).fields) {
141
- result[field.name] = this[field.name];
142
- }
143
- return result;
144
- }
145
-
146
- /**
147
- * Initialize the resource identity from a path and optional extension.
148
- *
149
- * @param {string} path
150
- * @param {string|null} ext
151
- * @param {string|null} requirement
152
- * @returns {CjsResource}
153
- */
154
- Initialize(path, ext = null, requirement = "") {
155
- this.path = normalizeResourcePath(path);
156
- this.ext = ext ? normalizeResourceExtension(ext) : getResourceExtension(this.path);
157
- this.requirement = requirement === null || requirement === undefined ? "" : String(requirement).trim().toLowerCase();
158
- this.state = CjsResource.State.EMPTY;
159
- this.error = null;
160
- return this;
161
- }
162
-
163
- /**
164
- * Get the normalized resource path.
165
- *
166
- * @returns {string}
167
- */
168
- GetPath() {
169
- return this.path;
170
- }
171
-
172
- /**
173
- * Get the normalized resource extension.
174
- *
175
- * @returns {string}
176
- */
177
- GetExt() {
178
- return this.ext;
179
- }
180
-
181
- /**
182
- * Return the normalized semantic outcome requested from this source path.
183
- * This metadata query is pure and does not renew manager activity.
184
- *
185
- * @returns {string} Lowercase requirement name, or an empty string.
186
- */
187
- GetRequirement() {
188
- return this.requirement;
189
- }
190
-
191
- /**
192
- * Return true when the resource is currently loading.
193
- *
194
- * @returns {boolean}
195
- */
196
- IsLoading() {
197
- return this.state === CjsResource.State.REQUESTED || this.state === CjsResource.State.LOADING;
198
- }
199
-
200
- /**
201
- * Return true when CPU resource payload data has been loaded.
202
- *
203
- * @returns {boolean}
204
- */
205
- HasLoaded() {
206
- return this.state === CjsResource.State.LOADED || this.state === CjsResource.State.PREPARING || this.state === CjsResource.State.PREPARED;
207
- }
208
-
209
- /**
210
- * Return true when preparation has completed or produced a good resource.
211
- *
212
- * @returns {boolean}
213
- */
214
- IsPrepared() {
215
- return this.state === CjsResource.State.PREPARED;
216
- }
217
-
218
- /**
219
- * Return true when this resource finished trying to load, either way.
220
- *
221
- * The pull form of the `completed` event. Carbon expresses this as a
222
- * predicate because it has no events - `m_isPrepared` is set on the failure
223
- * path too (`BlueAsyncRes.cpp:183`) - so `IsPrepared()` there means "finished
224
- * trying" while ours keeps the narrower "succeeded".
225
- *
226
- * `PURGED` is not completion: nothing was tried and nothing concluded, the
227
- * payload was simply taken away.
228
- *
229
- * @returns {boolean}
230
- */
231
- HasCompleted() {
232
- return this.state === CjsResource.State.PREPARED || this.state === CjsResource.State.FAILED;
233
- }
234
-
235
- /**
236
- * Return true when preparation completed successfully, and renew this
237
- * resource.
238
- *
239
- * Every caller of `IsGood()` is about to use the resource, so renewal always
240
- * follows the query. Merging them - as ccpwgl does in `Tw2Resource.js:108` -
241
- * closes that gap permanently instead of relying on call-site discipline, and
242
- * means a purged resource reloads itself the moment anything asks for it.
243
- *
244
- * @returns {boolean}
245
- */
246
- IsGood() {
247
- this.KeepAlive();
248
- return this.IsPrepared();
249
- }
250
-
251
- /**
252
- * Return true when preparation failed.
253
- *
254
- * @returns {boolean}
255
- */
256
- IsFailed() {
257
- return this.state === CjsResource.State.FAILED;
258
- }
259
-
260
- /**
261
- * Changes state and emits the state-specific, statechange, and - on reaching
262
- * a load outcome - completed events.
263
- */
264
- SetState(state, ...details) {
265
- if (!CjsResource.isValidState(state)) {
266
- throw new TypeError(`Invalid CjsResource state: ${state}`);
267
- }
268
- const previous = this.state;
269
- if (previous === state) return this;
270
- this.state = state;
271
- // A successful load clears the budget, so the cap bounds consecutive
272
- // failures rather than how many times a resource may ever be purged.
273
- if (state === CjsResource.State.PREPARED) this.#reloadAttempts = 0;
274
- this.EmitEvent?.(state, this, ...details);
275
- this.EmitEvent?.("statechange", this, state, previous);
276
- // Fires again after a purge and reload, so subscribers rebuild whatever
277
- // they derived from the payload that was deleted.
278
- if (this.HasCompleted()) this.EmitEvent?.("completed", this, ...details);
279
- return this;
280
- }
281
-
282
- /**
283
- * Subscribe to this resource finishing, firing immediately when it already
284
- * has.
285
- *
286
- * The immediate call is the point. A plain emitter drops late subscribers on
287
- * the floor - subscribe after `PREPARED` and nothing ever arrives - which is
288
- * why callers end up doing work synchronously "just in case" instead of
289
- * subscribing. ccpwgl solves this by replaying current state at registration
290
- * (`Tw2Resource.onNotification`), and a subscriber satisfied that way is
291
- * never stored at all, so only subscriptions genuinely still waiting
292
- * accumulate.
293
- *
294
- * The listener runs for both outcomes and branches itself:
295
- *
296
- * ```js
297
- * res.OnCompleted(res => { if (res.IsPrepared()) something; else somethingElse; });
298
- * ```
299
- *
300
- * It may run more than once - a purge and reload completes again - so
301
- * handlers must be written to be re-entered rather than assuming first load.
302
- *
303
- * @param {Function} listener Called with this resource once it has finished.
304
- * @param {*} [source=null] Optional owner used for bulk removal.
305
- * @returns {CjsResource} This resource.
306
- */
307
- OnCompleted(listener, source = null) {
308
- if (typeof listener !== "function") {
309
- throw new TypeError("CjsResource.OnCompleted requires a function.");
310
- }
311
- if (this.HasCompleted()) {
312
- listener(this);
313
- return this;
314
- }
315
- return this.OnEvent("completed", listener, source);
316
- }
317
-
318
- /** Marks this resource as requested. */
319
- MarkRequested() {
320
- return this.SetState(CjsResource.State.REQUESTED);
321
- }
322
-
323
- /** Marks this resource as actively loading. */
324
- MarkLoading() {
325
- return this.SetState(CjsResource.State.LOADING);
326
- }
327
-
328
- /** Marks this resource's CPU payload as loaded. */
329
- MarkLoaded() {
330
- return this.SetState(CjsResource.State.LOADED);
331
- }
332
-
333
- /** Marks this resource as preparing its semantic result. */
334
- MarkPreparing() {
335
- return this.SetState(CjsResource.State.PREPARING);
336
- }
337
-
338
- /** Marks this resource as successfully prepared. */
339
- MarkPrepared() {
340
- return this.SetState(CjsResource.State.PREPARED);
341
- }
342
-
343
- /** Marks this resource as successfully prepared. */
344
- MarkGood() {
345
- return this.MarkPrepared();
346
- }
347
-
348
- /**
349
- * Mark this detached resource handle as purged after a successful
350
- * manager-owned policy eviction, such as inactivity or recorded-byte cache
351
- * pressure, released its adapter allocations and payload.
352
- *
353
- * @returns {CjsResource} This purged resource.
354
- */
355
- MarkPurged() {
356
- return this.SetState(CjsResource.State.PURGED);
357
- }
358
-
359
- /**
360
- * Return whether deterministic manager cleanup has purged this handle.
361
- * This is a pure state query and never renews resource activity.
362
- *
363
- * @returns {boolean} `true` when the current state is `PURGED`.
364
- */
365
- IsPurged() {
366
- return this.state === CjsResource.State.PURGED;
367
- }
368
-
369
- /** Stores a load failure and marks this resource as failed. */
370
- SetError(error) {
371
- this.error = error || null;
372
- return this.SetState(CjsResource.State.FAILED, this.error);
373
- }
374
-
375
- /**
376
- * Store the plain CPU payload associated with this resource.
377
- * Concrete resource classes validate the fields they require before calling
378
- * this method. If the compatibility `object` property still aliases the
379
- * previous payload, it is updated to the replacement; semantic resources
380
- * whose `object` points to the resource itself are unaffected. A non-null
381
- * payload explicitly renews its manager-owned identity and payload leases;
382
- * payload reads remain pure and do not renew either lease.
383
- *
384
- * @param {*} payload Plain reader/converter output, or `null` to clear it.
385
- * @returns {CjsResource} This resource with the supplied payload reference.
386
- */
387
- SetPayload(payload = null) {
388
- const previous = this.#payload;
389
- this.#payload = payload;
390
- if (this.object === previous) this.object = payload;
391
- if (this.HasPayload()) this.KeepPayloadAlive();
392
- return this;
393
- }
394
-
395
- /**
396
- * Read the plain CPU payload associated with this resource.
397
- *
398
- * The query is pure and does not renew the payload lease.
399
- *
400
- * @returns {*} Current payload reference, or `null` after release.
401
- */
402
- GetPayload() {
403
- return this.#payload;
404
- }
405
-
406
- /**
407
- * Return whether a payload has been explicitly assigned. This query is pure
408
- * and does not renew the payload lease.
409
- *
410
- * @returns {boolean} Whether a non-null payload is attached.
411
- */
412
- HasPayload() {
413
- return this.#payload !== null && this.#payload !== undefined;
414
- }
415
-
416
- /**
417
- * Release the complete payload reference after consumers have retained the
418
- * scalars and typed-array views they require. When the compatibility
419
- * `object` property still aliases that exact payload, it is cleared as part
420
- * of the same ownership release. Semantic resources whose `object` property
421
- * points to the resource itself are unaffected.
422
- *
423
- * @returns {CjsResource} This resource without its former payload reference.
424
- */
425
- ReleasePayload() {
426
- const payload = this.#payload;
427
- this.#payload = null;
428
- if (this.object === payload) this.object = null;
429
- return this;
430
- }
431
-
432
- /**
433
- * Bind or detach the manager callbacks used by explicit resource-facing
434
- * liveness operations. Runtime resources remain usable when unbound; their
435
- * liveness methods then become deterministic no-ops.
436
- *
437
- * @param {CjsResourceLifecycleController|null} controller Manager callbacks, or `null` after canonical ownership ends.
438
- * @returns {CjsResource} This resource.
439
- * @throws {TypeError} If the controller or any supplied callback is invalid.
440
- */
441
- SetLifecycleController(controller = null) {
442
- if (controller !== null && (typeof controller !== "object" || Array.isArray(controller))) {
443
- throw new TypeError("CjsResource lifecycle controller must be an object or null.");
444
- }
445
- for (const name of ["isCurrent", "keepAlive", "keepPayloadAlive", "lock", "unlock"]) {
446
- if (controller?.[name] !== undefined && typeof controller[name] !== "function") {
447
- throw new TypeError(`CjsResource lifecycle controller ${name} must be a function.`);
448
- }
449
- }
450
- this.__lifecycleController = controller;
451
- return this;
452
- }
453
-
454
- /**
455
- * Return whether this handle is still the manager's canonical resource.
456
- *
457
- * Engine adapters use this immediately before synchronously attaching a
458
- * completed backend candidate. Detached resources return `false`; the query
459
- * never renews activity, reloads data, or mutates lifecycle state.
460
- *
461
- * @returns {boolean} Whether the bound manager still owns this exact handle.
462
- */
463
- IsCurrent() {
464
- return Boolean(this.__lifecycleController?.isCurrent?.());
465
- }
466
-
467
- /**
468
- * Renew this resource's canonical identity activity, and reload it when
469
- * it has been purged.
470
- *
471
- * Purge is deletion - the payload is gone and nothing restores it - so
472
- * revival is an ordinary reload along the first-load path. Consumers
473
- * therefore never have to know a purge happened: they ask for what they need
474
- * and this makes it be there.
475
- *
476
- * `IsGood()` calls this, so most callers never invoke it directly.
477
- *
478
- * @param {CjsResourceActivityOptions} [options={}] Optional deterministic activity values.
479
- * @returns {CjsResource} This resource, whether bound or detached.
480
- * @throws {TypeError} If the bound manager rejects invalid activity values.
481
- */
482
- KeepAlive(options = {}) {
483
- this.__lifecycleController?.keepAlive?.(options);
484
- if (this.IsPurged()) this.Reload(options);
485
- return this;
486
- }
487
-
488
- /**
489
- * Re-register this handle with its manager and reload it into itself.
490
- *
491
- * Runs only from `PURGED` or `FAILED` - the two states where the payload is
492
- * absent but recoverable. It does nothing to a resource that is loaded or
493
- * still loading, so it is not a way to force a refetch of something already
494
- * there.
495
- *
496
- * Bounded by `maxReloadAttempts`, because `KeepAlive()` calls this and the
497
- * render path calls that every frame: without a cap, one missing texture
498
- * becomes a permanent retry storm against the thing least likely to succeed.
499
- * Attempts are spaced by real load round-trips rather than frames - starting
500
- * one leaves `PURGED`/`FAILED`, so nothing re-enters until it settles - and
501
- * the count resets on any successful load.
502
- *
503
- * The distinction that matters: the reload must fill THIS handle, not resolve
504
- * whatever the manager currently caches for the same path. A consumer holding
505
- * a purged handle has no way to discover a replacement, so handing it a fresh
506
- * instance elsewhere leaves it dead forever.
507
- *
508
- * Detached handles have no manager to re-register with and stay as they are.
509
- *
510
- * @param {CjsResourceActivityOptions} [options={}] Optional deterministic activity values.
511
- * @returns {boolean} Whether a reload was started.
512
- */
513
- Reload(options = {}) {
514
- if (!this.IsPurged() && !this.IsFailed()) return false;
515
- if (this.#reloadAttempts >= this.constructor.maxReloadAttempts) return false;
516
- if (typeof this.__reloadHook !== "function") return false;
517
- this.#reloadAttempts += 1;
518
- return this.__reloadHook(options) !== false;
519
- }
520
-
521
- /**
522
- * Bind the manager callback that restores this handle after it loses its
523
- * payload.
524
- *
525
- * Deliberately separate from the lifecycle controller, which is detached the
526
- * moment canonical ownership ends. Recovery has to survive exactly that
527
- * event: a purged handle with no route back to its manager is unrecoverable,
528
- * which is the failure this whole contract exists to prevent.
529
- *
530
- * @param {Function|null} hook Manager callback, or `null` to detach it.
531
- * @returns {CjsResource} This resource.
532
- * @throws {TypeError} If the hook is neither a function nor null.
533
- */
534
- SetReloadHook(hook = null) {
535
- if (hook !== null && typeof hook !== "function") {
536
- throw new TypeError("CjsResource.SetReloadHook requires a function or null.");
537
- }
538
- this.__reloadHook = hook;
539
- return this;
540
- }
541
-
542
- /**
543
- * Return how many reloads have been attempted since the last successful load.
544
- *
545
- * @returns {number}
546
- */
547
- GetReloadAttempts() {
548
- return this.#reloadAttempts;
549
- }
550
-
551
- /**
552
- * Clear the reload attempt count, so a resource that exhausted its attempts
553
- * can be asked again.
554
- *
555
- * This is the deliberate "try it again" gesture - a user retrying a failed
556
- * load, say. It is separate from `Reload()` because the cap exists precisely
557
- * to stop the automatic path retrying forever, so lifting it has to be a
558
- * decision someone made.
559
- *
560
- * @returns {CjsResource} This resource.
561
- */
562
- ResetReloadAttempts() {
563
- this.#reloadAttempts = 0;
564
- return this;
565
- }
566
-
567
- /**
568
- * Explicitly renew both canonical identity activity and the attached CPU
569
- * payload lease. Reading the payload through `GetPayload()` or
570
- * `HasPayload()` remains pure.
571
- *
572
- * @param {CjsResourceActivityOptions} [options={}] Optional deterministic activity values.
573
- * @returns {CjsResource} This resource, whether a payload exists or not.
574
- * @throws {TypeError} If the bound manager rejects invalid activity values.
575
- */
576
- KeepPayloadAlive(options = {}) {
577
- this.__lifecycleController?.keepPayloadAlive?.(options);
578
- return this;
579
- }
580
-
581
- /**
582
- * Add one explicit purge lock through the bound manager and renew identity
583
- * activity. Locking never reloads or prepares a resource.
584
- *
585
- * @returns {number} New lock count, or `0` when this resource is detached.
586
- */
587
- Lock() {
588
- return this.__lifecycleController?.lock?.() || 0;
589
- }
590
-
591
- /**
592
- * Release one explicit purge lock without allowing the count to underflow.
593
- * Unlocking does not immediately purge or release a payload.
594
- *
595
- * @returns {number} Remaining lock count, or `0` when detached or unlocked.
596
- */
597
- Unlock() {
598
- return this.__lifecycleController?.unlock?.() || 0;
599
- }
600
-
601
- /**
602
- * Bind the manager-owned object operation and compact reconstruction request
603
- * for this shared resource handle. The request contains source provenance
604
- * and requested-output defaults, not reader implementations or registry
605
- * history.
606
- *
607
- * @param {Function|null} loader Manager callback, or `null` to detach it.
608
- * @param {object|null} [request=null] Compact reconstruction defaults retained with the handle.
609
- * @returns {CjsResource} This resource with the supplied loader binding.
610
- * @throws {TypeError} If the loader or reconstruction request is invalid.
611
- */
612
- SetObjectLoader(loader = null, request = null) {
613
- if (loader !== null && typeof loader !== "function") {
614
- throw new TypeError("CjsResource.SetObjectLoader requires a function or null.");
615
- }
616
- if (request !== null && (!request || typeof request !== "object" || Array.isArray(request))) {
617
- throw new TypeError("CjsResource.SetObjectLoader request must be an object or null.");
618
- }
619
- this.__objectLoader = loader;
620
- this.__objectRequest = request === null ? null : Object.freeze({
621
- ...request
622
- });
623
- return this;
624
- }
625
-
626
- /**
627
- * Return the compact manager request retained for explicit reconstruction.
628
- * This query is pure and exposes no reader, constructor, or implementation
629
- * identity.
630
- *
631
- * @returns {Readonly<object>|null} Frozen reconstruction defaults, or `null` when unbound.
632
- */
633
- GetObjectRequest() {
634
- return this.__objectRequest;
635
- }
636
-
637
- /**
638
- * Return the manager-owned object outcome for this resource identity.
639
- * Concurrent callers share one in-flight operation. A resident payload is
640
- * returned without source work; after explicit payload release, this call is
641
- * an explicit reconstruction request and may load/prepare through the bound
642
- * manager. This loader resolves the manager's current canonical identity, so
643
- * on a purged handle it may answer with a different instance - use
644
- * `KeepAlive()`/`Reload()` to revive this handle itself.
645
- *
646
- * Promised-output fields retained by the handle take precedence over fields
647
- * supplied here; operation policy such as cache/reload controls may still be
648
- * overridden.
649
- *
650
- * @param {object} [options={}] Source, format, semantic outcome, and queue options forwarded to the manager.
651
- * @returns {Promise<*>} In-flight, resident, or reconstructed object outcome.
652
- */
653
- GetObject(options = {}) {
654
- if (!this.__objectLoader) {
655
- const error = new Error(`Resource has no object loader: ${this.path}`);
656
- error.code = "CJS_RESOURCE_LOADER_UNBOUND";
657
- return Promise.reject(error);
658
- }
659
- return this.__objectLoader(options);
660
- }
661
-
662
- /**
663
- * Promise-shaped alias for {@link CjsResource#GetObject}. Readiness shares an
664
- * in-flight operation, returns resident payload without loading, and treats a
665
- * call after payload release as an explicit reconstruction request.
666
- *
667
- * @param {object} [options={}] Source, format, semantic outcome, and queue options forwarded to the manager.
668
- * @returns {Promise<*>} In-flight, resident, or reconstructed object outcome.
669
- */
670
- Ready(options = {}) {
671
- return this.GetObject(options);
672
- }
673
-
674
- /**
675
- * Attach an opaque engine-owned resource object.
676
- *
677
- * Runtime-resource stores this value but does not inspect GPU APIs.
678
- *
679
- * @param {string} key
680
- * @param {*} value
681
- * @returns {CjsResource}
682
- */
683
- SetAdapterResource(key, value) {
684
- if (!key) throw new TypeError("CjsResource.SetAdapterResource requires a key.");
685
- this.__adapterResources[String(key)] = value;
686
- return this;
687
- }
688
-
689
- /**
690
- * Get an opaque engine-owned resource object.
691
- *
692
- * @param {string} key
693
- * @returns {*}
694
- */
695
- GetAdapterResource(key) {
696
- return this.__adapterResources[String(key)] ?? null;
697
- }
698
-
699
- /**
700
- * Returns true when an adapter resource exists for the given key.
701
- *
702
- * @param {string} key
703
- * @returns {boolean}
704
- */
705
- HasAdapterResource(key) {
706
- return Object.prototype.hasOwnProperty.call(this.__adapterResources, String(key));
707
- }
708
-
709
- /**
710
- * Remove an adapter resource and optionally call its destroy/dispose method.
711
- *
712
- * @param {string} key
713
- * @param {object} options
714
- * @returns {CjsResource}
715
- */
716
- DestroyAdapterResource(key, options = {}) {
717
- const name = String(key);
718
- const value = this.__adapterResources[name];
719
- if (value && options.destroy !== false) {
720
- destroyAdapterValue(value);
721
- }
722
- delete this.__adapterResources[name];
723
- return this;
724
- }
725
-
726
- /**
727
- * Remove all adapter resources and optionally call their destroy/dispose methods.
728
- *
729
- * @param {object} options
730
- * @returns {CjsResource}
731
- */
732
- DestroyAdapterResources(options = {}) {
733
- for (const key of Object.keys(this.__adapterResources)) {
734
- this.DestroyAdapterResource(key, options);
735
- }
736
- return this;
737
- }
738
- static State = Object.freeze({
739
- EMPTY: "empty",
740
- REQUESTED: "requested",
741
- LOADING: "loading",
742
- LOADED: "loaded",
743
- PREPARING: "preparing",
744
- PREPARED: "prepared",
745
- FAILED: "failed",
746
- UNLOADED: "unloaded",
747
- PURGED: "purged"
748
- });
749
-
750
- /** Returns true when a value belongs to the resource state vocabulary. */
751
- static isValidState(state) {
752
- return Object.values(CjsResource.State).includes(state);
753
- }
754
-
755
- /**
756
- * Returns true when a resource state cannot continue its current operation.
757
- *
758
- * `PURGED` is deliberately absent: a purged resource reloads itself
759
- * through `KeepAlive()`, so purge is a transition out of a settled state
760
- * rather than a resting place.
761
- */
762
- static isTerminalState(state) {
763
- return state === CjsResource.State.PREPARED || state === CjsResource.State.FAILED || state === CjsResource.State.UNLOADED;
764
- }
765
- }
766
-
767
- // Declared as data rather than with decorators, so the resource tree stays
768
- // plain ESM that loads from source without a transform. Resources are not model
769
- // graph nodes - there is no Copy or Clone here, and SetValues/GetValues are a
770
- // flat schema-driven property copy - so nothing here needed the decorator form.
771
- // Field order is key order, and GetValues() exports in that order.
772
- CjsSchema.define(CjsResource, {
773
- className: "CjsResource",
774
- family: "resource",
775
- fields: {
776
- path: type.path,
777
- ext: type.string,
778
- requirement: type.string,
779
- state: type.string
780
- },
781
- methods: {
782
- Initialize: [carbon.method, impl.adapted],
783
- GetPath: [carbon.method, impl.adapted],
784
- GetExt: [carbon.method, impl.adapted],
785
- IsLoading: [carbon.method, impl.adapted],
786
- HasLoaded: [carbon.method, impl.adapted],
787
- IsPrepared: [carbon.method, impl.adapted],
788
- IsGood: [carbon.method, impl.adapted],
789
- IsFailed: [carbon.method, impl.adapted]
790
- }
791
- });
792
- function destroyAdapterValue(value) {
793
- if (!value || typeof value !== "object") return;
794
- const destroy = value.Destroy || value.Dispose || value.destroy || value.dispose;
795
- if (typeof destroy === "function") {
796
- destroy.call(value);
797
- }
798
- }
799
-
800
- export { CjsResource };
801
- //# sourceMappingURL=CjsResource.js.map
1
+ import { CjsEventEmitter } from '@carbonenginejs/runtime-utils/model';
2
+ import { normalizeResourcePath, normalizeResourceExtension, getResourceExtension } from '@carbonenginejs/runtime-utils/path';
3
+ import { CjsSchema, carbon, impl, type } from '@carbonenginejs/runtime-utils/schema';
4
+ import { ResourceHandlerMode } from './ResourceHandlerMode.js';
5
+
6
+ /**
7
+ * Deterministic activity values accepted by resource-facing lease methods.
8
+ *
9
+ * @typedef {object} CjsResourceActivityOptions
10
+ * @property {number} [frame] Explicit non-negative activity frame.
11
+ * @property {number} [time] Explicit non-negative activity timestamp in milliseconds.
12
+ */
13
+
14
+ /**
15
+ * Manager-owned callbacks attached while a resource has canonical ownership,
16
+ * and detached the moment it ends. The controller carries no load, fetch, or
17
+ * prepare hook; recovery lives in the separate reload hook, which deliberately
18
+ * outlives ownership because losing ownership is exactly when it is needed.
19
+ *
20
+ * @typedef {object} CjsResourceLifecycleController
21
+ * @property {Function} [isCurrent] Tests exact canonical manager ownership without renewing activity.
22
+ * @property {Function} [keepAlive] Renews canonical identity activity.
23
+ * @property {Function} [keepPayloadAlive] Renews identity and CPU-payload activity.
24
+ * @property {Function} [lock] Adds one inactivity-purge lock and returns its count.
25
+ * @property {Function} [unlock] Releases one inactivity-purge lock and returns its count.
26
+ */
27
+
28
+ /**
29
+ * ResMan-owned runtime resource.
30
+ *
31
+ * Resources are not model graph objects: BLACK/RED graphs persist resource
32
+ * paths (including empty paths), while CjsResMan constructs, initializes,
33
+ * caches, and hydrates the corresponding runtime resource instances.
34
+ */
35
+ class CjsResource extends CjsEventEmitter {
36
+ #payload = null;
37
+
38
+ /** Reloads attempted since the last successful load. */
39
+ #reloadAttempts = 0;
40
+
41
+ /**
42
+ * How many times a purged or failed resource reloads itself before giving up.
43
+ *
44
+ * Per class so a subclass can be more or less patient. Counted per resource
45
+ * and reset on every successful load, so this bounds consecutive failures,
46
+ * not the lifetime total.
47
+ */
48
+ static maxReloadAttempts = 3;
49
+ path = "";
50
+ ext = "";
51
+ requirement = "";
52
+ state = CjsResource.State.EMPTY;
53
+
54
+ /**
55
+ * Identifies this class as a runtime resource.
56
+ *
57
+ * Static, so a schema field declared as `@type.objectRef("TriGeometryRes")`
58
+ * can be known to hold a resource without an instance existing - the
59
+ * declaration alone is enough, resolved through `CjsSchema.GetConstructor`.
60
+ */
61
+ static isResource = true;
62
+
63
+ /** Declares that extension routes using this handler publish the resource. */
64
+ static handlerMode = ResourceHandlerMode.RESOURCE;
65
+
66
+ /** Identifies this handle as a runtime resource. */
67
+ get isResource() {
68
+ return this.constructor.isResource === true;
69
+ }
70
+
71
+ /**
72
+ * Create a detached runtime resource with empty identity and payload state.
73
+ * Schema values are applied without attaching manager lifecycle callbacks;
74
+ * CjsResMan supplies those callbacks after canonical insertion.
75
+ *
76
+ * @param {object|null} [values=null] Initial decorated schema-field values.
77
+ */
78
+ constructor(values = null) {
79
+ super();
80
+ Object.defineProperty(this, "__adapterResources", {
81
+ value: Object.create(null),
82
+ enumerable: false,
83
+ configurable: true,
84
+ writable: true
85
+ });
86
+ Object.defineProperty(this, "__objectLoader", {
87
+ value: null,
88
+ enumerable: false,
89
+ configurable: true,
90
+ writable: true
91
+ });
92
+ Object.defineProperty(this, "__objectRequest", {
93
+ value: null,
94
+ enumerable: false,
95
+ configurable: true,
96
+ writable: true
97
+ });
98
+ Object.defineProperty(this, "__lifecycleController", {
99
+ value: null,
100
+ enumerable: false,
101
+ configurable: true,
102
+ writable: true
103
+ });
104
+ Object.defineProperty(this, "__reloadHook", {
105
+ value: null,
106
+ enumerable: false,
107
+ configurable: true,
108
+ writable: true
109
+ });
110
+ if (values) {
111
+ this.SetValues(values);
112
+ }
113
+ }
114
+
115
+ /**
116
+ * Apply resource identity or metadata values without model graph semantics.
117
+ *
118
+ * @param {object|null} values
119
+ * @returns {CjsResource}
120
+ */
121
+ SetValues(values = null) {
122
+ if (!values || typeof values !== "object") return this;
123
+ const fields = CjsSchema.getSchema(this.constructor).fields;
124
+ for (const field of fields) {
125
+ if (Object.prototype.hasOwnProperty.call(values, field.name)) {
126
+ this[field.name] = values[field.name];
127
+ }
128
+ }
129
+ return this;
130
+ }
131
+
132
+ /**
133
+ * Export resource identity and schema metadata. Runtime state is not a model
134
+ * graph node; graph fields normally persist only their resource path.
135
+ *
136
+ * @returns {object}
137
+ */
138
+ GetValues() {
139
+ const result = {};
140
+ for (const field of CjsSchema.getSchema(this.constructor).fields) {
141
+ result[field.name] = this[field.name];
142
+ }
143
+ return result;
144
+ }
145
+
146
+ /**
147
+ * Initialize the resource identity from a path and optional extension.
148
+ *
149
+ * @param {string} path
150
+ * @param {string|null} ext
151
+ * @param {string|null} requirement
152
+ * @returns {CjsResource}
153
+ */
154
+ Initialize(path, ext = null, requirement = "") {
155
+ this.path = normalizeResourcePath(path);
156
+ this.ext = ext ? normalizeResourceExtension(ext) : getResourceExtension(this.path);
157
+ this.requirement = requirement === null || requirement === undefined ? "" : String(requirement).trim().toLowerCase();
158
+ this.state = CjsResource.State.EMPTY;
159
+ this.error = null;
160
+ return this;
161
+ }
162
+
163
+ /**
164
+ * Get the normalized resource path.
165
+ *
166
+ * @returns {string}
167
+ */
168
+ GetPath() {
169
+ return this.path;
170
+ }
171
+
172
+ /**
173
+ * Get the normalized resource extension.
174
+ *
175
+ * @returns {string}
176
+ */
177
+ GetExt() {
178
+ return this.ext;
179
+ }
180
+
181
+ /**
182
+ * Return the normalized semantic outcome requested from this source path.
183
+ * This metadata query is pure and does not renew manager activity.
184
+ *
185
+ * @returns {string} Lowercase requirement name, or an empty string.
186
+ */
187
+ GetRequirement() {
188
+ return this.requirement;
189
+ }
190
+
191
+ /**
192
+ * Return true when the resource is currently loading.
193
+ *
194
+ * @returns {boolean}
195
+ */
196
+ IsLoading() {
197
+ return this.state === CjsResource.State.REQUESTED || this.state === CjsResource.State.LOADING;
198
+ }
199
+
200
+ /**
201
+ * Return true when CPU resource payload data has been loaded.
202
+ *
203
+ * @returns {boolean}
204
+ */
205
+ HasLoaded() {
206
+ return this.state === CjsResource.State.LOADED || this.state === CjsResource.State.PREPARING || this.state === CjsResource.State.PREPARED;
207
+ }
208
+
209
+ /**
210
+ * Return true when preparation has completed or produced a good resource.
211
+ *
212
+ * @returns {boolean}
213
+ */
214
+ IsPrepared() {
215
+ return this.state === CjsResource.State.PREPARED;
216
+ }
217
+
218
+ /**
219
+ * Return true when this resource finished trying to load, either way.
220
+ *
221
+ * The pull form of the `completed` event. Carbon expresses this as a
222
+ * predicate because it has no events - `m_isPrepared` is set on the failure
223
+ * path too (`BlueAsyncRes.cpp:183`) - so `IsPrepared()` there means "finished
224
+ * trying" while ours keeps the narrower "succeeded".
225
+ *
226
+ * `PURGED` is not completion: nothing was tried and nothing concluded, the
227
+ * payload was simply taken away.
228
+ *
229
+ * @returns {boolean}
230
+ */
231
+ HasCompleted() {
232
+ return this.state === CjsResource.State.PREPARED || this.state === CjsResource.State.FAILED;
233
+ }
234
+
235
+ /**
236
+ * Return true when preparation completed successfully, and renew this
237
+ * resource.
238
+ *
239
+ * Every caller of `IsGood()` is about to use the resource, so renewal always
240
+ * follows the query. Merging them - as ccpwgl does in `Tw2Resource.js:108` -
241
+ * closes that gap permanently instead of relying on call-site discipline, and
242
+ * means a purged resource reloads itself the moment anything asks for it.
243
+ *
244
+ * @returns {boolean}
245
+ */
246
+ IsGood() {
247
+ this.KeepAlive();
248
+ return this.IsPrepared();
249
+ }
250
+
251
+ /**
252
+ * Return true when preparation failed.
253
+ *
254
+ * @returns {boolean}
255
+ */
256
+ IsFailed() {
257
+ return this.state === CjsResource.State.FAILED;
258
+ }
259
+
260
+ /**
261
+ * Changes state and emits the state-specific, statechange, and - on reaching
262
+ * a load outcome - completed events.
263
+ */
264
+ SetState(state, ...details) {
265
+ if (!CjsResource.isValidState(state)) {
266
+ throw new TypeError(`Invalid CjsResource state: ${state}`);
267
+ }
268
+ const previous = this.state;
269
+ if (previous === state) return this;
270
+ this.state = state;
271
+ // A successful load clears the budget, so the cap bounds consecutive
272
+ // failures rather than how many times a resource may ever be purged.
273
+ if (state === CjsResource.State.PREPARED) this.#reloadAttempts = 0;
274
+ this.EmitEvent?.(state, this, ...details);
275
+ this.EmitEvent?.("statechange", this, state, previous);
276
+ // Fires again after a purge and reload, so subscribers rebuild whatever
277
+ // they derived from the payload that was deleted.
278
+ if (this.HasCompleted()) this.EmitEvent?.("completed", this, ...details);
279
+ return this;
280
+ }
281
+
282
+ /**
283
+ * Subscribe to this resource finishing, firing immediately when it already
284
+ * has.
285
+ *
286
+ * The immediate call is the point. A plain emitter drops late subscribers on
287
+ * the floor - subscribe after `PREPARED` and nothing ever arrives - which is
288
+ * why callers end up doing work synchronously "just in case" instead of
289
+ * subscribing. ccpwgl solves this by replaying current state at registration
290
+ * (`Tw2Resource.onNotification`), and a subscriber satisfied that way is
291
+ * never stored at all, so only subscriptions genuinely still waiting
292
+ * accumulate.
293
+ *
294
+ * The listener runs for both outcomes and branches itself:
295
+ *
296
+ * ```js
297
+ * res.OnCompleted(res => { if (res.IsPrepared()) something; else somethingElse; });
298
+ * ```
299
+ *
300
+ * It may run more than once - a purge and reload completes again - so
301
+ * handlers must be written to be re-entered rather than assuming first load.
302
+ *
303
+ * @param {Function} listener Called with this resource once it has finished.
304
+ * @param {*} [source=null] Optional owner used for bulk removal.
305
+ * @returns {CjsResource} This resource.
306
+ */
307
+ OnCompleted(listener, source = null) {
308
+ if (typeof listener !== "function") {
309
+ throw new TypeError("CjsResource.OnCompleted requires a function.");
310
+ }
311
+ if (this.HasCompleted()) {
312
+ listener(this);
313
+ return this;
314
+ }
315
+ return this.OnEvent("completed", listener, source);
316
+ }
317
+
318
+ /** Marks this resource as requested. */
319
+ MarkRequested() {
320
+ return this.SetState(CjsResource.State.REQUESTED);
321
+ }
322
+
323
+ /** Marks this resource as actively loading. */
324
+ MarkLoading() {
325
+ return this.SetState(CjsResource.State.LOADING);
326
+ }
327
+
328
+ /** Marks this resource's CPU payload as loaded. */
329
+ MarkLoaded() {
330
+ return this.SetState(CjsResource.State.LOADED);
331
+ }
332
+
333
+ /** Marks this resource as preparing its semantic result. */
334
+ MarkPreparing() {
335
+ return this.SetState(CjsResource.State.PREPARING);
336
+ }
337
+
338
+ /** Marks this resource as successfully prepared. */
339
+ MarkPrepared() {
340
+ return this.SetState(CjsResource.State.PREPARED);
341
+ }
342
+
343
+ /** Marks this resource as successfully prepared. */
344
+ MarkGood() {
345
+ return this.MarkPrepared();
346
+ }
347
+
348
+ /**
349
+ * Mark this detached resource handle as purged after a successful
350
+ * manager-owned policy eviction, such as inactivity or recorded-byte cache
351
+ * pressure, released its adapter allocations and payload.
352
+ *
353
+ * @returns {CjsResource} This purged resource.
354
+ */
355
+ MarkPurged() {
356
+ return this.SetState(CjsResource.State.PURGED);
357
+ }
358
+
359
+ /**
360
+ * Return whether deterministic manager cleanup has purged this handle.
361
+ * This is a pure state query and never renews resource activity.
362
+ *
363
+ * @returns {boolean} `true` when the current state is `PURGED`.
364
+ */
365
+ IsPurged() {
366
+ return this.state === CjsResource.State.PURGED;
367
+ }
368
+
369
+ /** Stores a load failure and marks this resource as failed. */
370
+ SetError(error) {
371
+ this.error = error || null;
372
+ return this.SetState(CjsResource.State.FAILED, this.error);
373
+ }
374
+
375
+ /**
376
+ * Store the plain CPU payload associated with this resource.
377
+ * Concrete resource classes validate the fields they require before calling
378
+ * this method. If the compatibility `object` property still aliases the
379
+ * previous payload, it is updated to the replacement; semantic resources
380
+ * whose `object` points to the resource itself are unaffected. A non-null
381
+ * payload explicitly renews its manager-owned identity and payload leases;
382
+ * payload reads remain pure and do not renew either lease.
383
+ *
384
+ * @param {*} payload Plain reader/converter output, or `null` to clear it.
385
+ * @returns {CjsResource} This resource with the supplied payload reference.
386
+ */
387
+ SetPayload(payload = null) {
388
+ const previous = this.#payload;
389
+ this.#payload = payload;
390
+ if (this.object === previous) this.object = payload;
391
+ if (this.HasPayload()) this.KeepPayloadAlive();
392
+ return this;
393
+ }
394
+
395
+ /**
396
+ * Read the plain CPU payload associated with this resource.
397
+ *
398
+ * The query is pure and does not renew the payload lease.
399
+ *
400
+ * @returns {*} Current payload reference, or `null` after release.
401
+ */
402
+ GetPayload() {
403
+ return this.#payload;
404
+ }
405
+
406
+ /**
407
+ * Return whether a payload has been explicitly assigned. This query is pure
408
+ * and does not renew the payload lease.
409
+ *
410
+ * @returns {boolean} Whether a non-null payload is attached.
411
+ */
412
+ HasPayload() {
413
+ return this.#payload !== null && this.#payload !== undefined;
414
+ }
415
+
416
+ /**
417
+ * Release the complete payload reference after consumers have retained the
418
+ * scalars and typed-array views they require. When the compatibility
419
+ * `object` property still aliases that exact payload, it is cleared as part
420
+ * of the same ownership release. Semantic resources whose `object` property
421
+ * points to the resource itself are unaffected.
422
+ *
423
+ * @returns {CjsResource} This resource without its former payload reference.
424
+ */
425
+ ReleasePayload() {
426
+ const payload = this.#payload;
427
+ this.#payload = null;
428
+ if (this.object === payload) this.object = null;
429
+ return this;
430
+ }
431
+
432
+ /**
433
+ * Bind or detach the manager callbacks used by explicit resource-facing
434
+ * liveness operations. Runtime resources remain usable when unbound; their
435
+ * liveness methods then become deterministic no-ops.
436
+ *
437
+ * @param {CjsResourceLifecycleController|null} controller Manager callbacks, or `null` after canonical ownership ends.
438
+ * @returns {CjsResource} This resource.
439
+ * @throws {TypeError} If the controller or any supplied callback is invalid.
440
+ */
441
+ SetLifecycleController(controller = null) {
442
+ if (controller !== null && (typeof controller !== "object" || Array.isArray(controller))) {
443
+ throw new TypeError("CjsResource lifecycle controller must be an object or null.");
444
+ }
445
+ for (const name of ["isCurrent", "keepAlive", "keepPayloadAlive", "lock", "unlock"]) {
446
+ if (controller?.[name] !== undefined && typeof controller[name] !== "function") {
447
+ throw new TypeError(`CjsResource lifecycle controller ${name} must be a function.`);
448
+ }
449
+ }
450
+ this.__lifecycleController = controller;
451
+ return this;
452
+ }
453
+
454
+ /**
455
+ * Return whether this handle is still the manager's canonical resource.
456
+ *
457
+ * Engine adapters use this immediately before synchronously attaching a
458
+ * completed backend candidate. Detached resources return `false`; the query
459
+ * never renews activity, reloads data, or mutates lifecycle state.
460
+ *
461
+ * @returns {boolean} Whether the bound manager still owns this exact handle.
462
+ */
463
+ IsCurrent() {
464
+ return Boolean(this.__lifecycleController?.isCurrent?.());
465
+ }
466
+
467
+ /**
468
+ * Renew this resource's canonical identity activity, and reload it when
469
+ * it has been purged.
470
+ *
471
+ * Purge is deletion - the payload is gone and nothing restores it - so
472
+ * revival is an ordinary reload along the first-load path. Consumers
473
+ * therefore never have to know a purge happened: they ask for what they need
474
+ * and this makes it be there.
475
+ *
476
+ * `IsGood()` calls this, so most callers never invoke it directly.
477
+ *
478
+ * @param {CjsResourceActivityOptions} [options={}] Optional deterministic activity values.
479
+ * @returns {CjsResource} This resource, whether bound or detached.
480
+ * @throws {TypeError} If the bound manager rejects invalid activity values.
481
+ */
482
+ KeepAlive(options = {}) {
483
+ this.__lifecycleController?.keepAlive?.(options);
484
+ if (this.IsPurged()) this.Reload(options);
485
+ return this;
486
+ }
487
+
488
+ /**
489
+ * Re-register this handle with its manager and reload it into itself.
490
+ *
491
+ * Runs only from `PURGED` or `FAILED` - the two states where the payload is
492
+ * absent but recoverable. It does nothing to a resource that is loaded or
493
+ * still loading, so it is not a way to force a refetch of something already
494
+ * there.
495
+ *
496
+ * Bounded by `maxReloadAttempts`, because `KeepAlive()` calls this and the
497
+ * render path calls that every frame: without a cap, one missing texture
498
+ * becomes a permanent retry storm against the thing least likely to succeed.
499
+ * Attempts are spaced by real load round-trips rather than frames - starting
500
+ * one leaves `PURGED`/`FAILED`, so nothing re-enters until it settles - and
501
+ * the count resets on any successful load.
502
+ *
503
+ * The distinction that matters: the reload must fill THIS handle, not resolve
504
+ * whatever the manager currently caches for the same path. A consumer holding
505
+ * a purged handle has no way to discover a replacement, so handing it a fresh
506
+ * instance elsewhere leaves it dead forever.
507
+ *
508
+ * Detached handles have no manager to re-register with and stay as they are.
509
+ *
510
+ * @param {CjsResourceActivityOptions} [options={}] Optional deterministic activity values.
511
+ * @returns {boolean} Whether a reload was started.
512
+ */
513
+ Reload(options = {}) {
514
+ if (!this.IsPurged() && !this.IsFailed()) return false;
515
+ if (this.#reloadAttempts >= this.constructor.maxReloadAttempts) return false;
516
+ if (typeof this.__reloadHook !== "function") return false;
517
+ this.#reloadAttempts += 1;
518
+ return this.__reloadHook(options) !== false;
519
+ }
520
+
521
+ /**
522
+ * Bind the manager callback that restores this handle after it loses its
523
+ * payload.
524
+ *
525
+ * Deliberately separate from the lifecycle controller, which is detached the
526
+ * moment canonical ownership ends. Recovery has to survive exactly that
527
+ * event: a purged handle with no route back to its manager is unrecoverable,
528
+ * which is the failure this whole contract exists to prevent.
529
+ *
530
+ * @param {Function|null} hook Manager callback, or `null` to detach it.
531
+ * @returns {CjsResource} This resource.
532
+ * @throws {TypeError} If the hook is neither a function nor null.
533
+ */
534
+ SetReloadHook(hook = null) {
535
+ if (hook !== null && typeof hook !== "function") {
536
+ throw new TypeError("CjsResource.SetReloadHook requires a function or null.");
537
+ }
538
+ this.__reloadHook = hook;
539
+ return this;
540
+ }
541
+
542
+ /**
543
+ * Return how many reloads have been attempted since the last successful load.
544
+ *
545
+ * @returns {number}
546
+ */
547
+ GetReloadAttempts() {
548
+ return this.#reloadAttempts;
549
+ }
550
+
551
+ /**
552
+ * Clear the reload attempt count, so a resource that exhausted its attempts
553
+ * can be asked again.
554
+ *
555
+ * This is the deliberate "try it again" gesture - a user retrying a failed
556
+ * load, say. It is separate from `Reload()` because the cap exists precisely
557
+ * to stop the automatic path retrying forever, so lifting it has to be a
558
+ * decision someone made.
559
+ *
560
+ * @returns {CjsResource} This resource.
561
+ */
562
+ ResetReloadAttempts() {
563
+ this.#reloadAttempts = 0;
564
+ return this;
565
+ }
566
+
567
+ /**
568
+ * Explicitly renew both canonical identity activity and the attached CPU
569
+ * payload lease. Reading the payload through `GetPayload()` or
570
+ * `HasPayload()` remains pure.
571
+ *
572
+ * @param {CjsResourceActivityOptions} [options={}] Optional deterministic activity values.
573
+ * @returns {CjsResource} This resource, whether a payload exists or not.
574
+ * @throws {TypeError} If the bound manager rejects invalid activity values.
575
+ */
576
+ KeepPayloadAlive(options = {}) {
577
+ this.__lifecycleController?.keepPayloadAlive?.(options);
578
+ return this;
579
+ }
580
+
581
+ /**
582
+ * Add one explicit purge lock through the bound manager and renew identity
583
+ * activity. Locking never reloads or prepares a resource.
584
+ *
585
+ * @returns {number} New lock count, or `0` when this resource is detached.
586
+ */
587
+ Lock() {
588
+ return this.__lifecycleController?.lock?.() || 0;
589
+ }
590
+
591
+ /**
592
+ * Release one explicit purge lock without allowing the count to underflow.
593
+ * Unlocking does not immediately purge or release a payload.
594
+ *
595
+ * @returns {number} Remaining lock count, or `0` when detached or unlocked.
596
+ */
597
+ Unlock() {
598
+ return this.__lifecycleController?.unlock?.() || 0;
599
+ }
600
+
601
+ /**
602
+ * Bind the manager-owned object operation and compact reconstruction request
603
+ * for this shared resource handle. The request contains source provenance
604
+ * and requested-output defaults, not reader implementations or registry
605
+ * history.
606
+ *
607
+ * @param {Function|null} loader Manager callback, or `null` to detach it.
608
+ * @param {object|null} [request=null] Compact reconstruction defaults retained with the handle.
609
+ * @returns {CjsResource} This resource with the supplied loader binding.
610
+ * @throws {TypeError} If the loader or reconstruction request is invalid.
611
+ */
612
+ SetObjectLoader(loader = null, request = null) {
613
+ if (loader !== null && typeof loader !== "function") {
614
+ throw new TypeError("CjsResource.SetObjectLoader requires a function or null.");
615
+ }
616
+ if (request !== null && (!request || typeof request !== "object" || Array.isArray(request))) {
617
+ throw new TypeError("CjsResource.SetObjectLoader request must be an object or null.");
618
+ }
619
+ this.__objectLoader = loader;
620
+ this.__objectRequest = request === null ? null : Object.freeze({
621
+ ...request
622
+ });
623
+ return this;
624
+ }
625
+
626
+ /**
627
+ * Return the compact manager request retained for explicit reconstruction.
628
+ * This query is pure and exposes no reader, constructor, or implementation
629
+ * identity.
630
+ *
631
+ * @returns {Readonly<object>|null} Frozen reconstruction defaults, or `null` when unbound.
632
+ */
633
+ GetObjectRequest() {
634
+ return this.__objectRequest;
635
+ }
636
+
637
+ /**
638
+ * Return the manager-owned object outcome for this resource identity.
639
+ * Concurrent callers share one in-flight operation. A resident payload is
640
+ * returned without source work; after explicit payload release, this call is
641
+ * an explicit reconstruction request and may load/prepare through the bound
642
+ * manager. This loader resolves the manager's current canonical identity, so
643
+ * on a purged handle it may answer with a different instance - use
644
+ * `KeepAlive()`/`Reload()` to revive this handle itself.
645
+ *
646
+ * Promised-output fields retained by the handle take precedence over fields
647
+ * supplied here; operation policy such as cache/reload controls may still be
648
+ * overridden.
649
+ *
650
+ * @param {object} [options={}] Source, format, semantic outcome, and queue options forwarded to the manager.
651
+ * @returns {Promise<*>} In-flight, resident, or reconstructed object outcome.
652
+ */
653
+ GetObject(options = {}) {
654
+ if (!this.__objectLoader) {
655
+ const error = new Error(`Resource has no object loader: ${this.path}`);
656
+ error.code = "CJS_RESOURCE_LOADER_UNBOUND";
657
+ return Promise.reject(error);
658
+ }
659
+ return this.__objectLoader(options);
660
+ }
661
+
662
+ /**
663
+ * Promise-shaped alias for {@link CjsResource#GetObject}. Readiness shares an
664
+ * in-flight operation, returns resident payload without loading, and treats a
665
+ * call after payload release as an explicit reconstruction request.
666
+ *
667
+ * @param {object} [options={}] Source, format, semantic outcome, and queue options forwarded to the manager.
668
+ * @returns {Promise<*>} In-flight, resident, or reconstructed object outcome.
669
+ */
670
+ Ready(options = {}) {
671
+ return this.GetObject(options);
672
+ }
673
+
674
+ /**
675
+ * Attach an opaque engine-owned resource object.
676
+ *
677
+ * Runtime-resource stores this value but does not inspect GPU APIs.
678
+ *
679
+ * @param {string} key
680
+ * @param {*} value
681
+ * @returns {CjsResource}
682
+ */
683
+ SetAdapterResource(key, value) {
684
+ if (!key) throw new TypeError("CjsResource.SetAdapterResource requires a key.");
685
+ this.__adapterResources[String(key)] = value;
686
+ return this;
687
+ }
688
+
689
+ /**
690
+ * Get an opaque engine-owned resource object.
691
+ *
692
+ * @param {string} key
693
+ * @returns {*}
694
+ */
695
+ GetAdapterResource(key) {
696
+ return this.__adapterResources[String(key)] ?? null;
697
+ }
698
+
699
+ /**
700
+ * Returns true when an adapter resource exists for the given key.
701
+ *
702
+ * @param {string} key
703
+ * @returns {boolean}
704
+ */
705
+ HasAdapterResource(key) {
706
+ return Object.prototype.hasOwnProperty.call(this.__adapterResources, String(key));
707
+ }
708
+
709
+ /**
710
+ * Remove an adapter resource and optionally call its destroy/dispose method.
711
+ *
712
+ * @param {string} key
713
+ * @param {object} options
714
+ * @returns {CjsResource}
715
+ */
716
+ DestroyAdapterResource(key, options = {}) {
717
+ const name = String(key);
718
+ const value = this.__adapterResources[name];
719
+ if (value && options.destroy !== false) {
720
+ destroyAdapterValue(value);
721
+ }
722
+ delete this.__adapterResources[name];
723
+ return this;
724
+ }
725
+
726
+ /**
727
+ * Remove all adapter resources and optionally call their destroy/dispose methods.
728
+ *
729
+ * @param {object} options
730
+ * @returns {CjsResource}
731
+ */
732
+ DestroyAdapterResources(options = {}) {
733
+ for (const key of Object.keys(this.__adapterResources)) {
734
+ this.DestroyAdapterResource(key, options);
735
+ }
736
+ return this;
737
+ }
738
+ static State = Object.freeze({
739
+ EMPTY: "empty",
740
+ REQUESTED: "requested",
741
+ LOADING: "loading",
742
+ LOADED: "loaded",
743
+ PREPARING: "preparing",
744
+ PREPARED: "prepared",
745
+ FAILED: "failed",
746
+ UNLOADED: "unloaded",
747
+ PURGED: "purged"
748
+ });
749
+
750
+ /** Returns true when a value belongs to the resource state vocabulary. */
751
+ static isValidState(state) {
752
+ return Object.values(CjsResource.State).includes(state);
753
+ }
754
+
755
+ /**
756
+ * Returns true when a resource state cannot continue its current operation.
757
+ *
758
+ * `PURGED` is deliberately absent: a purged resource reloads itself
759
+ * through `KeepAlive()`, so purge is a transition out of a settled state
760
+ * rather than a resting place.
761
+ */
762
+ static isTerminalState(state) {
763
+ return state === CjsResource.State.PREPARED || state === CjsResource.State.FAILED || state === CjsResource.State.UNLOADED;
764
+ }
765
+ }
766
+
767
+ // Declared as data rather than with decorators, so the resource tree stays
768
+ // plain ESM that loads from source without a transform. Resources are not model
769
+ // graph nodes - there is no Copy or Clone here, and SetValues/GetValues are a
770
+ // flat schema-driven property copy - so nothing here needed the decorator form.
771
+ // Field order is key order, and GetValues() exports in that order.
772
+ CjsSchema.define(CjsResource, {
773
+ className: "CjsResource",
774
+ family: "resource",
775
+ fields: {
776
+ path: type.path,
777
+ ext: type.string,
778
+ requirement: type.string,
779
+ state: type.string
780
+ },
781
+ methods: {
782
+ Initialize: [carbon.method, impl.adapted],
783
+ GetPath: [carbon.method, impl.adapted],
784
+ GetExt: [carbon.method, impl.adapted],
785
+ IsLoading: [carbon.method, impl.adapted],
786
+ HasLoaded: [carbon.method, impl.adapted],
787
+ IsPrepared: [carbon.method, impl.adapted],
788
+ IsGood: [carbon.method, impl.adapted],
789
+ IsFailed: [carbon.method, impl.adapted]
790
+ }
791
+ });
792
+ function destroyAdapterValue(value) {
793
+ if (!value || typeof value !== "object") return;
794
+ const destroy = value.Destroy || value.Dispose || value.destroy || value.dispose;
795
+ if (typeof destroy === "function") {
796
+ destroy.call(value);
797
+ }
798
+ }
799
+
800
+ export { CjsResource };
801
+ //# sourceMappingURL=CjsResource.js.map