Repository navigation
[Merge after engine 2.24 release] Document the frame graph, frame passes and CameraFrame effects - #1305
Open
mvaligursky wants to merge 7 commits into
Open
[Merge after engine 2.24 release] Document the frame graph, frame passes and CameraFrame effects#1305mvaligursky wants to merge 7 commits into
mvaligursky wants to merge 7 commits into
Conversation
added 4 commits
October 28, 2026 15:47
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.
added 2 commits
October 28, 2026 16:16
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.
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.
Documents the frame graph and its passes, now public in engine 2.24, and the CameraFrame effects built on them, replacing the pages that taught subclassing the camera frame and editing its compose shader.
Changes:
CameraFrameEffect, compose slots, shader chunks, parameters, effect scripts) and Effects with Passes (effects owning frame passes, stages, frame resources, rebuilding passes), plus pages for the Auto Exposure, Lens Flare and Dynamic Sky effects.Notes: