Repository navigation
Fix JSDoc defaults that disagree with the code - #19126
Open
ZainnQureshii wants to merge 1 commit into
Open
ZainnQureshii wants to merge 1 commit into
ZainnQureshii wants to merge 1 commit into
Conversation
- StandardMaterial, PBRMaterial and OpenPBRMaterial `clone()`: the `cloneTexturesOnlyOnce` parameter defaults to `true`, the doc said "Default false". - SSAORenderingPipeline `radius` is initialised to `0.0001`, the doc said 0.0006. - SlateGizmo `fixedScreenSize` is initialised to `false`, the doc said "Default: true". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
There are no active review issues blocking the JSDoc default documentation updates.
No open issues 🎉
What changed in this PR
This documentation-only PR aligns five JSDoc defaults with existing Babylon.js declarations. Runtime behavior is unchanged.
Changes:
- Corrects
cloneTexturesOnlyOncedocumentation totruefor three material classes. - Corrects the documented SSAO radius to
0.0001. - Corrects the documented slate gizmo
fixedScreenSizedefault tofalse.
| File | Description |
|---|---|
packages/dev/gui/src/3D/gizmos/slateGizmo.ts |
Documents fixedScreenSize as defaulting to false. |
packages/dev/core/src/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline.pure.ts |
Documents the radius default as 0.0001. |
packages/dev/core/src/Materials/standardMaterial.pure.ts |
Documents cloneTexturesOnlyOnce as defaulting to true. |
packages/dev/core/src/Materials/PBR/pbrMaterial.pure.ts |
Documents cloneTexturesOnlyOnce as defaulting to true. |
packages/dev/core/src/Materials/PBR/openpbrMaterial.pure.ts |
Documents cloneTexturesOnlyOnce as defaulting to true. |
Review effort: Balanced
deltakosh
approved these changes
Nov 7, 2026
deltakosh
left a comment
Contributor
There was a problem hiding this comment.
Hello,
Thanks, all five corrections match the code at b497afa:
StandardMaterial.clone,PBRMaterial.cloneandOpenPBRMaterial.clonedeclarecloneTexturesOnlyOnce: boolean = true, so "Default true" is correct.SSAORenderingPipeline.radiusis initialised to0.0001.SlateGizmo.fixedScreenSizeis initialised tofalse.
Comment-only change with no runtime impact. Approving.
Thanks!
Popov72
approved these changes
Nov 7, 2026
Popov72
left a comment
Contributor
There was a problem hiding this comment.
All five JSDoc defaults match their existing declarations and implementation. No actionable findings; this comment-only change leaves runtime behavior unchanged.
deltakosh
enabled auto-merge (squash)
November 7, 2026 09:54
This branch has not been deployed
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.
Five JSDoc comments state a default that the code does not use. Each comment now matches the value in the signature or field initialiser:
StandardMaterial.clone(),PBRMaterial.clone()andOpenPBRMaterial.clone(): thecloneTexturesOnlyOncedoc said "Default false", but the parameter is declaredcloneTexturesOnlyOnce: boolean = true(standardMaterial.pure.ts:1851,pbrMaterial.pure.ts:704,openpbrMaterial.pure.ts:2199). Changed to "Default true".SSAORenderingPipeline.radius: the doc said "Default value is 0.0006", but the field ispublic radius: number = 0.0001;(ssaoRenderingPipeline.pure.ts:63). Changed to 0.0001.SlateGizmo.fixedScreenSize: the doc said "(Default: true)", but the field ispublic fixedScreenSize = false;(slateGizmo.ts:56), andHolographicSlatecreates the gizmo without setting it. Changed to "(Default: false)".Comment-only change: no runtime behaviour changes. I did not run the build or tests, since only comment text changed; the values were checked by reading each declaration above.
Prepared with AI assistance (Claude Code) and reviewed with GitHub Copilot.
🤖 Generated with Claude Code