Skip to content

docs(gsplat): drop "unified" framing now that it's the default#8805

Merged
mvaligursky merged 1 commit into
mainfrom
mv-gsplat-docs-drop-unified
May 28, 2026
Merged

docs(gsplat): drop "unified" framing now that it's the default#8805
mvaligursky merged 1 commit into
mainfrom
mv-gsplat-docs-drop-unified

Conversation

@mvaligursky

Copy link
Copy Markdown
Contributor

Follow-up cleanup to the unified-default flip (#8802, #8803, #8804). Unified rendering is now the default and the unified property is @deprecated + @ignore, so the public API docs and examples shouldn't be framed around "unified mode" any more — it's just gsplat rendering.

Changes (engine source):

  • GSplatComponent:
    • Remove the ## Unified Rendering section from the class JSDoc.
    • Strip the JSDoc blocks from material get/set and highQualitySH get/set (both are legacy-only and only documented the unified/non-unified distinction).
    • Drop "unified" qualifiers from workBufferUpdate, workBufferModifier, setParameter, and getInstanceTexture JSDocs.
  • GSplatComponentSystem: drop "in unified mode" from the material:created and frame:ready event JSDocs, and from getMaterial JSDoc.
  • GSplatParams: class JSDoc "Parameters for GSplat unified system" → "Parameters for the GSplat system"; drop "unified" qualifier from dataFormat, material, and format JSDocs.
  • GSplatContainer: drop "non-unified rendering" from the class example comment, drop unified: true from the addComponent example, drop "unified" qualifier from the centers JSDoc.

Changes (examples — gaussian-splatting/ folder, 29 files):

  • Remove unified: true from every addComponent('gsplat', { ... }) call (~40 occurrences) — it's the default now and the property is deprecated.
  • Reword/remove comments that frame things around "unified" (e.g. // Create hotel gsplat with unified set to true// Create hotel gsplat).
  • Drop three stale orbit-pivot comments ("unified gsplats have no mesh AABB for focusEntity framing") — these became factually incorrect once fix(gsplat): unified-mode follow-ups (orbit-camera AABB, internal warnings) #8803 made orbit-camera.js unified-aware.
  • Update global-sorting example header from "demonstrates unified gsplat rendering" to "demonstrates global gsplat sorting" — what the example actually shows.

API Changes:

  • None. All edits are docs/comments/examples. No runtime behaviour or public-API surface changes.

Notes:

  • Remaining unified mentions in the engine are all either internal (private fields, code comments, code branches), runtime warning strings (which must keep the property name so users can search for it), @ignore'd JSDoc, or directory names — none render in public docs.
  • The legacy gsplat.unified = false opt-in still works and still emits the one-time Debug.deprecated warning from [BREAKING] Deprecate GSplatComponent#unified and default it to true #8802. This PR doesn't remove the legacy mode itself.

Follow-up cleanup to the unified-default flip (#8802, #8803, #8804).
Unified rendering is now the default and the unified property is
@deprecated/@ignore, so the public API docs and examples shouldn't be
framed around "unified mode" any more — it's just gsplat rendering.

Engine source:
- GSplatComponent: remove the "## Unified Rendering" section from the
  class JSDoc; strip the JSDoc blocks from material get/set and
  highQualitySH get/set (both are legacy-only and only documented the
  unified/non-unified distinction). Drop "unified" qualifiers from
  workBufferUpdate, workBufferModifier, setParameter, and
  getInstanceTexture JSDocs.
- GSplatComponentSystem: drop "in unified mode" from the
  material:created and frame:ready event JSDocs, and from the
  getMaterial JSDoc.
- GSplatParams: rename "Parameters for GSplat unified system" to
  "Parameters for the GSplat system"; drop "unified" qualifier from
  dataFormat, material, and format JSDocs.
- GSplatContainer: drop "non-unified rendering" from the class example
  comment, drop unified: true from the addComponent example, drop
  "unified" qualifier from the centers JSDoc.

Examples (gaussian-splatting folder):
- Remove unified: true from every addComponent('gsplat', { ... }) call
  (~40 occurrences across 29 files) — it's now the default and the
  property is deprecated.
- Reword/remove comments that mention "unified" framing now that it's
  just the standard path (e.g. "Create hotel gsplat with unified set
  to true" → "Create hotel gsplat").
- Drop three stale orbit-pivot comments ("unified gsplats have no mesh
  AABB for focusEntity framing") — these became factually incorrect
  once #8803 made orbit-camera unified-aware.
- Update global-sorting example header from "demonstrates unified
  gsplat rendering" to "demonstrates global gsplat sorting" to reflect
  what the example actually shows.

Remaining "unified" mentions in the engine are all either internal
(private fields, code comments, code branches), runtime warning strings
(which must keep the property name), @ignore'd JSDoc, or directory
names — none render in public docs.
@mvaligursky mvaligursky self-assigned this May 28, 2026
@mvaligursky mvaligursky requested a review from Copilot May 28, 2026 15:46
@mvaligursky mvaligursky merged commit f4b26c0 into main May 28, 2026
8 checks passed
@mvaligursky mvaligursky deleted the mv-gsplat-docs-drop-unified branch May 28, 2026 15:46
mvaligursky added a commit that referenced this pull request May 28, 2026
Follow-up cleanup to the unified-default flip (#8802, #8803, #8804).
Unified rendering is now the default and the unified property is
@deprecated/@ignore, so the public API docs and examples shouldn't be
framed around "unified mode" any more — it's just gsplat rendering.

Engine source:
- GSplatComponent: remove the "## Unified Rendering" section from the
  class JSDoc; strip the JSDoc blocks from material get/set and
  highQualitySH get/set (both are legacy-only and only documented the
  unified/non-unified distinction). Drop "unified" qualifiers from
  workBufferUpdate, workBufferModifier, setParameter, and
  getInstanceTexture JSDocs.
- GSplatComponentSystem: drop "in unified mode" from the
  material:created and frame:ready event JSDocs, and from the
  getMaterial JSDoc.
- GSplatParams: rename "Parameters for GSplat unified system" to
  "Parameters for the GSplat system"; drop "unified" qualifier from
  dataFormat, material, and format JSDocs.
- GSplatContainer: drop "non-unified rendering" from the class example
  comment, drop unified: true from the addComponent example, drop
  "unified" qualifier from the centers JSDoc.

Examples (gaussian-splatting folder):
- Remove unified: true from every addComponent('gsplat', { ... }) call
  (~40 occurrences across 29 files) — it's now the default and the
  property is deprecated.
- Reword/remove comments that mention "unified" framing now that it's
  just the standard path (e.g. "Create hotel gsplat with unified set
  to true" → "Create hotel gsplat").
- Drop three stale orbit-pivot comments ("unified gsplats have no mesh
  AABB for focusEntity framing") — these became factually incorrect
  once #8803 made orbit-camera unified-aware.
- Update global-sorting example header from "demonstrates unified
  gsplat rendering" to "demonstrates global gsplat sorting" to reflect
  what the example actually shows.

Remaining "unified" mentions in the engine are all either internal
(private fields, code comments, code branches), runtime warning strings
(which must keep the property name), @ignore'd JSDoc, or directory
names — none render in public docs.

Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
@mvaligursky mvaligursky removed the request for review from Copilot May 28, 2026 16:08
mvaligursky added a commit to playcanvas/developer-site that referenced this pull request May 29, 2026
Restructures the Gaussian Splatting documentation now that unified splat
rendering is the default (and only) mode, following engine PR
playcanvas/engine#8805 which deprecates the `unified` GSplatComponent
property. Framing the docs around "unified vs non-unified mode" no longer
makes sense. This is a structural first pass; individual page bodies are
cleaned up in follow-ups.

- Moved the former building/unified-rendering/ topics up to the building/
  level and removed the now-empty folder.
- Merged the standalone "Unified Splat Rendering" page into "Splat
  Rendering Architecture", rephrased to present splat rendering as the
  single rendering mode; deleted the old page.
- Added a new top-level Rendering Architecture section holding the
  pipeline-internals topics (overview, Splat Data Format, Work Buffer
  Format, Work Buffer Rendering, Splat Processing).
- Reordered Building Splat Applications into a more logical flow.
- Repointed all internal links and added redirects from original
  published URLs to their new locations.
- Mirrored every change in the Japanese (i18n/ja) docs.

Co-authored-by: Martin Valigursky <mvaligursky@snapchat.com>
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