Improve documentation for Material.needsUpdate #1

anischelly26 · 2025-03-22T21:16:38Z

Description

Improved the explanation of the .needsUpdate property in the Material documentation file.
Added detailed information and an example to help developers understand when and why to set it to true.

This clarification will be useful for beginners and contributors who often miss this small but important step.

* ShadowMaskModel: Fix signatures. * ShadowMaskModel: Use `mulAssign()`. * ShadowNodeMaterial: Fix transparent.

Add `@deprecated` tag.

This reverts commit 3955b05.

#30768) * add `computeSkinning` and remove `skinningReference` * Node: Show warning for recursive code generate * fix `attributeName` undefined * add compute() support for NodeMaterial * update example using `computeSkinning` * cleanup

* fix `equal()` inconsistent * cleanup

* Docs: fix typos * Docs: fix typo * revert changes * revert change

…30780) * Allow max()/min() to take an arbitrary number of arguments * update docs

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* auto-rename * Update NodeBuilder.js * Update NodeBuilder.js

* improve warnings * cleanup

* deprecated `modInt()` * improve warnings * updates * revision * fix declarations * revision * Update ComputeNode.js

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

* Editor: Add color space options for background textures. * Editor: Improve color space select.

* introduce `debug()` * cleanup * add debug

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

* Automatically clean shape data passed to ExtrudeGeometry Before triangulating a shape, ExtrudeGeometry now welds any index-adjacent points within a small hardcoded distance threshold of each other. This resolves common triangulation artifacts caused by improperly formatted shape data. * Code review tweaks * Update screenshots --------- Co-authored-by: Garrett Johnson <garrett.kjohnson@gmail.com>

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

