Skip to content

docs(shaders): add v2.20 msdfPS chunk migration entry#1067

Merged
mvaligursky merged 2 commits into
mainfrom
mv-msdf-chunk-migration-docs
Jun 23, 2026
Merged

docs(shaders): add v2.20 msdfPS chunk migration entry#1067
mvaligursky merged 2 commits into
mainfrom
mv-msdf-chunk-migration-docs

Conversation

@mvaligursky

@mvaligursky mvaligursky commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

!!!!!!!! MERGE WHEN engine v2.20.0 is out !!!!!!!!!

Summary

Updates the shader chunk migrations page (English + Japanese):

  1. Adds an Engine v2.20 entry documenting the msdfPS chunk rework, companion to engine PR fix(element): render MSDF text at the true glyph edge engine#8935 (will be merged shortly).
  2. Backfills the Japanese page with the v2.16 and v2.15 entries it was missing, so it structurally matches the English page.

v2.20 entry

The engine PR:

  • Reworks msdfPS to render text at the true glyph edge and anti-alias from the distance-field gradient.
  • Removes the font_pxrange and font_textureWidth uniforms (no longer set by the engine) and the map() helper.
  • Registers msdfPS in the chunk-version table at API 2.20, so a custom override of the chunk is flagged by the chunk validator.

The migration note warns that a custom msdfPS override copied from an earlier release that still references the removed uniforms will no longer receive their values — the old smoothing calculation then hits a divide-by-zero, breaking text — and points users to update their override and bump shaderChunksVersion to 2.20.

Japanese backfill

The JA page lagged the English one, with its newest entry at v2.6. Added translated v2.16 (gsplat accessor renames, gsplatCustomizeVS removal) and v2.15 (gsplat shader customization) entries so the two pages list the same releases.

Changes

  • docs/user-manual/graphics/shaders/migrations.md — English v2.20 entry.
  • i18n/ja/.../graphics/shaders/migrations.md — Japanese v2.20 entry + backfilled v2.16 / v2.15.

Notes

  • Links the engine PR, which is open but expected to merge shortly.

Document the v2.20 msdfPS chunk rework (text now renders at the true
glyph edge with gradient-based AA) and the removal of the font_pxrange
and font_textureWidth uniforms and the map() helper. Custom msdfPS
overrides referencing these must be updated, otherwise the old smoothing
calculation hits a divide-by-zero and text breaks.

Added to both the English and Japanese migration pages, linking the
engine PR.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…page

The Japanese migration page lagged the English one, missing the v2.16
(gsplat accessor renames, gsplatCustomizeVS removal) and v2.15 (gsplat
shader customization) entries. Add translated versions so the JA page
structurally matches the English page.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@mvaligursky mvaligursky merged commit 920b39d into main Jun 23, 2026
3 checks passed
@mvaligursky mvaligursky deleted the mv-msdf-chunk-migration-docs branch June 23, 2026 13:40
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