Skip to content

docs: restructure Cameras section into multi-page, workflow-agnostic docs#1041

Merged
willeastcott merged 6 commits into
mainfrom
docs/restructure-cameras-section
Jun 12, 2026
Merged

docs: restructure Cameras section into multi-page, workflow-agnostic docs#1041
willeastcott merged 6 commits into
mainfrom
docs/restructure-cameras-section

Conversation

@willeastcott

@willeastcott willeastcott commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Restructures the Cameras section of the user manual from a single thin, Editor-focused page into a full multi-page section, following the workflow-agnostic pattern established by the shadows rewrite (#1037).

New section structure

Page Content
index.md (rewritten) Section overview: what cameras are, creating one (4-way workflow tabs), section tour
projection.md (new) Perspective vs orthographic, FOV/orthoHeight, clip planes & depth precision, aspect ratio, frustum culling
clearing.md (new) Clear color and buffer flags, transparent backgrounds over the web page, disabling clearing
tone-mapping.md (new) Per-camera tone mapping curves, gamma correction, physically based exposure (aperture/shutter/sensitivity)
multiple-cameras.md (new) Priority ordering, viewports (split-screen), layers, camera stacking, render targets, performance notes
camera-controls.md (new) The engine's camera-controls.mjs script (orbit/fly/pan) across all four workflows, key attributes
screen-and-world.md (new) screenToWorld / worldToScreen patterns: mouse rays, object placement, HTML overlays

The existing scene-picker.md and depth-layer.md pages are unchanged and remain in the section.

Notes

  • All pages use the <Tabs groupId="workflow"> pattern (Engine / Editor / React / Web Components) where implementation differs.
  • Engine facts (property defaults, constants, script attributes) verified against current engine source.
  • Live <EngineExample> embeds used instead of new screenshots: graphics/multi-view and graphics/render-to-texture (Multiple Cameras), camera/orbit, camera/fly and camera/multi (Camera Controls), graphics/light-physical-units (Tone Mapping & Exposure).
  • Engine constants in prose link to their API reference pages (api.playcanvas.com/engine/variables/...).
  • Japanese translations mirrored for all seven pages.
  • Sidebar updated with the six new pages.
  • Dropped the standalone camera-icon.png usage (viewport entity icons are now documented on the Viewport page); camera-create.png moved inside the Editor tab.

🤖 Generated with Claude Code

…docs

Following the pattern established by the shadows page rewrite (#1037),
this restructures the Cameras section from a single Editor-focused page
into a full multi-page section with Engine/Editor/React/Web Components
tabs throughout:

- index.md: rewritten as a section overview covering camera creation,
  render target clearing, and links to all subpages
- projection.md (new): perspective vs orthographic, FOV, clip planes,
  aspect ratio, and frustum culling
- tone-mapping.md (new): per-camera tone mapping curves, gamma
  correction, and physically based exposure
- multiple-cameras.md (new): priority, viewports, layers, camera
  stacking, and render targets
- camera-controls.md (new): the engine's camera-controls.mjs script
  (orbit/fly/pan) across all workflows
- screen-and-world.md (new): screenToWorld/worldToScreen patterns

All engine facts verified against engine source. Japanese translations
mirrored for all pages. Sidebar updated with the new pages.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…le Cameras

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Clearing applies to single-camera setups too (background color,
transparent canvases), so it doesn't belong on the Multiple Cameras
page. Promote it to a dedicated Clearing page, adding coverage of
transparent backgrounds over the web page.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
camera/multi demonstrates the combined CameraControls scheme, not
multi-camera rendering - move it to the Camera Controls page and use
graphics/multi-view (two cameras with separate rects and layers) on
the Multiple Cameras page instead.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Drop the pc. prefix from constants mentioned in prose and link them to
their api.playcanvas.com variable pages (ASPECT_*, TONEMAP_*, GAMMA_*),
matching the convention used elsewhere in the manual.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Restructures the User Manual “Cameras” section from a single page into a multi-page, workflow-agnostic set of docs (EN + JA) and updates the Docusaurus sidebar accordingly.

Changes:

  • Rewrites the Cameras index page to introduce the section and add workflow-specific creation guidance (Engine / Editor / React / Web Components).
  • Adds new focused sub-pages (projection, clearing, tone mapping/exposure, multiple cameras, camera controls, screen/world coordinate conversion) with shared structure across workflows.
  • Mirrors the full restructure in Japanese translations and updates the sidebar nav ordering.

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
sidebars.js Adds the new Cameras sub-pages to the Graphics → Cameras sidebar list.
docs/user-manual/graphics/cameras/index.md Rewrites the Cameras landing page into an overview + section tour with workflow tabs.
docs/user-manual/graphics/cameras/projection.md New page covering perspective/orthographic projection, clip planes, aspect ratio, frustum culling.
docs/user-manual/graphics/cameras/clearing.md New page documenting camera clear behavior, transparent backgrounds, and disabling clear.
docs/user-manual/graphics/cameras/tone-mapping.md New page documenting per-camera tone mapping, gamma correction, and physical exposure.
docs/user-manual/graphics/cameras/multiple-cameras.md New page documenting composition via priority, viewports, layers, stacking, render targets, performance.
docs/user-manual/graphics/cameras/camera-controls.md New page documenting the engine’s camera-controls script across workflows.
docs/user-manual/graphics/cameras/screen-and-world.md New page documenting screenToWorld/worldToScreen patterns and picking.
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/graphics/cameras/index.md Japanese mirror of the updated Cameras landing page.
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/graphics/cameras/projection.md Japanese mirror of the Projection page.
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/graphics/cameras/clearing.md Japanese mirror of the Clearing page.
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/graphics/cameras/tone-mapping.md Japanese mirror of the Tone Mapping & Exposure page.
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/graphics/cameras/multiple-cameras.md Japanese mirror of the Multiple Cameras page.
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/graphics/cameras/camera-controls.md Japanese mirror of the Camera Controls page.
i18n/ja/docusaurus-plugin-content-docs/current/user-manual/graphics/cameras/screen-and-world.md Japanese mirror of the Screen/World Coordinates page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/user-manual/graphics/cameras/tone-mapping.md Outdated
Comment thread sidebars.js
Comment thread docs/user-manual/graphics/cameras/multiple-cameras.md
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 15 out of 15 changed files in this pull request and generated no new comments.

@willeastcott willeastcott merged commit 51c66d0 into main Jun 12, 2026
4 checks passed
@willeastcott willeastcott deleted the docs/restructure-cameras-section branch June 12, 2026 13:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants