Skip to content

Engine 2.24 documentation [Merge after engine 2.24 release] - #1324

Merged
mvaligursky merged 51 commits into
mainfrom
claude/engine-2-24-docs
Nov 9, 2026
Merged

mvaligursky merged 51 commits into
mainfrom
claude/engine-2-24-docs

Conversation

@mvaligursky

Copy link
Copy Markdown
Contributor

Do not merge until engine 2.24 is released. These pages document APIs that ship in 2.24 and embed examples at the paths the 2.24 examples browser uses.

Collects the user manual changes for engine 2.24 in one branch, so they land together when 2.24 ships. Each PR below was merged into this branch and keeps its own description and review history. New documentation for 2.24 branches from claude/engine-2-24-docs and targets it.

Changes:

Fixes from combining them:

Martin Valigursky and others added 30 commits October 6, 2026 10:13
…tegory

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… at lights-and-shadows

Adds a Shadow Bounds section to the Shadows page for LightComponent#shadowBounds, and updates the example links of the light and shadow examples, which moved from graphics to lights-and-shadows in the examples browser. Japanese translations updated to match.
Explains physical render and compute passes and the frame graph, and documents the
engine's frame passes: the pass classes and their lifecycle, camera passes, RenderPass,
RenderPassShaderQuad, RenderPassForward and ComputePass. The CameraFrame custom render
passes page is folded into it, with a redirect to Camera Passes.
Replaces the compose shader and extending CameraFrame pages with two pages on
CameraFrameEffect: Custom Effects covers the composition and its compose slots,
the built-in effects with their ids, slots and order, writing, registering and
parameterizing an effect, debug views, chunk overrides and effect scripts for
the Editor. Effects with Passes covers the stages of the camera frame, the frame
resources, creating and rebuilding passes, per-frame values and resolving the
scene. Lens Flare and Dynamic Sky get pages of their own.

The camera frame overview lists the effects added since, and its Custom Post
Processing section points to the new pages and to Camera Passes, in English and
Japanese. The removed pages redirect to their replacements, and the sidebar and
the Engine LLM index link the new pages.
The sky and the flat clouds render for each XR view, while the volumetric
clouds render once for the view of the camera and streak where the view of an
eye extends past it. Add an XR section recommending the flat clouds in XR, and
narrow the limitation to the volumetric clouds.
…panese

Adds Japanese versions of the Frame Graph section and of the Custom Effects,
Effects with Passes, Lens Flare, Dynamic Sky and Auto Exposure pages, with the
headings keeping their English anchors so links into them resolve. Brings the
Japanese camera frame overview and HDR Rendering pages up to date with the TAA
upscaling, SMAA, debug view and effect script sections, and labels the Frame
Graph and Render Passes sidebar categories.
The engine now has a dynamicSkyEffect script, from dynamic-sky.mjs. Add a
section on it to the Dynamic Sky page, with a script of your own animating the
time of day, list it in the effect scripts of the HDR Rendering page, and drop
the note that the dynamic sky has no Editor script, in English and Japanese.
Mark the legacy script-based post effects as deprecated on the post effects
landing page, the legacy index, the six effect pages and the four tutorials
built on them, in English and Japanese. The legacy index gets a table of the
CameraFrame replacement for each legacy script.
…paths

[Merge after engine 2.24 release] Point CameraFrame example embeds at the camera-frame category
[Merge after engine 2.24 release] Document devicerestorefailed for a failed device recovery
[Merge after engine 2.24 release] Document compute shader access to the scene depth and color maps
…ads-docs

[Merge after engine 2.24 release] Document dispatching compute shaders for a number of threads
@mvaligursky mvaligursky self-assigned this Nov 2, 2026
@mvaligursky mvaligursky changed the title [Merge after engine 2.24 release] Engine 2.24 documentation Engine 2.24 documentation [Merge after engine 2.24 release] Nov 2, 2026
Picks up CI on pull requests to every branch (#1325).
Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
…PIs (#1329)

engine#9937 renames MeshInstance#castShadow/receiveShadow to castShadows/receiveShadows,
AnimComponent#findAnimationLayer to findLayer and PIXELFORMAT_111110F to PIXELFORMAT_RG11B10F,
keeping the old names as deprecated aliases. Use the new names in the manual, en and ja, and
link receiveShadows, which the API reference now documents.

Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
…1331)

The Camera Controls page gets a Mouse Buttons section covering the actions of
the left, middle and right buttons, reserving a button for the application,
and dragging the ground like a map with groundPan. The page and the three
first-app tutorials said the right button pans, but the middle button pans and
the right button looks. Japanese pages are updated alongside.

Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
…1328)

Documents the mipmap filters and the planar reflection changes of playcanvas/engine#9932, in English and Japanese: the Gaussian mipmaps of the planar renderer and its TAA jitter, the mipmaps of the scene color map, and the mipmapFilter option of render target textures.

Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
* Add an Add-on Libraries section to the engine manual

A new Add-on Libraries section under PlayCanvas Engine collects the libraries
used alongside the engine: an overview page, and a page each for Spine, 3D Tiles
with 3DTilesRendererJS, tweening with playcanvas-tween, and loaders.gl.

The Spine page moves here from 2D, which keeps a link to it. The tweening
tutorial moves here as the Tween page, updated for the UMD and ESM builds of
playcanvas-tween. The old URLs redirect to the new pages. Japanese pages are
updated alongside.

* List the Add-on Libraries pages in the engine llms index

The index linked the Spine page at its old 2D URL, which the llms plugin
rejects, and did not list the new pages. A new Add-on libraries section lists
the overview and its four pages, with Spine moved there from Animation.

---------

Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
…ry split (#1334)

Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
The SOG format spec now covers versions 2 and 3, both supported, with a table of the differences
and the version-specific parts marked: the exponential-map orientation, squared opacity up to
1.5625, a 4th SH band, 24-bit palette labels and per-gaussian blind data.

The Work Buffer Format page shows how a copy modifier reads blind fields through
getBlind_<name>() and SOG_BLIND_<name>, with the Blind Data example, and Streamed SOG notes that
chunks may be either version. English and Japanese.

Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
@mvaligursky
mvaligursky merged commit 69cb984 into main Nov 9, 2026
4 checks passed
@mvaligursky
mvaligursky deleted the claude/engine-2-24-docs branch November 9, 2026 16:56

This branch was successfully deployed

1 active deployment
Preview — 28ca5045 Deployed Nov 9, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant