Add a Parallax Mapping manual page - #1162
Merged
Merged
Conversation
Parallax mapping had no page of its own: the only coverage was one line in the model authoring guide and a four row table in the material inspector reference, neither of which mentions that there are two modes, that they read the height map differently, or that the relief can now shadow itself. Also corrects the inspector page, which still claimed parallax requires a normal map. That stopped being true in engine 2.22. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Warning
Do not merge until Engine v2.22 is released.
parallaxMode,parallaxSamples,parallaxShadowSamplesandheightMapBasedo not exist in v2.21 (heightMapBasealso needs playcanvas/engine#9245 merged), and the twoEngineExampleembeds point at examples (materials/parallax-mapping,materials/parallax-terrain) whose thumbnails are only served once the 2.22 examples site deploys.Description
Parallax mapping had no page of its own. The only coverage was one sentence in the model authoring guide about normal-map alpha, and a four row table in the material inspector reference — neither of which mentions that there are now two modes, that the zero level of the relief is configurable, or that the relief can shadow itself.
New page:
user-manual/graphics/physical-rendering/parallax-mapping, added to that category between Physical Materials and Image Based Lighting.PARALLAX_OFFSET(default, single tap) andPARALLAX_OCCLUSION(ray marched), from Add parallax occlusion mapping as an opt-in parallax mode engine#9213.heightMapBase, from Add heightMapBase to unify the parallax zero level across modes engine#9245. Both modes read the map the same way: the base value sits at the geometry, relief above it stands out and relief below it sinks in, with 0.5 the mid-grey pivot default and 1 the depth-only reading for white-floor/dark-crack maps.parallaxSamplesis a cap, not a fixed count, and the march scales down with view angle and distance until the effect fades out entirely, so distant surfaces cost nothing.parallaxShadowSamples, from Add soft self shadowing of the height field to parallax occlusion mapping engine#9225. Directional lights only, zero disables it, and it only appears where the light rakes across the grain of the height map — including the counter-intuitive part, that lowering the light does not give more of it.Correction: the material inspector page said parallax "Requires a normal map to be set". That stopped being true in playcanvas/engine#9207; the sentence now points at the new page instead.
The Japanese translation is included for both files.
Notes
npm run build: both locales build with no broken links, and the new page appears in the sidebar and renders both example embeds.🤖 Generated with Claude Code