@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.
- package/dist/formats/bnk/CjsBnkFormat.js +12 -2
- package/dist/formats/bnk/CjsBnkFormat.js.map +1 -1
- package/dist/formats/bnk/core/graph.js +3 -6
- package/dist/formats/bnk/core/graph.js.map +1 -1
- package/dist/formats/bnk/core/helpers.js +53 -11
- package/dist/formats/bnk/core/helpers.js.map +1 -1
- package/dist/formats/bnk/core/sfxNodes.js +532 -0
- package/dist/formats/bnk/core/sfxNodes.js.map +1 -0
- package/dist/formats/bnk/core/soundbanksInfo.js +59 -51
- package/dist/formats/bnk/core/soundbanksInfo.js.map +1 -1
- package/dist/formats/gr2/CjsGr2Format.js +256 -13
- package/dist/formats/gr2/CjsGr2Format.js.map +1 -1
- package/dist/formats/gr2/core/helpers.js +15 -15
- package/dist/formats/gr2/core/helpers.js.map +1 -1
- package/dist/formats/gr2/core/json.js +1 -1
- package/dist/formats/gr2/core/json.js.map +1 -1
- package/dist/formats/gr2/core/targets.js +1 -1
- package/dist/formats/gr2/core/targets.js.map +1 -1
- package/dist/formats/gr2/index.js +0 -1
- package/dist/formats/gr2/index.js.map +1 -1
- package/dist/formats/hlsl/core/analysis.js +1 -1
- package/dist/formats/hlsl/index.js +1 -0
- package/dist/formats/hlsl/index.js.map +1 -1
- package/dist/formats/index.js +3 -6
- package/dist/formats/index.js.map +1 -1
- package/dist/formats/webgl/core/cewg/binary.js +3 -3
- package/dist/formats/webgl/core/cewg/binary.js.map +1 -1
- package/dist/formats/webgl/core/effectPackage.js +6 -3
- package/dist/formats/webgl/core/effectPackage.js.map +1 -1
- package/dist/formats/webgl/core/effectPackageValidation.js +1 -1
- package/dist/formats/webgl/core/effectPackageValidation.js.map +1 -1
- package/dist/formats/webgl/core/errors.js +3 -3
- package/dist/formats/webgl/core/errors.js.map +1 -1
- package/dist/formats/webgpu/core/packageMetadata.js +2 -2
- package/dist/formats/webgpu/core/packageMetadata.js.map +1 -1
- package/docs/formats/dxbc/README.md +68 -0
- package/docs/formats/dxbc/architecture.md +80 -0
- package/docs/formats/dxbc/reference/api.md +77 -0
- package/docs/formats/dxbc/reference/classes/README.md +76 -0
- package/docs/formats/dxbc/reference/decoded-output.md +122 -0
- package/docs/formats/gr2.md +3 -4
- package/docs/formats/hlsl/README.md +54 -0
- package/docs/formats/hlsl/architecture.md +67 -0
- package/docs/formats/hlsl/guides/hydrating-json-output.md +62 -0
- package/docs/formats/hlsl/guides/reading-effects.md +64 -0
- package/docs/formats/hlsl/reference/advanced-analysis.md +66 -0
- package/docs/formats/hlsl/reference/api.md +97 -0
- package/docs/formats/hlsl/reference/classes/README.md +16 -0
- package/docs/formats/hlsl/reference/classes/carbon-compatibility.md +66 -0
- package/docs/formats/hlsl/reference/classes/public-api.md +26 -0
- package/docs/formats/hlsl/reference/classes/tr2-effect-model.md +150 -0
- package/docs/formats/hlsl/reference/json-graph.md +100 -0
- package/docs/formats/hlsl/reference/portable-reflection.md +141 -0
- package/docs/formats/provenance.md +9 -4
- package/docs/formats/webgl/README.md +57 -0
- package/docs/formats/webgl/architecture.md +70 -0
- package/docs/formats/webgl/carbon-constant-layouts.md +326 -0
- package/docs/formats/webgl/decl-io.md +1234 -0
- package/docs/formats/webgl/effect-reflection.md +127 -0
- package/docs/formats/webgl/memory-structured.md +871 -0
- package/docs/formats/webgl/reference/classes/README.md +96 -0
- package/docs/formats/webgl/texture-sample.md +964 -0
- package/docs/formats/webgpu/README.md +81 -0
- package/docs/formats/webgpu/architecture.md +93 -0
- package/docs/formats/webgpu/formats/cewgpu.md +479 -0
- package/docs/formats/webgpu/guides/effect-packaging.md +199 -0
- package/docs/formats/webgpu/reference/api.md +197 -0
- package/docs/formats/webgpu/reference/classes/README.md +66 -0
- package/docs/formats/webgpu/reference/wgsl-compatibility.md +1442 -0
- package/docs/formats/wwise.md +16 -1
- package/docs/reference/classes/formats.md +10 -10
- package/format-notices/bnk/NOTICE +5 -4
- package/format-notices/webgl/NOTICE +1 -1
- package/package.json +1 -1
- package/dist/formats/gr2/core/CjsFormatGr2.js +0 -273
- package/dist/formats/gr2/core/CjsFormatGr2.js.map +0 -1
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# Portable body reflection
|
|
2
|
+
|
|
3
|
+
Status: Evolving
|
|
4
|
+
Scope: `@carbonenginejs/runtime-resource/formats/hlsl/portable`
|
|
5
|
+
Audience: Backend effect-packager authors
|
|
6
|
+
Summary: Defines exact, handle-free reflection for one compiled effect body.
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
The ordinary JSON and metadata modes describe one option-selected effect for
|
|
11
|
+
inspection. Backend package builders need a stronger boundary: exact
|
|
12
|
+
permutation-table selection, authored constant defaults, source programs, and
|
|
13
|
+
all reflection fields without renderer handles.
|
|
14
|
+
|
|
15
|
+
The portable subpath supplies that boundary:
|
|
16
|
+
|
|
17
|
+
```js
|
|
18
|
+
import {
|
|
19
|
+
buildEffectBodyReflection,
|
|
20
|
+
enumerateUniqueEffectBodies,
|
|
21
|
+
readEffectBodyReflection,
|
|
22
|
+
validateEffectBodyReflection
|
|
23
|
+
} from "@carbonenginejs/runtime-resource/formats/hlsl/portable";
|
|
24
|
+
|
|
25
|
+
const document = readEffectBodyReflection(bytes, {
|
|
26
|
+
source: "effect.sm_depth",
|
|
27
|
+
permutationIndex: 4
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
validateEffectBodyReflection(document);
|
|
31
|
+
|
|
32
|
+
const groups = enumerateUniqueEffectBodies(effectRes);
|
|
33
|
+
const uniqueReflections = groups.map((group) =>
|
|
34
|
+
buildEffectBodyReflection(effectRes, group.permutationIndex));
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
`buildEffectBodyReflection(effectRes, permutationIndex)` accepts an already
|
|
38
|
+
loaded raw `Tr2EffectRes`. This avoids reparsing when a backend builder already
|
|
39
|
+
uses `readEffectAnalysis`.
|
|
40
|
+
|
|
41
|
+
`enumerateUniqueEffectBodies(effectRes)` inspects version-15 source records and
|
|
42
|
+
bytes without decoding. It returns first-occurrence-ordered groups containing
|
|
43
|
+
one canonical `permutationIndex`/`sourceRecord` plus every byte-identical
|
|
44
|
+
variant alias. Exact range aliases are a fast path; distinct ranges are
|
|
45
|
+
fingerprinted and then compared byte-for-byte. The inventory caps the
|
|
46
|
+
Cartesian body table at 65,536 records, rejects partial overlaps, and leaves
|
|
47
|
+
the effect cache and state-manager registries unchanged.
|
|
48
|
+
|
|
49
|
+
## Contract
|
|
50
|
+
|
|
51
|
+
Version 1 accepts compiled effect version 15 only. Earlier container versions
|
|
52
|
+
synthesize or normalize several signature fields while reading; rejecting them
|
|
53
|
+
keeps every portable field source-exact.
|
|
54
|
+
|
|
55
|
+
The root identifies `CJS_EFFECT_BODY_REFLECTION` version 1,
|
|
56
|
+
`mode: "single-body"`, `keyScope: "body-local"`,
|
|
57
|
+
`coverage.bodies: "single"`, the diagnostic source label and
|
|
58
|
+
compiled-effect version/compiler/shared-table/source envelope in `source`, the exact
|
|
59
|
+
`permutationIndex`, and its
|
|
60
|
+
`sourceRecord.offset` / `sourceRecord.byteLength` span. Its effect graph
|
|
61
|
+
preserves:
|
|
62
|
+
|
|
63
|
+
- ordered parameter annotation groups;
|
|
64
|
+
- ordered techniques, passes, raw render-state pairs, and libraries;
|
|
65
|
+
- every present vertex, pixel, compute, geometry, hull, or domain stage;
|
|
66
|
+
- constant, resource, UAV, dynamic sampler, and stage-annotation metadata;
|
|
67
|
+
- complete pipeline-input, register, static-sampler, and thread-group
|
|
68
|
+
signatures;
|
|
69
|
+
- exact authored constant-default bytes and declared length; and
|
|
70
|
+
- owned copies of every stage and library source-program payload.
|
|
71
|
+
|
|
72
|
+
Every source-program record retains its exact shared-table offset. The
|
|
73
|
+
validator requires its complete byte range to remain within
|
|
74
|
+
`source.stringTableByteLength`.
|
|
75
|
+
Stage programs are explicitly `kind: "stage"` and carry their authored stage
|
|
76
|
+
identity. DXR library programs are `kind: "library"` and deliberately carry no
|
|
77
|
+
synthetic compute-stage identity.
|
|
78
|
+
|
|
79
|
+
Numeric BOOL, INT, and FLOAT annotations retain their exact serialized
|
|
80
|
+
`rawValue`. Sampler floats retain raw IEEE-754 bits. Static sampler border
|
|
81
|
+
colors remain their source enum byte; dynamic sampler border colors remain
|
|
82
|
+
four float bit patterns.
|
|
83
|
+
|
|
84
|
+
`source.nativeHash` is the compiler-provided v15 hash field, not a package
|
|
85
|
+
content digest. The backend package must independently hash its whole source
|
|
86
|
+
and body payloads.
|
|
87
|
+
|
|
88
|
+
Version-15 resource and signature counts retain Carbon's authored zero value.
|
|
89
|
+
For heap-view/bindless SRV, UAV, and sampler bindings, `arrayElements: 0` and
|
|
90
|
+
the matching signature `arrayCount: 0` / `registerCount: 0` represent an
|
|
91
|
+
unbounded descriptor range; they are valid source reflection, not an empty or
|
|
92
|
+
malformed binding. Every resource and UAV map entry must reconcile with
|
|
93
|
+
exactly one signature register; signature-only records remain valid.
|
|
94
|
+
|
|
95
|
+
The compiled body has no authored effect-name field. The caller-supplied
|
|
96
|
+
diagnostic name or path is retained only as `source.label`.
|
|
97
|
+
|
|
98
|
+
The serializer rejects defaults or constant extents beyond Carbon's 4,096-byte
|
|
99
|
+
stage constant-buffer limit.
|
|
100
|
+
|
|
101
|
+
## Source truth and realization
|
|
102
|
+
|
|
103
|
+
The portable document excludes shader, program, render-state, sampler, and
|
|
104
|
+
library handles. It also excludes resource-set descriptions, heap-view arrays,
|
|
105
|
+
backend layouts, masks, sort values, and caches. `runtime-resource` consumes
|
|
106
|
+
the document to hydrate the canonical device-free shader/reflection graph,
|
|
107
|
+
select permutations, and cache shaders. Engines own handles, layouts,
|
|
108
|
+
resource sets, programs, pipelines, and other GPU realization.
|
|
109
|
+
|
|
110
|
+
Register dynamic classification is not persisted. It depends on per-frame
|
|
111
|
+
reader/engine policy and is not an authored binary field.
|
|
112
|
+
|
|
113
|
+
Authored constant defaults are separate from the raw model's mutable
|
|
114
|
+
`constantValues`. Carbon-compatible sampler-heap realization may zero-extend
|
|
115
|
+
the latter; it cannot change the portable source prefix.
|
|
116
|
+
|
|
117
|
+
## Selection and completeness
|
|
118
|
+
|
|
119
|
+
The parser-internal `GetShaderByIndex(index)` and the portable serializer
|
|
120
|
+
bypass global and local option selection. This is distinct from
|
|
121
|
+
`runtime-resource` `Tr2EffectRes.GetShaderByIndex`, which hydrates and caches a
|
|
122
|
+
canonical shader. The portable serializer performs a fresh non-caching decode
|
|
123
|
+
with a temporary state manager, so mutation of a previously cached raw shader
|
|
124
|
+
cannot change reflection rebuilt from the same owned source bytes.
|
|
125
|
+
This makes a body-table index stable even when an application has global
|
|
126
|
+
effect options.
|
|
127
|
+
|
|
128
|
+
Version 1 describes one complete listed body. Body-local technique, pass,
|
|
129
|
+
stage, and library keys must be namespaced by a backend package before they are
|
|
130
|
+
flattened across bodies. This document does not claim that a backend package
|
|
131
|
+
contains every permutation body or a program for every body. A backend
|
|
132
|
+
container must reconcile all three of `permutationIndex`,
|
|
133
|
+
`sourceRecord.offset`, and `sourceRecord.byteLength` with its own body identity
|
|
134
|
+
and permutation graph, then reconcile the source byte length and native hash
|
|
135
|
+
before claiming completeness.
|
|
136
|
+
|
|
137
|
+
## Related documentation
|
|
138
|
+
|
|
139
|
+
- [JSON and metadata graphs](json-graph.md)
|
|
140
|
+
- [Advanced analysis exports](advanced-analysis.md)
|
|
141
|
+
- [Architecture](../architecture.md)
|
|
@@ -53,10 +53,10 @@ GR2/GSF reader joined the runtime copies:
|
|
|
53
53
|
|---|---|---|---|
|
|
54
54
|
| `format-gr2` | `fa64607de7a3a96ed3b1aec5288bf71057642043` (v0.2.0, MIT) | `CjsGr2Format` | `@carbonenginejs/runtime-resource/formats/gr2` |
|
|
55
55
|
|
|
56
|
-
The
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
`format-notices/gr2/`.
|
|
56
|
+
The donor engine was folded into the single public `CjsGr2Format` class, so
|
|
57
|
+
the copied `CjsFormatGr2` name is gone and `formats/gr2/core/` holds only
|
|
58
|
+
role-named helper modules, matching every other format. Donor license and
|
|
59
|
+
notice files are kept under `format-notices/gr2/`.
|
|
60
60
|
|
|
61
61
|
## Black definition snapshot
|
|
62
62
|
|
|
@@ -85,6 +85,11 @@ format attribution rather than fork provenance.
|
|
|
85
85
|
| Wwise soundbank (`.bnk`) | `CjsBnkFormat` | `@carbonenginejs/runtime-resource/formats/bnk` | Original code; chunk layout from public community documentation (ww2ogg, vgmstream, wwiser), no code copied. Also carries the SoundbanksInfo JSON helpers (`parseSoundbanksInfo`, `buildSoundbanksCatalog`, `joinSoundbanksInfo`) and `wwiseIdFromName` (FNV-1 32 of the lowercased name, verified against EVE bank/language ids). HIRC entries additionally decode version-stable typed fields (event action lists, action type/target, sound and music-track source ids), pinned by hexdump against bank generator version 150, and the `wwise` static namespace groups the domain toolkit (SoundbanksInfo helpers, id hash, `wwise.eventMediaFromBanks` event → media resolution over inspected banks — graph interpretation for consumers; never used by the resource lifecycle). |
|
|
86
86
|
| Wwise media (`.wem`) | `CjsWemFormat` | `@carbonenginejs/runtime-resource/formats/wem` | Original code; container/codec-tag behavior from public community documentation (ww2ogg, vgmstream, wwiser), no code copied. Includes a Wwise-Vorbis→Ogg repacker (`emit: "ogg"`), an original reimplementation of the ww2ogg algorithm with inline granule computation (no revorb pass needed), and a PTADPCM/16-bit-PCM decoder (`emit: "pcm"` / `toPcm()`, AudioBuffer-ready float32; PTADPCM algorithm from community documentation, verified against EVE media). |
|
|
87
87
|
|
|
88
|
+
The BNK toolkit also exposes `wwise.sfxNodesFromBanks`: typed, exact-end
|
|
89
|
+
version-150 Random/Sequence, Switch/State, and Layer tails plus event/action
|
|
90
|
+
records and explicit parser diagnostics. It preserves resource facts for
|
|
91
|
+
consumer-owned lowering and is never invoked by the resource lifecycle.
|
|
92
|
+
|
|
88
93
|
## Post-fork additions inside copied formats
|
|
89
94
|
|
|
90
95
|
- `formats/dds` gained original, dependency-free **BC6H and BC7 CPU decoders**
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# WebGL format documentation
|
|
2
|
+
|
|
3
|
+
Status: Evolving
|
|
4
|
+
Scope: `@carbonenginejs/runtime-resource/formats/webgl`
|
|
5
|
+
Audience: Shader-tool authors, runtime integrators, and maintainers
|
|
6
|
+
Summary: Explains CEWG packages, portable reflection, and DXBC-to-GLSL conversion.
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
`@carbonenginejs/runtime-resource/formats/webgl` reads and builds CEWG packages and converts
|
|
11
|
+
supported compiled Carbon effect stages into GLSL ES 3.00 package data. It
|
|
12
|
+
preserves complete source permutation topology and, for version-15 effects,
|
|
13
|
+
portable reflection for every unique body without creating live shader or GPU
|
|
14
|
+
objects.
|
|
15
|
+
|
|
16
|
+
## Use this package when
|
|
17
|
+
|
|
18
|
+
Use `format-webgl` to inspect or build CEWG bytes, translate supported DXBC
|
|
19
|
+
stages, or convert one compiled effect while preserving all source
|
|
20
|
+
permutations and portable reflection. Use runtime and engine packages for live
|
|
21
|
+
shader objects, resource selection, bindings, and draws.
|
|
22
|
+
|
|
23
|
+
## Where it fits
|
|
24
|
+
|
|
25
|
+
```text
|
|
26
|
+
compiled effect bytes
|
|
27
|
+
|
|
|
28
|
+
+---- format-hlsl ---- portable source reflection
|
|
29
|
+
+---- format-dxbc ---- decoded shader programs
|
|
30
|
+
|
|
|
31
|
+
v
|
|
32
|
+
format-webgl
|
|
33
|
+
CEWG + GLSL ES 3.00
|
|
34
|
+
|
|
|
35
|
+
+---- runtime-resource ---- selection, cache, Tr2Shader hydration
|
|
36
|
+
+---- runtime-trinity ----- effect/material facade and parameters
|
|
37
|
+
`---- WebGL engine -------- programs, bindings, and draws
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Start here
|
|
41
|
+
|
|
42
|
+
```js
|
|
43
|
+
import { CjsWebglFormat } from "@carbonenginejs/runtime-resource/formats/webgl";
|
|
44
|
+
|
|
45
|
+
const summary = CjsWebglFormat.inspect(packageBytes);
|
|
46
|
+
const packageData = CjsWebglFormat.read(packageBytes);
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Documentation map
|
|
50
|
+
|
|
51
|
+
- [Architecture and ownership](architecture.md)
|
|
52
|
+
- [Effect reflection contract](effect-reflection.md)
|
|
53
|
+
- [Constant-buffer layouts](carbon-constant-layouts.md)
|
|
54
|
+
- [Declaration and I/O lowering](decl-io.md)
|
|
55
|
+
- [Structured-memory lowering](memory-structured.md)
|
|
56
|
+
- [Texture sampling](texture-sample.md)
|
|
57
|
+
- [Class-purpose catalog](reference/classes/README.md)
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Architecture and ownership
|
|
2
|
+
|
|
3
|
+
Status: Evolving
|
|
4
|
+
Scope: `@carbonenginejs/runtime-resource/formats/webgl`
|
|
5
|
+
Audience: Shader-tool authors, runtime integrators, and maintainers
|
|
6
|
+
Summary: Defines the package's compiler, container, runtime, and engine boundaries.
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
`format-webgl` is the transformation and package layer between compiled
|
|
11
|
+
Carbon-style effects and WebGL engine realization. It emits portable CEWG data
|
|
12
|
+
and GLSL ES 3.00 without constructing mutable runtime shader classes or WebGL
|
|
13
|
+
objects.
|
|
14
|
+
|
|
15
|
+
## Dependency direction
|
|
16
|
+
|
|
17
|
+
```text
|
|
18
|
+
@carbonenginejs/runtime-resource/formats/hlsl
|
|
19
|
+
|
|
|
20
|
+
+---- effect parsing and portable reflection
|
|
21
|
+
|
|
|
22
|
+
v
|
|
23
|
+
@carbonenginejs/runtime-resource/formats/webgl <---- @carbonenginejs/runtime-resource/formats/dxbc
|
|
24
|
+
| decoded DXBC
|
|
25
|
+
|
|
|
26
|
+
+---- CEWG bytes, metadata, reflection, GLSL
|
|
27
|
+
|
|
|
28
|
+
+---- runtime-resource ---- package selection + Tr2Shader hydration
|
|
29
|
+
+---- runtime-trinity ----- effect/material facade + parameters
|
|
30
|
+
`---- WebGL engine -------- GPU realization
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Tools may call the public byte-oriented API, but the format package does not
|
|
34
|
+
import the toolchain. Runtime packages consume immutable package data through
|
|
35
|
+
an explicit adapter boundary.
|
|
36
|
+
|
|
37
|
+
## Owned responsibilities
|
|
38
|
+
|
|
39
|
+
- Reading, inspecting, validating, and building CEWG v1 containers.
|
|
40
|
+
- Preserving every source permutation and unique body identity.
|
|
41
|
+
- Packing complete version-15 portable reflection and exact shared bytes.
|
|
42
|
+
- Translating supported DXBC vertex, pixel, and bounded map-style compute
|
|
43
|
+
stages into GLSL ES 3.00.
|
|
44
|
+
- Preserving backend bodies, stages, programs, manifests, and render states.
|
|
45
|
+
- Rejecting incomplete or inconsistent canonical effect packages.
|
|
46
|
+
|
|
47
|
+
## Ownership elsewhere
|
|
48
|
+
|
|
49
|
+
- `format-hlsl` owns compiled-effect parsing and the portable reflection
|
|
50
|
+
schema.
|
|
51
|
+
- `format-dxbc` owns DXBC decoding.
|
|
52
|
+
- `runtime-resource` owns `Tr2EffectRes`, package bytes, option selection,
|
|
53
|
+
per-permutation cache identity, canonical `Tr2Shader`, reflection records,
|
|
54
|
+
sampler setup records, and portable hydration.
|
|
55
|
+
- `runtime-trinity` owns the mutable `Tr2Effect`/`Tr2Material` facade,
|
|
56
|
+
parameters, authored options, and sampler overrides.
|
|
57
|
+
- The WebGL engine owns program compilation, locations, layouts, resource
|
|
58
|
+
binding, uploads, draws, and context recovery.
|
|
59
|
+
|
|
60
|
+
## Completeness boundary
|
|
61
|
+
|
|
62
|
+
Version-15 CEWG can be source-complete while remaining backend- and
|
|
63
|
+
runtime-incomplete. Successful GLSL translation and compile/link do not prove
|
|
64
|
+
the engine's physical binding/layout contract or a rendered result.
|
|
65
|
+
|
|
66
|
+
## Related documentation
|
|
67
|
+
|
|
68
|
+
- [Package documentation](README.md)
|
|
69
|
+
- [Effect reflection contract](effect-reflection.md)
|
|
70
|
+
- [Class-purpose catalog](reference/classes/README.md)
|
|
@@ -0,0 +1,326 @@
|
|
|
1
|
+
# EVE Carbon/Trinity Shader Constant-Buffer Layout Map
|
|
2
|
+
|
|
3
|
+
Status: Evolving
|
|
4
|
+
Scope: Carbon/Trinity constant-buffer layouts used by `@carbonenginejs/runtime-resource/formats/webgl`
|
|
5
|
+
Audience: Shader translators, runtime packers, and engine integrators
|
|
6
|
+
Summary: Maps Carbon constant-buffer registers and field layouts for WebGL integration.
|
|
7
|
+
|
|
8
|
+
> Produced 2026-07-05 from ../carbonengine source (authoritative) for the CEWG
|
|
9
|
+
> per-frame/per-object packer in ccpwgl. All register offsets are in float4
|
|
10
|
+
> (vec4) units. File references are relative to
|
|
11
|
+
> `../carbonengine/trinity/trinity/`.
|
|
12
|
+
|
|
13
|
+
Scope note: Carbon has **two parallel constant-buffer families**. (a) a
|
|
14
|
+
*generic* Tr2 family in `Tr2ConstantBufferFormats.h`, used by generic Tr2
|
|
15
|
+
renderables; and (b) an *EVE-space* family (`EveSpaceScene::PerFrame*` +
|
|
16
|
+
`EveSpaceObjectVSData/PSData`) used by ships/stations. **ccpwgl's ships mirror
|
|
17
|
+
family (b)**, so that is the primary comparison target.
|
|
18
|
+
|
|
19
|
+
## 0. Register assignment (shared by all families)
|
|
20
|
+
|
|
21
|
+
From `Tr2Renderer.cpp:38-43`:
|
|
22
|
+
|
|
23
|
+
| Register | Purpose | Getter |
|
|
24
|
+
|---|---|---|
|
|
25
|
+
| `b1` | per-frame VS | `GetPerFrameVSStartRegister()` (`Tr2Renderer.cpp:1199`) |
|
|
26
|
+
| `b2` | per-frame PS | `GetPerFramePSStartRegister()` (`:1204`) |
|
|
27
|
+
| `b3` | per-object VS | `GetPerObjectVSStartRegister()` (`:1209`) |
|
|
28
|
+
| `b4` | per-object PS | `GetPerObjectPSStartRegister()` (`:1219`) |
|
|
29
|
+
| `b5` | per-object RT vertex-buffer data | `:1224` |
|
|
30
|
+
| `b6` | per-object VS GUI | `GetPerObjectVSGUIStartRegister()` (`:1214`) |
|
|
31
|
+
|
|
32
|
+
`b0` is left for effect/material ("custom cb0"); effect constants are handled
|
|
33
|
+
by the material path (`Tr2EffectDescription.cpp`), not these structs. EVE space
|
|
34
|
+
objects reach `b3/b4` through `Tr2Renderer::GetPerObjectStartRegister(shaderType)`
|
|
35
|
+
in `Tr2PersistentPerObjectData.h:122,139`.
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 1. EVE-space per-frame layouts (the ccpwgl-relevant path)
|
|
40
|
+
|
|
41
|
+
### 1a. `EveSpaceScene::PerFrameVSData` -> b1
|
|
42
|
+
|
|
43
|
+
Struct: `Eve/EveSpaceScene.h:300-327`. Filled: `EveSpaceScene.cpp:3011-3064`
|
|
44
|
+
(`PopulatePerFrameVSData`).
|
|
45
|
+
|
|
46
|
+
| Field | Type | vec4 off | count | Fed from (EveSpaceScene.cpp) |
|
|
47
|
+
|---|---|---|---|---|
|
|
48
|
+
| ViewInverseTransposeMat | Matrix | 0 | 4 | `GetInverseViewTransform()` (`:3020`) |
|
|
49
|
+
| ViewProjectionMat | Matrix | 4 | 4 | `Transpose(view*reversedProj)` (`:3017-3018`) |
|
|
50
|
+
| ViewMat | Matrix | 8 | 4 | `Transpose(GetViewTransform())` (`:3014`) |
|
|
51
|
+
| ProjectionMat | Matrix | 12 | 4 | `Transpose(GetReversedDepthProjectionTransform())` (`:3015-3016`) |
|
|
52
|
+
| ShadowViewMat | Matrix | 16 | 4 | (populated by shadow path) |
|
|
53
|
+
| ShadowViewProjectionMat | Matrix | 20 | 4 | (shadow path) |
|
|
54
|
+
| EnvMapRotationMat | Matrix | 24 | 4 | `Transpose(RotationMatrix(m_envMapRotation))` (`:3028`) |
|
|
55
|
+
| ViewProjectionLast | Matrix | 28 | 4 | `Transpose(m_viewLast * m_projectionLast*m_jitterMatrix)` (`:3022-3023`) |
|
|
56
|
+
| ViewLast | Matrix | 32 | 4 | `Transpose(m_viewLast)` (`:3024`) |
|
|
57
|
+
| ProjLast | Matrix | 36 | 4 | `Transpose(lastProjection)` (`:3025`) |
|
|
58
|
+
| Sun.DirWorld + unused_pad0 | Vector3+float | 40 | 1 | `-Normalize(m_sunData.DirWorld)` (`:3035`) |
|
|
59
|
+
| Sun.DiffuseColor | Color | 41 | 1 | `m_currentSunColor` (`:3032`) |
|
|
60
|
+
| FogFactors + pad | Vector3+float | 42 | 1 | `(fogEnd/d, 1/d, fogMax)` (`:3045-3050`) |
|
|
61
|
+
| TargetResolution + FovXY | Vector2+Vector2 | 43 | 1 | RT w/h (`:3038-3039`); FovXY from projection+aspect (`:3042-3043`) |
|
|
62
|
+
| ViewportAdjustment | Vector4 | 44 | 1 | device/logical viewport ratios (`:3055-3058`) |
|
|
63
|
+
| Time, Upscaling, ViewportSize | float,float,Vector2 | 45 | 1 | `GetAnimationTime()`, `m_upscalingAmount`, device viewport (`:3059-3063`) |
|
|
64
|
+
|
|
65
|
+
Total = **46 registers**. `SunData` struct: `EveSpaceScene.h:218-223`
|
|
66
|
+
(Vector3 DirWorld, float pad, Color DiffuseColor).
|
|
67
|
+
|
|
68
|
+
### 1b. `EveSpaceScene::PerFramePSData` -> b2
|
|
69
|
+
|
|
70
|
+
Struct: `EveSpaceScene.h:240-294`. Filled: `EveSpaceScene.cpp:3066-3198`
|
|
71
|
+
(`PopulatePerFramePSData`).
|
|
72
|
+
|
|
73
|
+
| Field | Type | vec4 off | count | Fed from |
|
|
74
|
+
|---|---|---|---|---|
|
|
75
|
+
| ViewInverseTransposeMat | Matrix | 0 | 4 | `GetInverseViewTransform()` (`:3076`) |
|
|
76
|
+
| ViewMat | Matrix | 4 | 4 | `Transpose(GetViewTransform())` (`:3074`) |
|
|
77
|
+
| EnvMapRotationMat | Matrix | 8 | 4 | `Transpose(RotationMatrix(m_envMapRotation))` (`:3079`) |
|
|
78
|
+
| Sun.DirWorld+pad | Vector3+float | 12 | 1 | `-Normalize(sun dir)` (`:3085`) |
|
|
79
|
+
| Sun.DiffuseColor | Color | 13 | 1 | `m_currentSunColor`, `.a=m_defaultDiffuseRoughness` (`:3082-3083`) |
|
|
80
|
+
| AmbientColor + ReflectionIntensity | Vector3+float | 14 | 1 | `m_ambientColor` (`:3086`), `m_currentReflectionIntensity` (`:3088`) |
|
|
81
|
+
| FogColor | Vector4 | 15 | 1 | `(m_fogColor.rgb, m_fogMax)` (`:3089`) |
|
|
82
|
+
| ViewportOffset + ViewportSize | Vector2+Vector2 | 16 | 1 | viewport x/y (`:3105-3106`), device viewport (`:3108-3109`) |
|
|
83
|
+
| TargetResolution + DepthMapSampleCount + Debug | Vector2+f+f | 17 | 1 | RT w/h (`:3095-3096`); DepthMapSampleCount=1 legacy (`:3134`); Debug=`m_perFrameDebug` (`:3190`) |
|
|
84
|
+
| ShadowMapSettings | Vector4 | 18 | 1 | `(1,1,0,0)` (`:3131`) |
|
|
85
|
+
| ShadowCameraRange + ShadowLightness + ShadowQuality | Vec2+f+uint | 19 | 1 | `(1,0)` default (`:3103`), lightness=0 (`:3133`), `1<<m_shadowQuality` (`:3117`) |
|
|
86
|
+
| ProjectionToView + FovXY | Vector2+Vector2 | 20 | 1 | proj `_43,_33` (`:3137-3138`); FovXY (`:3099-3100`) |
|
|
87
|
+
| Time, SceneMipLodBias, Upscaling, GammaBrightness | 4xfloat | 21 | 1 | `GetAnimationTime()` (`:3111`), mip bias (`:3140-3157`), upscaling (`:3112,3152`), `g_eveSpaceSceneGammaBrightness` (`:3092`) |
|
|
88
|
+
| FrameIndex, Jittering, InverseShadowMapAtlasSize, ShadowMapAtlasEntryMinSizeLog2 | uint,uint,f,uint | 22 | 1 | frame counter (`:3114`), jitter!=0 (`:3115`), light-manager atlas (`:3121-3124`) |
|
|
89
|
+
| VolumetricSlices[4] | float[4] | 23 | 1 | hard-coded 1e3..1e6 (`:3192-3195`) |
|
|
90
|
+
| ShadowMapValues[4] | Vector4[4] | 24 | 4 | `shadowMap->m_perSplitData` (`:3161-3164`) |
|
|
91
|
+
| ShadowMatrixVal[16] | Matrix[16] | 28 | 64 | per-split shadow matrices, atlas-tiled 8x2 (`:3171-3184`) |
|
|
92
|
+
| SplitInfo | Vector4 | 92 | 1 | `shadowMap->m_perSplitData.SplitInfo` (`:3185`) |
|
|
93
|
+
| ProjectionInverseMat | Matrix | 93 | 4 | `Inverse(Transpose(reversedProj))` (`:3189`) |
|
|
94
|
+
| CascadeRanges[16] | Vector4[16] | 97 | 16 | `shadowMap->m_perSplitData.CascadeRanges` (`:3166-3169`) |
|
|
95
|
+
| FroxelFogData | FroxelPerFrameData | 113 | 5 | `m_volumetricsRenderer->PopulatePerFrameData` (`:3197`) |
|
|
96
|
+
|
|
97
|
+
Total = **118 registers**. `SHADOW_FRUSTUM_COUNT = 16` (`Tr2ShadowMap.h:15`).
|
|
98
|
+
`FroxelPerFrameData` (`Tr2VolumetricsRenderer.h:119-135`): FogColor(vec3)+
|
|
99
|
+
BackgroundVisibility, BaseDensity/MaxDistance/MaxDistanceVisibility/
|
|
100
|
+
EnvironmentIntensity, EnvironmentG+3pad, planets[2] (2xSphere=2 vec4)
|
|
101
|
+
= 5 registers.
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
## 2. EVE-space per-object layouts (ships/stations) -> b3 / b4
|
|
106
|
+
|
|
107
|
+
Structs: `Eve/SpaceObject/EveSpaceObject2.h:99-141`. Copied verbatim into the
|
|
108
|
+
buffers by `EveSpaceObject2::UpdatePerObjectBuffer` (`EveSpaceObject2.cpp:1469-1483`,
|
|
109
|
+
plain `memcpy` of the struct). Bound to b3/b4 via
|
|
110
|
+
`Tr2PerObjectDataWithPersistentBuffers` (`Tr2PersistentPerObjectData.h`).
|
|
111
|
+
`EVE_SPACEOBJECT_CUSTOWMASK_MAX = 2` (`EveSpaceObject2.h:49`);
|
|
112
|
+
`PACKED_COEFFICIENT_COUNT = 7` (`Tr2ShLightingManager.h:51`).
|
|
113
|
+
|
|
114
|
+
### 2a. `EveSpaceObjectVSData` -> b3
|
|
115
|
+
|
|
116
|
+
| Field | Type | vec4 off | count | Fed from (EveSpaceObject2.cpp) |
|
|
117
|
+
|---|---|---|---|---|
|
|
118
|
+
| worldTransform | Matrix | 0 | 4 | `Transpose(m_worldTransform)` (`:637`) |
|
|
119
|
+
| worldTransformLast | Matrix | 4 | 4 | `Transpose(m_worldTransform)` prev frame (`:2675`) |
|
|
120
|
+
| invWorldTransform | Matrix | 8 | 4 | `Transpose(m_invWorldTransform)` (`:638`) |
|
|
121
|
+
| shipData | Vector4 | 12 | 1 | `m_spaceObjectShipData` = (boosterGain, activation, dirt, boundingRadius) (`:639`,`734-744`) |
|
|
122
|
+
| clipData | Vector4 | 13 | 1 | `(clipSphereCenter, clipRadiusSq)` (`:758`) |
|
|
123
|
+
| ellpsoidRadii | Vector4 | 14 | 1 | `GetShapeEllipsoid` radius (`:643`) |
|
|
124
|
+
| ellpsoidCenter | Vector4 | 15 | 1 | `GetShapeEllipsoid` center (`:644`) |
|
|
125
|
+
| customMaskMatrix[2] | Matrix[2] | 16 | 8 | `m_customMasks[i]->FillPerObjectData` (`:654-664`) |
|
|
126
|
+
| customMaskData[2] | Vector4[2] | 24 | 2 | custom-mask fill (`:654-664`) |
|
|
127
|
+
| boneOffsets[4] | uint32[4] | 26 | 1 | `[curFrameOffset, prevFrameOffset, boneCount, -]` (`:1440-1444`) |
|
|
128
|
+
| morphTargetVertexDataOffset / AnimationDataOffset / activeMorphTargetsCount / bakedMorphTargetVertexDataOffset | uint32x4 | 27 | 1 | morph-target path |
|
|
129
|
+
| customData | Vector4 | 28 | 1 | copied from PS customData (`:1445`) |
|
|
130
|
+
|
|
131
|
+
Total = **29 registers**.
|
|
132
|
+
|
|
133
|
+
**Joints are NOT in this buffer on DX11.** `boneOffsets` (reg 26) index a
|
|
134
|
+
separate `BoneTransforms` ring buffer/SSBO
|
|
135
|
+
(`m_boneOffsets.UploadTransforms(... Float4x3 ...)`, `EveSpaceObject2.cpp:1441`).
|
|
136
|
+
Bones are `Float4x3` (3 vec4 per joint). This is the structured-buffer path
|
|
137
|
+
that `docs/dxbc-lowering/memory-structured.md:131-213` rewrites for WebGL2.
|
|
138
|
+
|
|
139
|
+
### 2b. `EveSpaceObjectPSData` -> b4
|
|
140
|
+
|
|
141
|
+
| Field | Type | vec4 off | count | Fed from |
|
|
142
|
+
|---|---|---|---|---|
|
|
143
|
+
| worldTransform | Matrix | 0 | 4 | `m_vsData.worldTransform` (`:646`) |
|
|
144
|
+
| worldTransformLast | Matrix | 4 | 4 | (`:2676`) |
|
|
145
|
+
| invWorldTransform | Matrix | 8 | 4 | (`:647`) |
|
|
146
|
+
| shipData | Vector4 | 12 | 1 | `m_spaceObjectShipData` (`:636`) |
|
|
147
|
+
| clipSphereCenter + clipRadiusSq | Vector3+float | 13 | 1 | (`:755-756`) |
|
|
148
|
+
| clipRadius2Sq, impactDataOffset, clipSphereFactor2, clipSphereFactor | 4xfloat | 14 | 1 | (`:651,760-762`) |
|
|
149
|
+
| shLightingCoefficients[7] | Vector4[7] | 15 | 7 | `UpdateShLighting` / cleared `:1425` |
|
|
150
|
+
| customMaskMaterialIDs[2] | Vector4[2] | 22 | 2 | custom-mask fill |
|
|
151
|
+
| customMaskTargets[2] | Vector4[2] | 24 | 2 | custom-mask fill |
|
|
152
|
+
| customMaskClamps | Vector4 | 26 | 1 | custom-mask fill |
|
|
153
|
+
| screenSize | Vector4 | 27 | 1 | screen size |
|
|
154
|
+
| customData | Vector4 | 28 | 1 | |
|
|
155
|
+
|
|
156
|
+
Total = **29 registers**.
|
|
157
|
+
|
|
158
|
+
### 2c. Other EVE per-object buffers
|
|
159
|
+
|
|
160
|
+
- **Turrets** `EveTurretSet.h:47-70`: `EveTurretSetVSData` = baseCutoffData,
|
|
161
|
+
turretSetData, shipMatrix, prevShipMatrix, currentBoneOffset/prevBoneOffset/
|
|
162
|
+
2x unused, then `turretTranslation[N]` + `turretRotation[N]` (per-turret).
|
|
163
|
+
`EveTurretSetPSData` = shipData, clipData1, clipRadius2Sq+3unused,
|
|
164
|
+
shLightingCoefficients[7]. Bound at b3/b4 (`EveTurretSet.cpp:3959,3961`).
|
|
165
|
+
- **Missile warhead** (ccpwgl `GLESPerObjectDataEveMissileWarhead`,
|
|
166
|
+
`Tr2PerObjectData.js:317-337`) mirrors a smaller variant.
|
|
167
|
+
|
|
168
|
+
---
|
|
169
|
+
|
|
170
|
+
## 3. Generic Tr2 per-frame / per-object family (`Tr2ConstantBufferFormats.h`)
|
|
171
|
+
|
|
172
|
+
Used by non-EVE Tr2 renderables. Filled in `Tr2ConstantBufferFormats.cpp` +
|
|
173
|
+
bound at b1/b2/b3/b4. Included for completeness; **not** what ccpwgl ships
|
|
174
|
+
mirror.
|
|
175
|
+
|
|
176
|
+
- `Tr2PerFrameVSData` (`.h:53-63`): ViewInverseTransposeMat(0-3), sunDirWorld(4),
|
|
177
|
+
sceneFogColor(5), ViewProjectionMat(6-9), ViewMat(10-13), ProjectionMat(14-17).
|
|
178
|
+
Filled `Tr2ConstantBufferFormats.cpp:13-29`.
|
|
179
|
+
- `Tr2PerFramePSData` (`.h:73-92`): ViewInverseTransposeMat(0-3),
|
|
180
|
+
sceneAmbientColor(4), sceneFogColor(5), sunDirWorld(6), sunDiffuseColor(7),
|
|
181
|
+
sunSpecularColor(8), maxFogAmount/maxFogDistance/minFogDistance/cullDirection(9),
|
|
182
|
+
ViewProjectionMat(10-13), shScale/shadowCount/invShadowSize/radius(14),
|
|
183
|
+
viewPort(15), ViewProjInverse(16-19).
|
|
184
|
+
- `Tr2PerObjectVSData` (`.h:35-41`): WorldMat(0-3), boundingCylinderLocalHeight+
|
|
185
|
+
boundingCylinderLocalXZCenter+boundingCylinderRotation(4).
|
|
186
|
+
- `Tr2PerObjectPSData` (`.h:43-51`): farFadeDistance/nearFadeDistance/padding(0),
|
|
187
|
+
highlightColor(1), then `Tr2PerObjectPerPixelPointLightData pointLights[8]`
|
|
188
|
+
(4 regs each, `.h:17-33`) = 32 regs. **<- generic path dynamic lights live in
|
|
189
|
+
per-object PS constants, 8 point lights max.**
|
|
190
|
+
- Generic VS float buffer capacity is `40*4` floats, PS `80*4` floats
|
|
191
|
+
(`Tr2PerObjectData.h:67,94`).
|
|
192
|
+
|
|
193
|
+
**Generic skinned path** (`Tr2PerObjectDataSkinned` / `Tr2PerAreaDataSkinned`,
|
|
194
|
+
`Tr2PerObjectData.cpp:75-193`): here joints ARE inlined into the b3 VS buffer.
|
|
195
|
+
Layout = `[jointMatrices | worldMat | (1 pad reg) | mirrorMatrix]`, total
|
|
196
|
+
`(TR2_MAX_BONES_PER_MESHAREA*3 + 5 + 4)*16` bytes. `TR2_MAX_BONES_PER_MESHAREA
|
|
197
|
+
= 69` (`Tr2PerObjectData.h:98`). Joints are 3 vec4 each (`Float4x3`), packed at
|
|
198
|
+
offset 0; worldMat at reg `69*3=207`, mirrorMatrix at reg `69*3+5=212`
|
|
199
|
+
(`Tr2PerObjectData.cpp:102-103,117-118`).
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
## 4. Drift vs ccpwgl GLES-v8 layouts
|
|
204
|
+
|
|
205
|
+
ccpwgl per-frame: `../ccpwgl/src/eve/EveSpaceScene.js:1906-1949`, filled
|
|
206
|
+
`:1659-1855`. ccpwgl per-object: `../ccpwgl/src/core/data/Tr2PerObjectData.js:52-105`.
|
|
207
|
+
|
|
208
|
+
### 4a. Per-frame VS drift (Carbon 1a vs ccpwgl vs, b1)
|
|
209
|
+
|
|
210
|
+
ccpwgl VS = ViewInverseTransposeMat, ViewProjectionMat, ViewMat, ProjectionMat,
|
|
211
|
+
ShadowViewMat, ShadowViewProjectionMat, EnvMapRotationMat, SunData.DirWorld,
|
|
212
|
+
SunData.DiffuseColor, FogFactors, TargetResolution, ViewportAdjustment,
|
|
213
|
+
MiscSettings = **34 regs**.
|
|
214
|
+
|
|
215
|
+
| Carbon field (off) | ccpwgl field (off) | Status |
|
|
216
|
+
|---|---|---|
|
|
217
|
+
| ViewInverseTransposeMat..EnvMapRotationMat (0-27) | same (0-27) | OK aligned |
|
|
218
|
+
| **ViewProjectionLast (28-31)** | - | MISSING in ccpwgl |
|
|
219
|
+
| **ViewLast (32-35)** | - | MISSING in ccpwgl |
|
|
220
|
+
| **ProjLast (36-39)** | - | MISSING in ccpwgl |
|
|
221
|
+
| Sun.DirWorld+pad (40) | SunData.DirWorld (28) | semantic match, **-12 reg shift** |
|
|
222
|
+
| Sun.DiffuseColor (41) | SunData.DiffuseColor (29) | (-12) |
|
|
223
|
+
| FogFactors+pad (42) | FogFactors (30) | (-12) |
|
|
224
|
+
| TargetResolution+FovXY (43) | TargetResolution (31) | Carbon packs FovXY in .zw; verify `d.targetResolution` carries fov |
|
|
225
|
+
| ViewportAdjustment (44) | ViewportAdjustment (32) | (-12) |
|
|
226
|
+
| Time,Upscaling,ViewportSize (45) | MiscSettings (33)=time,**unused**,vpW,vpH | `.y` differs: Carbon=Upscaling, ccpwgl=0 |
|
|
227
|
+
|
|
228
|
+
Net: ccpwgl VS omits the 3 motion-vector matrices (12 regs); every field from
|
|
229
|
+
Sun onward is shifted -12 registers. DX11 shaders reading `cb1[28+]` need the
|
|
230
|
+
Carbon-shaped buffer.
|
|
231
|
+
|
|
232
|
+
### 4b. Per-frame PS drift (Carbon 1b vs ccpwgl ps, b2)
|
|
233
|
+
|
|
234
|
+
ccpwgl PS = 13 entries ending at VolumetricSlices = **23 regs** vs Carbon's
|
|
235
|
+
**118**.
|
|
236
|
+
|
|
237
|
+
| Carbon field (off) | ccpwgl field (off) | Status |
|
|
238
|
+
|---|---|---|
|
|
239
|
+
| ViewInverseTransposeMat/ViewMat/EnvMapRotationMat (0-11) | same (0-11) | OK |
|
|
240
|
+
| Sun.DirWorld (12), Sun.DiffuseColor (13) | SunData.DirWorld (12), .DiffuseColor (13) | OK |
|
|
241
|
+
| AmbientColor+ReflectionIntensity (14) | AmbientColor+**NebulaIntensity** (14) | `.w` semantic differs |
|
|
242
|
+
| FogColor (15) | FogColor (15) | OK |
|
|
243
|
+
| ViewportOffset+ViewportSize (16) | ViewportOffset+ViewportSize (16) | OK |
|
|
244
|
+
| TargetResolution+DepthMapSampleCount+Debug (17) | TargetResolution vec4 (17) | `.z/.w` differ |
|
|
245
|
+
| ShadowMapSettings (18) | ShadowMapSettings (18) | OK |
|
|
246
|
+
| ShadowCameraRange+ShadowLightness+ShadowQuality (19) | ShadowCameraRange vec4 (19) | `.z/.w` differ |
|
|
247
|
+
| ProjectionToView+FovXY (20) | ProjectionToView+FovXY (20) | OK |
|
|
248
|
+
| Time,SceneMipLodBias,Upscaling,GammaBrightness (21) | MiscSettings=time,fogType,fogBlur,contrast (21) | only `.x` matches |
|
|
249
|
+
| **FrameIndex,Jittering,invAtlasSize,atlasMinLog2 (22)** | - | MISSING entirely |
|
|
250
|
+
| VolumetricSlices (23) | VolumetricSlices (22) | **-1 reg shift** |
|
|
251
|
+
| **ShadowMapValues[4] (24-27)** | - | MISSING |
|
|
252
|
+
| **ShadowMatrixVal[16] (28-91)** | - | MISSING (64 regs) |
|
|
253
|
+
| **SplitInfo (92)** | - | MISSING |
|
|
254
|
+
| **ProjectionInverseMat (93-96)** | - | MISSING |
|
|
255
|
+
| **CascadeRanges[16] (97-112)** | - | MISSING |
|
|
256
|
+
| **FroxelFogData (113-117)** | - | MISSING |
|
|
257
|
+
|
|
258
|
+
Net: aligned through reg ~20, diverges at 21, -1 shift from 23, and the whole
|
|
259
|
+
cascaded-shadow + froxel tail (95 regs) is absent in ccpwgl.
|
|
260
|
+
|
|
261
|
+
### 4c. Per-object VS drift (Carbon 2a vs ccpwgl vs, b3)
|
|
262
|
+
|
|
263
|
+
| Carbon field (off) | ccpwgl field (off) | Status |
|
|
264
|
+
|---|---|---|
|
|
265
|
+
| worldTransform..customMaskData[1] (0-25) | WorldMat..CustomMaskData1 (0-25) | OK aligned |
|
|
266
|
+
| **boneOffsets[4] (26)** | - (JointMat starts at 26) | CONFLICT |
|
|
267
|
+
| morph data (27) | (part of JointMat) | CONFLICT |
|
|
268
|
+
| customData (28) | (part of JointMat) | CONFLICT |
|
|
269
|
+
| - (joints in separate SSBO) | **JointMat cb3[26..199], 696 floats = 58 joints** | architecture drift |
|
|
270
|
+
|
|
271
|
+
In Carbon DX11, cb3[26]=boneOffsets, cb3[27]=morph, cb3[28]=customData, and
|
|
272
|
+
joints live in the separate `BoneTransforms` structured buffer (69 max,
|
|
273
|
+
Float4x3). ccpwgl WebGL2 splices 58 joints inline at cb3[26..199] instead.
|
|
274
|
+
The CEWG path keeps Carbon's shape: cb3 stays 29 regs, joints go to the
|
|
275
|
+
dedicated CewgSb UBO (capacity 69). Bone-count note: Carbon
|
|
276
|
+
TR2_MAX_BONES_PER_MESHAREA=69 vs ccpwgl inline 58 (likely a WebGL uniform
|
|
277
|
+
budget choice, not a Carbon constant).
|
|
278
|
+
|
|
279
|
+
### 4d. Per-object PS drift (Carbon 2b vs ccpwgl ps, b4)
|
|
280
|
+
|
|
281
|
+
| Carbon field (off) | ccpwgl field (off) | Status |
|
|
282
|
+
|---|---|---|
|
|
283
|
+
| **worldTransform (0-3)** | - | MISSING in ccpwgl |
|
|
284
|
+
| **worldTransformLast (4-7)** | - | MISSING in ccpwgl |
|
|
285
|
+
| **invWorldTransform (8-11)** | - | MISSING in ccpwgl |
|
|
286
|
+
| shipData (12) | Shipdata (0) | match, **-12 reg** |
|
|
287
|
+
| clipSphereCenter+clipRadiusSq (13) | Clipdata1 (1) | (-12) |
|
|
288
|
+
| clipRadius2Sq,impactDataOffset,clipSphereFactor2,clipSphereFactor (14) | Miscdata (2) | partial semantic overlap |
|
|
289
|
+
| shLightingCoefficients[7] (15-21) | ShLighting 4x7 (3-9) | same 7 vec4 (-12) |
|
|
290
|
+
| customMaskMaterialIDs[2] (22-23) | CustomMaskMaterialID0/1 (10-11) | (-12) |
|
|
291
|
+
| customMaskTargets[2] (24-25) | CustomMaskTarget0/1 (12-13) | (-12) |
|
|
292
|
+
| customMaskClamps (26) | CustomMaskBlending (14) | name differs, same slot |
|
|
293
|
+
| screenSize (27) | Screensize (15) | (-12) |
|
|
294
|
+
| customData (28) | - | MISSING in ccpwgl |
|
|
295
|
+
|
|
296
|
+
Net: Carbon's per-object PS leads with three matrices (12 regs) ccpwgl lacks —
|
|
297
|
+
every ccpwgl PS field is -12 registers vs the DX11 expectation. Largest
|
|
298
|
+
per-object drift; most likely to break translated pixel shaders if the
|
|
299
|
+
GLES-shaped buffer were reused.
|
|
300
|
+
|
|
301
|
+
---
|
|
302
|
+
|
|
303
|
+
## 5. Ambiguities / flags (not guessed — verify before relying on)
|
|
304
|
+
|
|
305
|
+
1. **Which per-frame family do specific shipped DX11 shaders bind?** EVE ships
|
|
306
|
+
use `EveSpaceScene::PerFrame*` (b1/b2), but the generic `Tr2PerFrame*`
|
|
307
|
+
family, `Tr2InteriorScene` per-frame (`Tr2InteriorScene.cpp:644-645`) and
|
|
308
|
+
shadow-only `Tr2PerFrameShadowPSData` (`Tr2ConstantBufferFormats.h:10-15`)
|
|
309
|
+
also exist. Confirm per shader family before packing.
|
|
310
|
+
2. **`d.targetResolution` contents:** ccpwgl relies on `device.targetResolution`
|
|
311
|
+
carrying FovXY in `.zw` (used at `EveSpaceScene.js:1683`). Not verified in
|
|
312
|
+
`Tw2Device.js`.
|
|
313
|
+
3. **`Tr2PerFrameVSDataDebug`** (`Tr2ConstantBufferFormats.h:66-70`, used
|
|
314
|
+
`EveSpaceScene.cpp:856`) is a smaller 8-register b1 variant for debug/shadow
|
|
315
|
+
passes (ViewInverseTransposeMat + ViewProjectionMat only).
|
|
316
|
+
4. **Bone count 69 vs 58**: source of ccpwgl's 58 not found in Carbon; flag for
|
|
317
|
+
reconciliation.
|
|
318
|
+
5. **Miscdata/customMaskClamps/CustomMaskBlending semantics** only positionally
|
|
319
|
+
matched; exact float meanings not fully cross-verified.
|
|
320
|
+
6. Effect/material "custom cb0" buffers are per-effect and out of scope of the
|
|
321
|
+
fixed ABI above.
|
|
322
|
+
|
|
323
|
+
Primary authoritative files: `Tr2ConstantBufferFormats.h/.cpp`,
|
|
324
|
+
`Tr2PerObjectData.h/.cpp`, `Tr2PersistentPerObjectData.h`,
|
|
325
|
+
`Eve/EveSpaceScene.h/.cpp`, `Eve/SpaceObject/EveSpaceObject2.h/.cpp`,
|
|
326
|
+
`Tr2Renderer.cpp`, `Tr2ShadowMap.h`, `Tr2VolumetricsRenderer.h`.
|