Repository navigation
docs: track Web Components 0.28.0 - Engine 2.23, distance-based splat LOD and five new attributes - #1266
Merged
Conversation
… LOD and five new attributes Library 0.28.0 requires engine 2.23, whose Gaussian splat LOD is distance-only again, and adds devtools, scene-color-map, gravity-scale, gsplat-stochastic and gsplat-dither. Document it all, en + ja, and pin the live examples to 0.28.0 and engine 2.23.0: - pc-gsplat: lod-falloff is replaced by lod-base-distance (5) and lod-multiplier (3). The Level of Detail section now explains the distance steps and how gsplat-splat-budget-mode combines them with the budget, and its snippet uses the new attributes. A budget of 0 or less now means no budget, replacing the "no way to switch budgeted selection off" paragraph. A short Stochastic Rendering section points to the new pc-scene attributes - pc-scene: gsplat-lod-mode is replaced by gsplat-splat-budget-mode (target | limit). New rows for gsplat-stochastic and gsplat-dither, and gsplat-splat-budget says 0 or less means no budget - pc-app: devtools row (an opt-out, not a protection). It is read once at boot, so the "When these are read" note names it next to the graphics device options - pc-camera: scene-color-map row, for refractive materials such as glTF transmission - pc-rigid-body: gravity-scale row - pc-sound-slot: an auto-play slot starts once its entity and pc-sound are enabled (library #523) - Engine helper URLs in the 14 fences move to playcanvas@2.23.0 - static/assets/modules/ammo: the engine's growable Ammo build, as the library's examples now ship (library #521). Its heap grows past 64 MB, and it has btScaledBvhTriangleMeshShape, which engine 2.23 uses for scaled mesh colliders Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The devtools limitation and cameraFrame override need documenting in both locales.
Review effort: Balanced
Findings: 4
Open (4)
What changed in this PR
Updates the Web Components documentation and examples for Web Components 0.28.0 and Engine 2.23.0.
Changes:
- Documents new attributes and revised Gaussian splat LOD behavior in English and Japanese.
- Pins live examples and camera controls to Engine 2.23.0.
- Replaces Ammo assets with the growable build.
| File | Description |
|---|---|
src/components/LiveExample/shell.js |
Updates shared dependency pins. |
static/assets/modules/ammo/ammo.js |
Updates fallback Ammo build. |
static/assets/modules/ammo/ammo.wasm.js |
Updates Ammo WASM loader. |
static/assets/modules/ammo/ammo.wasm.wasm |
Updates Ammo WASM binary. |
docs/user-manual/web-components/tags/pc-app.md |
Documents devtools. |
docs/user-manual/web-components/tags/pc-camera.md |
Documents scene-color-map. |
docs/user-manual/web-components/tags/pc-gsplat.md |
Revises splat LOD and stochastic rendering docs. |
docs/user-manual/web-components/tags/pc-rigid-body.md |
Documents gravity-scale. |
docs/user-manual/web-components/tags/pc-scene.md |
Documents new splat settings. |
docs/user-manual/web-components/tags/pc-sound-slot.md |
Clarifies auto-play behavior. |
docs/user-manual/web-components/tags/pc-anim-clip.md |
Updates camera-controls version. |
docs/user-manual/web-components/tags/pc-anim.md |
Updates camera-controls version. |
docs/user-manual/web-components/tags/pc-asset.md |
Updates camera-controls version. |
docs/user-manual/web-components/tags/pc-model.md |
Updates camera-controls version. |
docs/user-manual/web-components/tags/pc-node.md |
Updates camera-controls version. |
docs/user-manual/web-components/tags/pc-sky.md |
Updates camera-controls version. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-app.md |
Mirrors devtools documentation. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-camera.md |
Mirrors scene-color-map documentation. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-gsplat.md |
Mirrors splat documentation changes. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-rigid-body.md |
Mirrors gravity-scale documentation. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-scene.md |
Mirrors new splat settings. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-sound-slot.md |
Mirrors auto-play clarification. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-anim-clip.md |
Updates localized example dependency. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-anim.md |
Updates localized example dependency. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-asset.md |
Updates localized example dependency. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-model.md |
Updates localized example dependency. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-node.md |
Updates localized example dependency. |
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/web-components/tags/pc-sky.md |
Updates localized example dependency. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…me exception Review follow-up on #1266, en + ja: - pc-app devtools: of the engine 2.23.0 builds, only the debug build announces to devtools. The release, profiler and minified builds never do (playcanvas/engine#9646 landed on release-2.23 after the 2.23.0 tag) - pc-camera scene-color-map: a camera rendered through the cameraFrame script takes this from rendering.sceneColorMap instead, so the attribute has no effect on it, as the library's own JSDoc says Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Library 0.28.0 requires engine 2.23, whose Gaussian splat LOD is distance-only again. It also adds
devtools,scene-color-map,gravity-scale,gsplat-stochasticandgsplat-dither. This PR documents all of it in English and Japanese, and pins the live examples to 0.28.0 and engine 2.23.0.Changes
Splat LOD for engine 2.23 (library playcanvas/web-components#516, engine playcanvas/engine#9584)
The engine 2.23 compatibility commit inside the dependency update replaced two attributes:
pc-gsplat:lod-falloffbecomeslod-base-distance(default 5) andlod-multiplier(default 3)pc-scene:gsplat-lod-modebecomesgsplat-splat-budget-mode(target|limit)The
pc-gsplatLevel of Detail section now explains the distance steps and how the budget mode combines them with the budget, and its snippet uses the new attributes. A budget of 0 or less now means no budget, so the paragraph saying budgeted selection can't be switched off is replaced. Thegsplat-splat-budgetrow says the same.New attributes
pc-scene:gsplat-stochasticandgsplat-dither(Add gsplat-stochastic and gsplat-dither to pc-scene web-components#519), plus a short Stochastic Rendering section onpc-gsplatthat points to thempc-app:devtools(Add devtools to pc-app web-components#520). It is read once at boot, so the "When these are read" note names it next to the graphics device options. The row notes that only engine 2.23.0's debug build announces to devtools (fix: Announce apps to the devtools hook from every build engine#9646 fixes the others after 2.23.0)pc-camera:scene-color-map, for refractive materials such as glTF transmission (Add scene-color-map to pc-camera web-components#527). A camera rendered through thecameraFramescript takesrendering.sceneColorMapinsteadpc-rigid-body:gravity-scale(Add gravity-scale to pc-rigid-body web-components#518)Behaviour
pc-sound-slot: anauto-playslot starts once its entity and<pc-sound>are both enabled (Create pc-sound-slot's engine slot with its asset web-components#523; checked against the engine'saddSlotandonEnable)Live examples
shell.jspins@playcanvas/web-components0.28.0 andplaycanvas2.23.0. 0.28.0's peer range is^2.23.0camera-controls.mjshelper URL in the 14 fences moves toplaycanvas@2.23.0static/assets/modules/ammo/is the engine's growable Ammo build, the one the library's examples now ship (Update the examples' Ammo build to the engine's growable one web-components#521). The three files have the same git blob hashes as the library's. Its heap starts at 16 MB and can grow past the old fixed 64 MB, and it includesbtScaledBvhTriangleMeshShape, which engine 2.23 uses for scaled mesh colliders. Only the Web Components pages load these filesVerification
npm run check:web-componentspasses at the 0.28.0 pin. Before the edits it listed exactly the 10 expected attribute differences per localeAll 39 live-example fences (31 tag pages and 8 guide fences) boot with a clean console at 0.27.0 / 2.22.6 and at 0.28.0 / 2.23.0. In a pixel diff of the two, only animated, scripted and physics scenes change, where capture timing differs.
pc-gsplatand the shadow-casting fences are pixel-identicalA headless Chrome probe at the new pins, with no console warnings:
gravity-scale="-0.5"ballbtScaledBvhTriangleMeshShapepresentscene-color-maprenderSceneColorMapis truelod-base-distance="8" lod-multiplier="1"gsplat-splat-budget="0",gsplat-splat-budget-mode="limit",gsplat-stochastic,gsplat-dither="bayer4"app.scene.gsplat, with no warning for the zero budgetauto-playslot on a disabled entitynpm run build(en + ja) and markdownlint passNot in this PR
gaussian-splatting/building/lod-streaming.mdandperformance.md) still describelodModeandlodFalloff, which engine 2.23 removed. A separate change will update them🤖 Generated with Claude Code