@carbonenginejs/runtime-resource 0.9.2 → 0.11.0

package/docs/reference/classes/formats.md

@@ -133,6 +133,78 @@ LSB-first bit reader over a single 128-bit BC7 block bitstream for the software
 - Visibility: Internal
 - Kind: Internal implementation class
 
+### dxbc
+
+<!-- class:CjsDxbcFormat -->
+## `CjsDxbcFormat`
+
+DXBC shader-bytecode format profile that reads container chunks, signatures, and the decoded shader program from compiled Direct3D bytecode.
+
+- Export: `@carbonenginejs/runtime-resource/formats/dxbc`
+- Source: `src/formats/dxbc/CjsDxbcFormat.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:DxbcReader -->
+## `DxbcReader`
+
+Bounded little-endian byte cursor over DXBC payloads, with optional shared string-table resolution.
+
+- Export: `None`
+- Source: `src/formats/dxbc/core/DxbcReader.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:DxbcContainer -->
+## `DxbcContainer`
+
+Parsed DXBC container that locates and exposes its four-character-code chunks.
+
+- Export: `None`
+- Source: `src/formats/dxbc/core/container.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:DxbcInstructionDecoder -->
+## `DxbcInstructionDecoder`
+
+Decodes the DXBC shader token stream into structured instructions, operands, and declarations.
+
+- Export: `None`
+- Source: `src/formats/dxbc/core/decoder.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:DxbcReadError -->
+## `DxbcReadError`
+
+Error raised when DXBC bytes are malformed, truncated, or structurally invalid.
+
+- Export: `None`
+- Source: `src/formats/dxbc/core/errors.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:DxbcShaderProgram -->
+## `DxbcShaderProgram`
+
+Decoded DXBC shader program: version, stage type, and its ordered instruction stream.
+
+- Export: `None`
+- Source: `src/formats/dxbc/core/program.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:DxbcSignatureChunk -->
+## `DxbcSignatureChunk`
+
+Parsed DXBC input, output, or patch-constant signature chunk and its parameter records.
+
+- Export: `None`
+- Source: `src/formats/dxbc/core/signature.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
 ### fbx
 
 <!-- class:CjsFbxFormat -->
@@ -263,6 +335,228 @@ Adaptive weighted symbol window that Oodle1 dictionaries use to model symbol pro
 - Visibility: Internal
 - Kind: Internal implementation class
 
+### hlsl
+
+<!-- class:CjsHlslFormat -->
+## `CjsHlslFormat`
+
+Compiled Carbon effect format profile that reads .sm_* shader packages into permutation, technique, and stage metadata.
+
+- Export: `@carbonenginejs/runtime-resource/formats/hlsl`
+- Source: `src/formats/hlsl/CjsHlslFormat.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:HlslReader -->
+## `HlslReader`
+
+Bounded little-endian byte cursor over compiled effect payloads, with shared string-table resolution.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/HlslReader.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectReadError -->
+## `HlslEffectReadError`
+
+Error raised when compiled effect bytes are malformed, truncated, or an unsupported version.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/HlslEffectReadError.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectStateManager -->
+## `HlslEffectStateManager`
+
+Resolves and caches render-state setups referenced by a compiled effect while it is read.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/HlslEffectStateManager.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslRenderStateSetup -->
+## `HlslRenderStateSetup`
+
+Ordered render-state key and value records attached to one pass.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/HlslRenderStateSetup.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslResourceSetDescription -->
+## `HlslResourceSetDescription`
+
+Describes one resource set bound by a compiled effect stage.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/HlslResourceSetDescription.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslShaderBytecode -->
+## `HlslShaderBytecode`
+
+Stage bytecode payload carried by a compiled effect, with its stage type and name.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/HlslShaderBytecode.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectRes -->
+## `HlslEffectRes`
+
+Parsed compiled effect resource: permutation axes, body offsets, and lazily decoded shader bodies.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/resources/HlslEffectRes.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslShaderPermutation -->
+## `HlslShaderPermutation`
+
+One permutation axis of a compiled effect, with its ordered options and default.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/resources/HlslShaderPermutation.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectBindingManifest -->
+## `HlslEffectBindingManifest`
+
+Flattened per-stage binding manifest derived from a resolved effect description.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslEffectBindingManifest.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectConstant -->
+## `HlslEffectConstant`
+
+Reflected shader constant: name, offset, size, type, dimension, and element count.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslEffectConstant.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectDescription -->
+## `HlslEffectDescription`
+
+Decoded effect body: techniques, passes, stages, libraries, and top-level annotations.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslEffectDescription.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectLibrary -->
+## `HlslEffectLibrary`
+
+Ray-tracing shader library record with its exports, payload size, and stage inputs.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslEffectLibrary.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectParameterAnnotation -->
+## `HlslEffectParameterAnnotation`
+
+Typed annotation attached to a reflected effect parameter.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslEffectParameterAnnotation.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectResource -->
+## `HlslEffectResource`
+
+Reflected shader resource or UAV binding with its register identity and array count.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslEffectResource.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectStageInput -->
+## `HlslEffectStageInput`
+
+Reflected stage input: constants, resources, samplers, signatures, and default constant bytes.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslEffectStageInput.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslEffectTechnique -->
+## `HlslEffectTechnique`
+
+Named technique of a compiled effect body and its ordered passes.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslEffectTechnique.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslPass -->
+## `HlslPass`
+
+One pass of a technique, carrying its stage inputs and render states.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslPass.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslSamplerDescription -->
+## `HlslSamplerDescription`
+
+Sampler state description: filters, address modes, LOD bounds, and comparison function.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslSamplerDescription.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslSamplerSetup -->
+## `HlslSamplerSetup`
+
+Named or static sampler setup bound by a compiled effect stage.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslSamplerSetup.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslShader -->
+## `HlslShader`
+
+Decoded shader body for one permutation index, wrapping its effect description.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslShader.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:HlslShaderOption -->
+## `HlslShaderOption`
+
+One option value of a permutation axis.
+
+- Export: `None`
+- Source: `src/formats/hlsl/core/tr2/shader/HlslShaderOption.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
 ### jpeg
 
 <!-- class:CjsJpegFormat -->
@@ -443,6 +737,152 @@ WAV audio format profile that inspects RIFF chunk metadata and reads supported W
 - Visibility: Public
 - Kind: Original CarbonEngineJS class
 
+### shared effect layer
+
+<!-- class:ReflectionBlobStore -->
+## `ReflectionBlobStore`
+
+Content-addressed arena that deduplicates every exact byte payload referenced by portable effect reflection.
+
+- Export: `None`
+- Source: `src/format/effect/effectReflectionPackage.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+### webgl
+
+<!-- class:CjsWebglFormat -->
+## `CjsWebglFormat`
+
+WebGL shader format profile that translates compiled Carbon effects into CEWG packages carrying GLSL programs and portable source reflection.
+
+- Export: `@carbonenginejs/runtime-resource/formats/webgl`
+- Source: `src/formats/webgl/CjsWebglFormat.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CewgPackage -->
+## `CewgPackage`
+
+Reader for the flat CEWG container: chunk lookup, cached JSON decoding, and validated portable reflection access.
+
+- Export: `None`
+- Source: `src/formats/webgl/core/cewg/CewgPackage.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:CewgPackageBuilder -->
+## `CewgPackageBuilder`
+
+Builds a CEWG container from ordered, uniquely tagged chunks.
+
+- Export: `None`
+- Source: `src/formats/webgl/core/cewg/CewgPackageBuilder.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:WebglReader -->
+## `WebglReader`
+
+Bounded little-endian byte cursor over CEWG container bytes.
+
+- Export: `None`
+- Source: `src/formats/webgl/core/cewg/binary.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:WebglReadError -->
+## `WebglReadError`
+
+Error raised when CEWG bytes or package documents are malformed or inconsistent.
+
+- Export: `None`
+- Source: `src/formats/webgl/core/errors.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:DxbcGlslEmitter -->
+## `DxbcGlslEmitter`
+
+Translates decoded DXBC shader programs into GLSL for the WebGL backend.
+
+- Export: `None`
+- Source: `src/formats/webgl/core/glsl/DxbcGlslEmitter.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:DxbcGlslHelperRegistry -->
+## `DxbcGlslHelperRegistry`
+
+Collects and emits the GLSL helper functions a translated program requires.
+
+- Export: `None`
+- Source: `src/formats/webgl/core/glsl/DxbcGlslHelpers.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:DxbcGlslOperandFormatter -->
+## `DxbcGlslOperandFormatter`
+
+Formats DXBC operands, swizzles, and modifiers as GLSL expressions.
+
+- Export: `None`
+- Source: `src/formats/webgl/core/glsl/DxbcGlslOperandFormatter.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+### webgpu
+
+<!-- class:CjsWebgpuFormat -->
+## `CjsWebgpuFormat`
+
+WebGPU shader format profile that translates compiled Carbon effects into CEWGPU packages carrying WGSL programs, bind-group layouts, and portable source reflection.
+
+- Export: `@carbonenginejs/runtime-resource/formats/webgpu`
+- Source: `src/formats/webgpu/CjsWebgpuFormat.js`
+- Visibility: Public
+- Kind: Original CarbonEngineJS class
+
+<!-- class:CewgpuPackage -->
+## `CewgpuPackage`
+
+Reader for the flat CEWGPU container: chunk lookup, cached JSON decoding, and gated portable reflection and backend program access.
+
+- Export: `None`
+- Source: `src/formats/webgpu/core/cewgpu/CewgpuPackage.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:CewgpuPackageBuilder -->
+## `CewgpuPackageBuilder`
+
+Builds a CEWGPU container from ordered, uniquely tagged chunks.
+
+- Export: `None`
+- Source: `src/formats/webgpu/core/cewgpu/CewgpuPackageBuilder.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:WebgpuReader -->
+## `WebgpuReader`
+
+Bounded little-endian byte cursor over CEWGPU container bytes.
+
+- Export: `None`
+- Source: `src/formats/webgpu/core/cewgpu/binary.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
+<!-- class:WebgpuReadError -->
+## `WebgpuReadError`
+
+Error raised when CEWGPU bytes or package documents are malformed or inconsistent.
+
+- Export: `None`
+- Source: `src/formats/webgpu/core/errors.js`
+- Visibility: Internal
+- Kind: Internal implementation class
+
 ### webm
 
 <!-- class:CjsWebmFormat -->