…of floating point depth. (#30941)

* fix `build()` return value * add `webgpu_postprocessing_fxaa` unknown problem * update description

… set (#30877) * ShadowNode: Inherit camera.layers only if shadow.layers is not set * Fix layers check * invert condition * restore after render * move array creation to module scope

* TSL: Add switch/case. * StackNode: Support Case() sequence. * StackNode: Refactor `Case()`.

* add expression support for `loop()` update * Raymarching: update with new approach * TSLEncoder: update with new approach * rev * rev

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

* LightsNode: Honor spotlight maps in cache key. * LightsNode: Make spot light hash more robust.

docs/index.html

+
+					// Redirect to the manual
+
+					window.location.href = hash.replace(/^manual\/([^\/]+)\/([^\/]+)\/(.+)$/, '../manual/#$1/$3').toLowerCase();


docs/index.html

+
+					// Redirect to the manual
+
+					window.location.href = hash.replace(/^manual\/([^\/]+)\/([^\/]+)\/(.+)$/, '../manual/#$1/$3').toLowerCase();


docs/index.html

+			const docType = hash.slice( 0, hash.indexOf( '/' ) + 1 );
+			let docLink = hash.slice( hash.indexOf( '/' ) + 1 );
+			docLink = docLink.slice( docLink.indexOf( '/' ) );
+			location.href = docType + language + docLink;


docs/index.html

+			if ( search ) {
+
+				const link = sectionLink.href.split( /[?#]/ )[ 0 ];
+				sectionLink.href = `${link}?q=${search}`;


docs/index.html

+
+				};
+
+				iframe.src = splitHash[ 0 ] + '.html' + splitHash[ 1 ];


docs/index.html

+
+				};
+
+				iframe.src = splitHash[ 0 ] + '.html' + splitHash[ 1 ];


* add `Stack()` * rev * rev

* BatchedMesh: fix copy function * BatchedMesh: Update toJSON function * BatchedMesh.toJSON: small cleanup * ObjectLoader: Fix BatchedMesh support * BatchedMesh.copy: Remove redundant field * Object3D, ObjectLoader: adjust serialized definitions * ObjectLoader: Copy over necessary info

* Rename `renderer.nodes` -> ``renderer.overrideNodes` * Add `renderer.highPrecision`

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* `material.shadowPositionNode` renamed to `material.receivedShadowPositionNode` * add `shadow.mapType` * add `material.castShadowPositionNode` * add `webgpu_caustics` example * update title * add stats * use webgpu * add `webgpu_volumetric_caustics` example * updates * Update puppeteer.js * Update puppeteer.js * Update webgpu_volume_caustics.html * fix shadow-map alpha * add glass example * Update webgpu_shadowmap_opacity.jpg * Update webgpu_volume_caustics.html

* add `parents` properties * TSL: Fixes the return value of `atomic*` nodes

* auto-cache * Update AtomicFunctionNode.js

* fix vertex-color * Update AttributeNode.js * Update NodeMaterial.js

* remove layout * rename

…ion signature (#30976) * improve debug callback * Update DebugNode.js * Update DebugNode.js * Update DebugNode.js * Update DebugNode.js

* removed example because puppeteer always make black screenshot * Revert "removed example because puppeteer always make black screenshot" This reverts commit 3376eb8. * Update WGSLNodeBuilder.js --------- Co-authored-by: Attila Schroeder <attila-schroeder.79@gmail.com> Co-authored-by: sunag <sunagbrasil@gmail.com>

…30977)

Mugen87 and others added 30 commits March 20, 2025 19:38

ShadowMaskModel: Fix signatures. (#30764)

6b28459

* ShadowMaskModel: Fix signatures. * ShadowMaskModel: Use `mulAssign()`. * ShadowNodeMaterial: Fix transparent.

Add missing getPointShadow() argument in CSM Shader (#30771)

bf4e6fc

Editor: Renamed ModelViewer to Room.

a6bbc0e

Controls: Require element in connect() (#30772)

db72336

Updated builds.

d9fd766

Update Controls.js

8ac8375

Add `@deprecated` tag.

Revert "Remove old docs. (#30748)" (#30773)

03cedd8

This reverts commit 3955b05.

Update webgpu_skinning_points description

4f03f16

TSL: Fix equal() inconsistent (#30777)

51856a6

* fix `equal()` inconsistent * cleanup

Docs: fix typos (#30776)

92eae7d

* Docs: fix typos * Docs: fix typo * revert changes * revert change

TSL: Allow max()/min() to take an arbitrary number of arguments (#…

beda0bb

…30780) * Allow max()/min() to take an arbitrary number of arguments * update docs

Update actions/setup-node digest to cdca736 (#30781)

bc2d27f

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Update actions/upload-artifact digest to ea165f8 (#30782)

a5ec0a6

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Editor: Updated string.js for zh (#30787)

1095272

TSL: Avoid name collision (#30785)

558068d

* auto-rename * Update NodeBuilder.js * Update NodeBuilder.js

TSL: Improve warnings (#30783)

b0805c2

* improve warnings * cleanup

TSL: Deprecated modInt() and minor fixes (#30790)

20b9cbb

* deprecated `modInt()` * improve warnings * updates * revision * fix declarations * revision * Update ComputeNode.js

Pass: improve types (#30789)

9563913

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

Examples: avoid relying on implicit event parameter (#30792)

5c5a685

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

Docs: Clean up. (#30793)

84adf2a

TSL: Fix mod() negative values (#30796)

1ff2268

Docs: fix types (#30791)

b36d77d

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

Editor: Add color space options for background textures. (#30794)

35b0fbc

* Editor: Add color space options for background textures. * Editor: Improve color space select.

TSL: Add debug() (#30797)

30c4024

* introduce `debug()` * cleanup * add debug

LDrawLoader: fix error message (#30801)

8adc1d2

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

WebGPURenderer: Revisions for release (#30803)

89680a5

Examples: fix minor errors (#30798)

f3f3ed3

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

LWOLoader: fix method calls (#30802)

afe4adb

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

Mugen87 and others added 11 commits April 16, 2025 10:36

LottieLoader: Deprecated loader, inline library usage. (#30896)

63b614c

webgl_reverse_depth_buffer: Use post-processing and add note for use …

09826c0

…of floating point depth. (#30941)

TSL: Fix debug() changes the compiled code (#30944)

bc7aedd

* fix `build()` return value * add `webgpu_postprocessing_fxaa` unknown problem * update description

ShadowNode: Inherit camera.layers only if shadow.camera.layers is not…

f35e494

… set (#30877) * ShadowNode: Inherit camera.layers only if shadow.layers is not set * Fix layers check * invert condition * restore after render * move array creation to module scope

TSL: Add switch/case. (#30935)

ec16a14

* TSL: Add switch/case. * StackNode: Support Case() sequence. * StackNode: Refactor `Case()`.

TSL: Add expression support for loop( { update: ... } ) (#30947)

b2e0b0c

* add expression support for `loop()` update * Raymarching: update with new approach * TSLEncoder: update with new approach * rev * rev

Fix using with BatchedMesh (#30952)

55e9cc2

IFFParser: Fix missing Debbuger attribute declarations (#30946)

5b83e73

Co-authored-by: Samuel Rigaud <rigaud@gmail.com>

LightsNode: Honor spotlight maps in cache key. (#30940)

4d368fa

* LightsNode: Honor spotlight maps in cache key. * LightsNode: Make spot light hash more robust.

Updated builds.

92e6962

LineSegments2: Fix typo. (#30953)

74e6eed

github-advanced-security bot found potential problems Apr 18, 2025

View reviewed changes

sunag and others added 17 commits April 19, 2025 01:04

TSL: Add Stack() and .toStack() (#30956)

b730a20

* add `Stack()` * rev * rev

TSL: Cache getShadowRenderObjectFunction() (#30969)

fe9a57c

WebGPURenderer: Introduce renderer.highPrecision (#30970)

f1a2795

* Rename `renderer.nodes` -> ``renderer.overrideNodes` * Add `renderer.highPrecision`

Update actions/setup-node digest to 49933ea (#30968)

32a8faf

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

PointerLockControls: sensitivity const (#30966)

0ff094e

TSL: Fixes the return value of atomic* nodes (#30971)

3bdd438

* add `parents` properties * TSL: Fixes the return value of `atomic*` nodes

TSL: Auto-cache atomic* nodes (#30972)

6a74721

* auto-cache * Update AtomicFunctionNode.js

NodeMaterial: Fix alpha of vertex-color (#30974)

d79728c

* fix vertex-color * Update AttributeNode.js * Update NodeMaterial.js

TSL: Fix denoise() sampler texture (#30975)

bfb46e5

* remove layout * rename

TSL: Improve debug() callback changing to ( builder, code ) funct…

9147649

…ion signature (#30976) * improve debug callback * Update DebugNode.js * Update DebugNode.js * Update DebugNode.js * Update DebugNode.js

fix: change increment to decrement in documentation (#30978)

0c69d14

Examples: Call ImageBitmap.close() in webgl_loader_imagebitmap. (#…

688fdaf

…30977)

Updated builds.

98a7c92

webgpu_sandbox: fix commented line

7fe67ee

anischelly26 merged commit 248189e into anischelly26:dev Apr 22, 2025
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve documentation for Material.needsUpdate #1

Improve documentation for Material.needsUpdate #1

Uh oh!

anischelly26 commented Mar 22, 2025

Uh oh!

Check failure

Check warning

Check warning

Check warning

Check failure

Check warning

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants


		// Redirect to the manual

		window.location.href = hash.replace(/^manual\/([^\/]+)\/([^\/]+)\/(.+)$/, '../manual/#$1/$3').toLowerCase();

Improve documentation for Material.needsUpdate #1

Improve documentation for Material.needsUpdate #1

Uh oh!

Conversation

anischelly26 commented Mar 22, 2025

Uh oh!

Check failure

Uh oh!

Check warning

Uh oh!

Check warning

Uh oh!

Check warning

Uh oh!

Check failure

Uh oh!

Check warning

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

20 participants