Skip to content

docs: document CameraFrame Color LUT setup and texture requirements#964

Merged
mvaligursky merged 1 commit into
mainfrom
mv-color-lut-docs
May 18, 2026
Merged

docs: document CameraFrame Color LUT setup and texture requirements#964
mvaligursky merged 1 commit into
mainfrom
mv-color-lut-docs

Conversation

@mvaligursky

Copy link
Copy Markdown
Contributor

Adds a new "Color LUT" subsection to the HDR Rendering guide covering how to load and use CameraFrame.colorLUT. Companion to the engine fix in playcanvas/engine#8747 which introduces a contract on the LUT texture (it must be loaded as sRGB, no mipmaps, linear filtering).

Changes:

  • New ### Color LUT subsection in docs/user-manual/graphics/linear-workflow/hdr-rendering.md covering:
    • Unreal-format LUT layout and explicit incompatibility note for HALD / Unity LUTs.
    • Required texture settings (srgb: true, mipmaps: false, linear filtering) with one-line rationale for each.
    • Full asset-loading + assignment code snippet matching the new engine contract.
    • Note about the debug-build warning users will see if any setting is wrong.
    • Brief authoring workflow (screenshot → image-editor adjustments → drag onto neutral LUT → export PNG) and Editor checklist.
    • Embedded neutral identity LUT and an aggressive ("cherry") example LUT as visual references.
  • docs/user-manual/graphics/posteffects/cameraframe/index.md LUT bullet now links to the new section.
  • Added static/img/user-manual/graphics/linear-workflow/lut-neutral.png and lut-cherry.png.
  • Japanese mirror updated to match (i18n/ja/...).

Companion engine PR: playcanvas/engine#8747

Adds a Color LUT subsection to the HDR Rendering guide covering how to load
and use CameraFrame.colorLUT with the texture-format contract introduced in
playcanvas/engine#8747 (sRGB on, mipmaps off, linear filtering).

Includes the Unreal-format layout description, required texture settings
with rationale, a full asset-loading + assignment code snippet, the
authoring workflow, and embedded neutral and cherry example LUTs as visual
references. The CameraFrame index page LUT bullet links to the new section.

Japanese mirror updated to match.
@mvaligursky mvaligursky self-assigned this May 18, 2026
@mvaligursky mvaligursky merged commit 39f4be1 into main May 18, 2026
3 checks passed
@mvaligursky mvaligursky deleted the mv-color-lut-docs branch May 18, 2026 17:32
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