Manual: shadow mapping and six more chapters - #245
Merged
Merged
Conversation
mdbook-environment 0.0.4 is incompatible with mdbook 0.5's preprocessor protocol. mdbook-variables (0.4.1) is maintained and provides the same {{VARIABLE}} substitution via use_env, keeping the DOCS_URL environment variable flow used by cargo xtask manual.
The Tonemapping field was pub(crate), leaving userland no way to configure exposure or the tone mapping algorithm.
…ters - lighting/shadow-mapping.md: Stage::new_shadow_map, per-frame shadow map updates, bias/PCF tuning, point-light notes - material.md: albedo factors, the texture atlas, PBR parameters, runtime updates, emissive color, normal maps - postprocessing.md: the HDR pipeline, bloom, exposure, and the tonemapping operators Each chapter is backed by a verified example in crates/examples/src and screenshots generated by tests. Note: Stage::set_images must be called before the first render for textures to apply - see issue #241.
Documents Stage::set_debug_mode with all nineteen DebugChannel variants grouped by purpose, with normals/UV/albedo screenshots of the shadow-mapping scene, plus the debug overlay with a caveat: it currently renders nothing (issue #243) and silently no-ops under direct drawing. The overlay step is omitted from the example because the feature produces no visible output today.
Documents NestedTransform: building parent/child graphs with local transforms, attaching primitives via with_transform, moving the parent to move the subtree, and moving a child independently. Notes on local vs global descriptors, eager global updates, remove_child/parent, and when to prefer a plain Transform.
Documents GLTF animation playback with the Animator (clips advance per frame and wrap automatically), hand-built morph targets with runtime weight updates, and skins - which are documented with a caveat: vertex skinning currently produces no visible effect even with posed joints (issue #244). The example omits a skinning demo for that reason; the crate's rigged_fox test never asserted a visual difference (no skinned baseline was ever committed).
Documents frustum culling (default on, output proven byte-identical when toggled), occlusion culling (off by default, in development), light tiling with the LightTilingConfig knobs and lux guidance, and MSAA. The tiling demo shows a 36-light scene rendering identically with tiling - pure savings.
Adds an ambient light section to the analytical lights chapter (global constant contribution, RGB + intensity, fills shadows), and fixes the dead '[the manual](#todo)' link in the crate docs to point at https://renderling.xyz/manual/index.html. reflinks gains the ambient color accessors.
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
1 participant
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.
Adds 7 manual chapters plus polish. The manual goes from 9 to 16 pages. Every chapter is backed by a verified example in
crates/examples/src(17 tests, all passing) with in-test visual assertions, not just prose.New chapters
Stage::new_shadow_map, per-frame updates, bias/PCF tuning, tipsDebugChannels grouped by purpose; overlay documented with a caveatNestedTransform, parents moving subtrees, local vs globalAnimatorplayback, hand-built morph targets; skinning documented with a caveatTooling
mdbook-environment(breaks on mdbook 0.5) to maintainedmdbook-variables, same{{DOCS_URL}}env flowStage::tonemapping()accessor - userland previously had no way to configure exposure or the tone mapping algorithmBugs found while writing the docs (filed, not fixed here)
Stage::set_imagesafter a render silently disables texture samplingDrawCalls::newreceives the inverted culling flag at the call siteVerification
cargo +nightly fmtclean