@carbonenginejs/runtime-resource 0.11.0 → 0.12.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 (76) hide show
  1. package/dist/formats/bnk/CjsBnkFormat.js +12 -2
  2. package/dist/formats/bnk/CjsBnkFormat.js.map +1 -1
  3. package/dist/formats/bnk/core/graph.js +3 -6
  4. package/dist/formats/bnk/core/graph.js.map +1 -1
  5. package/dist/formats/bnk/core/helpers.js +53 -11
  6. package/dist/formats/bnk/core/helpers.js.map +1 -1
  7. package/dist/formats/bnk/core/sfxNodes.js +532 -0
  8. package/dist/formats/bnk/core/sfxNodes.js.map +1 -0
  9. package/dist/formats/bnk/core/soundbanksInfo.js +59 -51
  10. package/dist/formats/bnk/core/soundbanksInfo.js.map +1 -1
  11. package/dist/formats/gr2/CjsGr2Format.js +256 -13
  12. package/dist/formats/gr2/CjsGr2Format.js.map +1 -1
  13. package/dist/formats/gr2/core/helpers.js +15 -15
  14. package/dist/formats/gr2/core/helpers.js.map +1 -1
  15. package/dist/formats/gr2/core/json.js +1 -1
  16. package/dist/formats/gr2/core/json.js.map +1 -1
  17. package/dist/formats/gr2/core/targets.js +1 -1
  18. package/dist/formats/gr2/core/targets.js.map +1 -1
  19. package/dist/formats/gr2/index.js +0 -1
  20. package/dist/formats/gr2/index.js.map +1 -1
  21. package/dist/formats/hlsl/core/analysis.js +1 -1
  22. package/dist/formats/hlsl/index.js +1 -0
  23. package/dist/formats/hlsl/index.js.map +1 -1
  24. package/dist/formats/index.js +3 -6
  25. package/dist/formats/index.js.map +1 -1
  26. package/dist/formats/webgl/core/cewg/binary.js +3 -3
  27. package/dist/formats/webgl/core/cewg/binary.js.map +1 -1
  28. package/dist/formats/webgl/core/effectPackage.js +6 -3
  29. package/dist/formats/webgl/core/effectPackage.js.map +1 -1
  30. package/dist/formats/webgl/core/effectPackageValidation.js +1 -1
  31. package/dist/formats/webgl/core/effectPackageValidation.js.map +1 -1
  32. package/dist/formats/webgl/core/errors.js +3 -3
  33. package/dist/formats/webgl/core/errors.js.map +1 -1
  34. package/dist/formats/webgpu/core/packageMetadata.js +2 -2
  35. package/dist/formats/webgpu/core/packageMetadata.js.map +1 -1
  36. package/docs/formats/dxbc/README.md +68 -0
  37. package/docs/formats/dxbc/architecture.md +80 -0
  38. package/docs/formats/dxbc/reference/api.md +77 -0
  39. package/docs/formats/dxbc/reference/classes/README.md +76 -0
  40. package/docs/formats/dxbc/reference/decoded-output.md +122 -0
  41. package/docs/formats/gr2.md +3 -4
  42. package/docs/formats/hlsl/README.md +54 -0
  43. package/docs/formats/hlsl/architecture.md +67 -0
  44. package/docs/formats/hlsl/guides/hydrating-json-output.md +62 -0
  45. package/docs/formats/hlsl/guides/reading-effects.md +64 -0
  46. package/docs/formats/hlsl/reference/advanced-analysis.md +66 -0
  47. package/docs/formats/hlsl/reference/api.md +97 -0
  48. package/docs/formats/hlsl/reference/classes/README.md +16 -0
  49. package/docs/formats/hlsl/reference/classes/carbon-compatibility.md +66 -0
  50. package/docs/formats/hlsl/reference/classes/public-api.md +26 -0
  51. package/docs/formats/hlsl/reference/classes/tr2-effect-model.md +150 -0
  52. package/docs/formats/hlsl/reference/json-graph.md +100 -0
  53. package/docs/formats/hlsl/reference/portable-reflection.md +141 -0
  54. package/docs/formats/provenance.md +9 -4
  55. package/docs/formats/webgl/README.md +57 -0
  56. package/docs/formats/webgl/architecture.md +70 -0
  57. package/docs/formats/webgl/carbon-constant-layouts.md +326 -0
  58. package/docs/formats/webgl/decl-io.md +1234 -0
  59. package/docs/formats/webgl/effect-reflection.md +127 -0
  60. package/docs/formats/webgl/memory-structured.md +871 -0
  61. package/docs/formats/webgl/reference/classes/README.md +96 -0
  62. package/docs/formats/webgl/texture-sample.md +964 -0
  63. package/docs/formats/webgpu/README.md +81 -0
  64. package/docs/formats/webgpu/architecture.md +93 -0
  65. package/docs/formats/webgpu/formats/cewgpu.md +479 -0
  66. package/docs/formats/webgpu/guides/effect-packaging.md +199 -0
  67. package/docs/formats/webgpu/reference/api.md +197 -0
  68. package/docs/formats/webgpu/reference/classes/README.md +66 -0
  69. package/docs/formats/webgpu/reference/wgsl-compatibility.md +1442 -0
  70. package/docs/formats/wwise.md +16 -1
  71. package/docs/reference/classes/formats.md +10 -10
  72. package/format-notices/bnk/NOTICE +5 -4
  73. package/format-notices/webgl/NOTICE +1 -1
  74. package/package.json +1 -1
  75. package/dist/formats/gr2/core/CjsFormatGr2.js +0 -273
  76. package/dist/formats/gr2/core/CjsFormatGr2.js.map +0 -1
package/docs/formats/webgl/reference/classes/README.md ADDED
@@ -0,0 +1,96 @@
1
+ # Class catalog
2
+
3
+ Status: Evolving
4
+ Scope: `@carbonenginejs/runtime-resource/formats/webgl` maintained classes
5
+ Audience: Users, maintainers, and automated readers
6
+ Summary: Provides one-sentence purpose descriptors for every maintained class.
7
+
8
+ <!-- class:CjsWebglFormat -->
9
+ ## `CjsWebglFormat`
10
+
11
+ CarbonEngineJS-facing format surface for `.cewg` WebGL shader packages, and a DXBC -> GLSL ES 3.00 emitter for the WebGL2 vertex/pixel/map-style-compute stages ccpwgl targets.
12
+
13
+ - Export: `@carbonenginejs/runtime-resource/formats/webgl`
14
+ - Source: `src/CjsWebglFormat.js`
15
+ - Visibility: Public
16
+ - Kind: CarbonEngineJS
17
+
18
+ <!-- class:CewgPackage -->
19
+ ## `CewgPackage`
20
+
21
+ Reader for CarbonEngineJS CEWG shader packages emitted by `hlsl2webgl`.
22
+
23
+ - Export: None
24
+ - Source: `src/core/cewg/CewgPackage.js`
25
+ - Visibility: Internal
26
+ - Kind: Internal implementation
27
+
28
+ <!-- class:CewgPackageBuilder -->
29
+ ## `CewgPackageBuilder`
30
+
31
+ Builds CarbonEngineJS CEWG shader package bytes.
32
+
33
+ - Export: None
34
+ - Source: `src/core/cewg/CewgPackageBuilder.js`
35
+ - Visibility: Internal
36
+ - Kind: Internal implementation
37
+
38
+ <!-- class:CjsBinaryReader -->
39
+ ## `CjsBinaryReader`
40
+
41
+ Minimal little-endian binary reader for the flat CEWG chunk container.
42
+
43
+ - Export: None
44
+ - Source: `src/core/cewg/binary.js`
45
+ - Visibility: Internal
46
+ - Kind: Internal implementation
47
+
48
+ <!-- class:ReflectionBlobStore -->
49
+ ## `ReflectionBlobStore`
50
+
51
+ Builds a deterministic deduplicated byte arena for portable reflection.
52
+
53
+ - Export: None
54
+ - Source: `src/core/effectReflectionPackage.js`
55
+ - Visibility: Internal
56
+ - Kind: Internal implementation
57
+
58
+ <!-- class:CjsWebglReadError -->
59
+ ## `CjsWebglReadError`
60
+
61
+ Error raised when a CEWG package or a DXBC-to-GLSL emission cannot be completed safely.
62
+
63
+ - Export: None
64
+ - Source: `src/core/errors.js`
65
+ - Visibility: Internal
66
+ - Kind: Internal implementation
67
+
68
+ <!-- class:DxbcGlslEmitter -->
69
+ ## `DxbcGlslEmitter`
70
+
71
+ DXBC -> GLSL ES 3.00 emitter for vertex and pixel stages.
72
+
73
+ - Export: None
74
+ - Source: `src/core/glsl/DxbcGlslEmitter.js`
75
+ - Visibility: Internal
76
+ - Kind: Internal implementation
77
+
78
+ <!-- class:DxbcGlslHelperRegistry -->
79
+ ## `DxbcGlslHelperRegistry`
80
+
81
+ Registry of GLSL helper functions the emitter can require per shader.
82
+
83
+ - Export: None
84
+ - Source: `src/core/glsl/DxbcGlslHelpers.js`
85
+ - Visibility: Internal
86
+ - Kind: Internal implementation
87
+
88
+ <!-- class:DxbcGlslOperandFormatter -->
89
+ ## `DxbcGlslOperandFormatter`
90
+
91
+ Formats decoded DXBC operands as GLSL ES 3.00 expressions and assignments.
92
+
93
+ - Export: None
94
+ - Source: `src/core/glsl/DxbcGlslOperandFormatter.js`
95
+ - Visibility: Internal
96
+ - Kind: Internal implementation